DocumentaciónExperience PlatformGuía de destinos

Actualización de una plantilla de audiencia

Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Admin
  • User
IMPORTANT
Extremo de API: platform.adobe.io/data/core/activation/authoring/audience-templates

Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para actualizar una plantilla de audiencia utilizando /authoring/audience-templates Extremo de API.

Para obtener una descripción detallada de las funciones que puede configurar a través de este extremo, consulte gestión de metadatos de audiencia.

IMPORTANT
Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.

Introducción a las operaciones de API de plantillas de audiencia get-started

Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.

Actualización de una plantilla de audiencia create

Puede actualizar un existente plantilla de audiencia creando un PUT solicitud a la /authoring/audience-templates punto final con la carga útil actualizada.

Para obtener una plantilla de audiencia existente y su correspondiente {INSTANCE_ID}, consulte el artículo sobre recuperación de una plantilla de audiencia.

Formato de API

PUT /authoring/audience-templates/{INSTANCE_ID}
Parámetro
Descripción
{INSTANCE_ID}
El ID de la plantilla de audiencia que desea actualizar. Para obtener una plantilla de audiencia existente y su correspondiente {INSTANCE_ID}, consulte Recuperación de una plantilla de audiencia.

La siguiente solicitud actualiza una plantilla de metadatos de audiencia existente, configurada por los parámetros proporcionados en la carga útil.

Solicitud
code language-shell 
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "metadataTemplate":{
      "create":{
         "url":"https://api.moviestar.com/v1.0/{{customerData.accountId}}/customaudiences?fields=name,description,account_id&subtype=CUSTOM&name={{segment.name}}&customer_file_source={{segment.metadata.customer_file_source}}&access_token={{authData.accessToken}}",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "update":{
         "url":"https://api.moviestar.com/v1.0/{{segment.alias}}?field=name,description,account_id&access_token={{authData.accessToken}}&customerAudienceId={{segment.alias}}&&name={{segment.name}}&description={{segment.description}}&customer_file_source={{segment.metadata.customer_file_source}}",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "delete":{
         "url":"https://api.moviestar.com/v1.0/{{segment.alias}}?fields=name,description,account_id&access_token={{authData.accessToken}}&customerAudienceId={{segment.alias}}",
         "httpMethod":"DELETE",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "validate":{
         "url":"https://api.moviestar.com/v1.0/permissions?access_token={{authData.accessToken}}",
         "httpMethod":"GET",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.data[0].permission}}",
               "name":"Id"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      }
   }
}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la plantilla de audiencia actualizada.

Administración de errores de API

Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.

Pasos siguientes

Después de leer este documento, sabe cuándo usar plantillas de audiencia y cómo actualizar una plantilla de audiencia mediante /authoring/audience-templates Extremo de API. Leer cómo utilizar Destination SDK para configurar el destino para comprender dónde encaja este paso en el proceso de configuración del destino.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6