DocumentaçãoExperience PlatformGuia de destinos

Atualizar um modelo de público

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined
IMPORTANT
Ponto de extremidade de API: platform.adobe.io/data/core/activation/authoring/audience-templates

Esta página exemplifica a solicitação de API e a carga que você pode usar para atualizar um modelo de público-alvo, usando o ponto de extremidade de API /authoring/audience-templates.

Para obter uma descrição detalhada dos recursos que você pode configurar por meio deste ponto de extremidade, consulte gerenciamento de metadados de público-alvo.

IMPORTANT
Todos os nomes e valores de parâmetros suportados pelo Destination SDK fazem distinção entre maiúsculas e minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.

Introdução às operações de API do modelo de público-alvo get-started

Antes de continuar, consulte o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo como obter a permissão de criação de destino e os cabeçalhos necessários.

Atualizar um modelo de público create

Você pode atualizar um modelo de público-alvo existente fazendo uma solicitação PUT para o ponto de extremidade /authoring/audience-templates com a carga atualizada.

Para obter um modelo de público-alvo existente e seu {INSTANCE_ID} correspondente, consulte o artigo sobre recuperação de um modelo de público-alvo.

Formato da API

PUT /authoring/audience-templates/{INSTANCE_ID}
Parâmetro
Descrição
{INSTANCE_ID}
A ID do modelo de público-alvo que você deseja atualizar. Para obter um modelo de público-alvo existente e seu {INSTANCE_ID} correspondente, consulte Recuperar um modelo de público-alvo.

A solicitação a seguir atualiza um modelo existente de metadados de público-alvo, configurado pelos parâmetros fornecidos na carga.

Solicitação
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"
            }
         ]
      }
   }
}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes do seu modelo de público-alvo atualizado.

Manipulação de erros de API

Os endpoints da API Destination SDK seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform.

Próximas etapas

Depois de ler este documento, agora você sabe quando usar modelos de público-alvo e como atualizar um modelo de público-alvo usando o ponto de extremidade da API /authoring/audience-templates. Leia como usar o Destination SDK para configurar seu destino para entender onde esta etapa se encaixa no processo de configuração do seu destino.

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