Configuração de destino

Visão geral

Essa configuração permite indicar informações essenciais, como nome de destino, categoria, descrição e muito mais. As configurações nessa configuração também determinam como os usuários do Experience Platform se autenticam para o seu destino, como ele aparece na interface do usuário do Experience Platform e as identidades que podem ser exportadas para o seu destino.

Essa configuração também conecta as outras configurações necessárias para que o destino funcione - servidor de destino e metadados de público-alvo - a essa configuração. Leia como você pode fazer referência às duas configurações em uma seção mais abaixo.

Você pode configurar a funcionalidade descrita neste documento usando o /authoring/destinations Ponto de extremidade da API. Ler Operações de endpoint da API de destinos para obter uma lista completa de operações que podem ser realizadas no ponto de extremidade.

Exemplo de configuração

Abaixo está um exemplo de configuração de um destino ficcional, Moviestar, que tem endpoints em quatro locais no mundo. O destino pertence à categoria destinos móveis . As seções a seguir detalham como essa configuração é construída.

{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
               
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "schemaConfig":{
      "profileRequired":false,
      "segmentRequired":true,
      "identityRequired":true
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "splitUserById":true,
         "maxBatchAgeInSecs":0,
         "maxNumEventsInBatch":0,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":false,
            "groups":[
               {
                  "namespaces":[
                     "IDFA",
                     "GAID"
                  ]
               },
               {
                  "namespaces":[
                     "EMAIL"
                  ]
               }
            ]
         }
      }
   },
   "backfillHistoricalProfileData":true
}
Parâmetro Tipo Descrição
name String Indica o título do destino no catálogo de Experience Platform.
description String Forneça uma descrição para o cartão de destino no catálogo de destinos do Experience Platform. Mire por não mais do que 4 a 5 frases.
status String Indica o status do ciclo de vida do cartão de destino. Os valores aceitos são TEST, PUBLISHED e DELETED. Use TEST ao configurar o destino pela primeira vez.

Configurações de autenticação do cliente

Essa seção na configuração de destinos gera a variável Configurar novo destino na interface do usuário do Experience Platform, onde os usuários conectam o Experience Platform às contas que têm com seu destino. Dependendo da opção de autenticação que você indicar na authType , a Experience Platform é gerada para os usuários da seguinte maneira:

Autenticação do portador

Ao configurar o tipo de autenticação do portador, os usuários são solicitados a inserir o token do portador que obtêm do seu destino.

Renderização da interface do usuário com autenticação do portador

Autenticação OAuth 2

Usuários selecionados Ligar ao destino para acionar o fluxo de autenticação do OAuth 2 para o seu destino, como mostrado no exemplo abaixo para o destino de Públicos personalizados do Twitter. Para obter informações detalhadas sobre como configurar a autenticação OAuth 2 para o terminal de destino, leia o Página de autenticação OAuth 2 do SDK de destino.

Renderização da interface do usuário com autenticação OAuth 2

Parâmetro Tipo Descrição
customerAuthenticationConfigurations String Indica a configuração usada para autenticar clientes do Experience Platform para o servidor. Consulte authType abaixo para valores aceitos.
authType String Os valores aceitos são OAUTH2, BEARER.

Campos de dados do cliente

Esta seção permite que os parceiros introduzam campos personalizados. Na configuração de exemplo acima, customerDataFields O exige que os usuários selecionem um terminal no fluxo de autenticação e indiquem a ID do cliente com o destino. A configuração é refletida no fluxo de autenticação, como mostrado abaixo:

Fluxo de autenticação de campo personalizado

Parâmetro Tipo Descrição
name String Forneça um nome para o campo personalizado que está sendo introduzido.
type String Indica o tipo de campo personalizado que está sendo introduzido. Os valores aceitos são string, object, integer.
title String Indica o nome do campo, como é visto pelos clientes na interface do usuário do Experience Platform.
description String Forneça uma descrição para o campo personalizado.
isRequired Booleano Indica se esse campo é necessário no fluxo de trabalho de configuração de destino.
enum String Renderiza o campo personalizado como um menu suspenso e lista as opções disponíveis para o usuário.
pattern String Impõe um padrão para o campo personalizado, se necessário. Use expressões regulares para impor um padrão. Por exemplo, se as IDs do cliente não incluírem números ou sublinhados, insira ^[A-Za-z]+$ neste campo.

Atributos da interface do usuário

Esta seção se refere aos elementos da interface do usuário na configuração acima que o Adobe deve usar para seu destino na interface do usuário do Adobe Experience Platform. Consulte abaixo:

Parâmetro Tipo Descrição
documentationLink String Refere-se à página de documentação na Catálogo de destinos para o seu destino. Use http://www.adobe.com/go/destinations-YOURDESTINATION-en, onde YOURDESTINATION é o nome do seu destino. Para um destino chamado Moviestar, você usaria http://www.adobe.com/go/destinations-moviestar-en
category String Refere-se à categoria atribuída ao seu destino no Adobe Experience Platform. Para obter mais informações, leia Categorias de Destino. Use um dos seguintes valores: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.
connectionType String Server-to-server no momento, é a única opção disponível.
frequency String Streaming no momento, é a única opção disponível.

Configuração de esquema na etapa de mapeamento

Ativar etapa de mapeamento

Use os parâmetros em schemaConfig para habilitar a etapa de mapeamento do workflow de ativação de destino. Ao usar os parâmetros descritos abaixo, você pode determinar se os usuários do Experience Platform podem mapear atributos e/ou identidades de perfil para o esquema desejado no lado do destino.

Parâmetro Tipo Descrição
profileFields Matriz Não mostrado no exemplo de configuração acima. Ao adicionar predefinido profileFields, os usuários do Experience Platform têm a opção de mapear atributos da plataforma para os atributos predefinidos no lado do destino.
profileRequired Booleano Use true se os usuários forem capazes de mapear atributos de perfil do Experience Platform para atributos personalizados no lado do seu destino, como mostrado na configuração de exemplo acima.
segmentRequired Booleano Sempre use segmentRequired:true.
identityRequired Booleano Use true se os usuários forem capazes de mapear os namespaces de identidade do Experience Platform para o esquema desejado.

Identidades e atributos

Os parâmetros desta seção determinam quais identidades seu destino aceita. Essa configuração também preenche as identidades e os atributos de direcionamento no etapa de mapeamento da interface do usuário do Experience Platform, onde os usuários mapeiam identidades e atributos de seus esquemas XDM para o esquema no seu destino.

Você deve indicar qual Platform identidades que os clientes podem exportar para o seu destino. Alguns exemplos são Experience Cloud ID, email com hash, ID do dispositivo (IDFA, GAID). Esses valores são Platform namespaces de identidade que os clientes podem mapear para namespaces de identidade a partir do seu destino. Você também pode indicar se os clientes podem mapear namespaces personalizados para identidades suportadas pelo seu destino.

Os namespaces de identidade não exigem uma correspondência de 1 para 1 entre Platform e seu destino.
Por exemplo, os clientes podem mapear uma Platform IDFA namespace para um IDFA namespace do seu destino ou podem mapear o mesmo Platform IDFA namespace para um Customer ID namespace no seu destino.

Leia mais na Visão geral do Namespace de identidade.

Renderizar identidades de direcionamento na interface do usuário

Parâmetro Tipo Descrição
acceptsAttributes Booleano Indica se o destino aceita atributos de perfil padrão. Normalmente, esses atributos são destacados na documentação dos parceiros.
acceptsCustomNamespaces Booleano Indica se os clientes podem configurar namespaces personalizados no seu destino.
allowedAttributesTransformation String Não mostrado na configuração de exemplo. Usado, por exemplo, quando a variável Platform o cliente tem endereços de email simples como um atributo e sua plataforma aceita apenas emails com hash. Nesse objeto, é possível aplicar a transformação que precisa ser aplicada (por exemplo, transformar o email em minúsculas e, em seguida, em hash). Para ver um exemplo, consulte requiredTransformation no referência da API de configuração de destino.
acceptedGlobalNamespaces - Usado para casos em que a plataforma aceita namespaces de identidade padrão (por exemplo, IDFA), para que seja possível restringir usuários da plataforma a selecionar somente esses namespaces de identidade.

Delivery de destino

Parâmetro Tipo Descrição
authenticationRule String Indica como Platform Os clientes do se conectam ao seu destino. Os valores aceitos são CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Use CUSTOMER_AUTHENTICATION se os clientes da Platform fizerem logon em seu sistema por meio de um nome de usuário e senha, um token portador ou outro método de autenticação. Por exemplo, você selecionaria essa opção se também selecionasse authType: OAUTH2 ou authType:BEARER em customerAuthenticationConfigurations.
  • Use PLATFORM_AUTHENTICATION se houver um sistema de autenticação global entre o Adobe e seu destino e o Platform o cliente não precisa fornecer credenciais de autenticação para se conectar ao seu destino. Nesse caso, você deve criar um objeto de credenciais usando o Credenciais configuração.
  • Use NONE se nenhuma autenticação for necessária para enviar dados para a plataforma de destino.
destinationServerId String O instanceId do configuração do servidor de destino usado para este destino.

Configuração do mapeamento de segmento

Seção de configuração do mapeamento de segmentos

Esta seção da configuração de destino está relacionada a como os metadados do segmento, como nomes de segmento ou IDs, devem ser compartilhados entre o Experience Platform e seu destino.

Por meio da audienceTemplateId, esta seção também vincula essa configuração ao configuração de metadados do público-alvo.

Os parâmetros mostrados na configuração acima são descritos na seção referência da API do endpoint de destinos.

Política de agregação

Política de agregação no template de configuração

Esta seção permite definir as políticas de agregação que o Experience Platform deve usar ao exportar dados para seu destino.

Uma política de agregação determina como os perfis exportados são combinados nas exportações de dados. As opções disponíveis são:

  • Melhor agregação de esforço
  • Agregação configurável (mostrada na configuração acima)

Leia a seção em uso de modelos e exemplos de chaves de agregação para entender como incluir a política de agregação em seu template de transformação de mensagem com base em sua política de agregação selecionada.

Melhor agregação de esforço

DICA

Use essa opção se o terminal da API aceitar menos de 100 perfis por chamada de API.

Essa opção funciona melhor para destinos que preferem menos perfis por solicitação e preferem receber mais solicitações com menos dados do que menos solicitações com mais dados.

Use o maxUsersPerRequest para especificar o número máximo de perfis que seu destino pode receber em uma solicitação.

Agregação configurável

Essa opção funciona melhor se você preferir obter grandes lotes, com milhares de perfis na mesma chamada. Essa opção também permite agregar os perfis exportados com base em regras de agregação complexas.

Essa opção permite:

  • Defina o tempo máximo e o número máximo de perfis a serem agregados antes que uma chamada de API seja feita no seu destino.
  • Agregue os perfis exportados mapeados para o destino com base em:
    • ID do segmento;
    • Status do segmento;
    • Identidade ou grupos de identidades.

Para obter explicações detalhadas dos parâmetros de agregação, consulte Operações de endpoint da API de destinos página de referência, onde cada parâmetro é descrito.

Qualificações de perfil histórico

Você pode usar o backfillHistoricalProfileData na configuração de destinos para determinar se as qualificações de perfil histórico devem ser exportadas para o seu destino.

Parâmetro Tipo Descrição
backfillHistoricalProfileData Booleano Controla se os dados históricos do perfil são exportados quando os segmentos são ativados para o destino.
  • true: Platform envia os perfis de usuário históricos que se qualificaram para o segmento antes que ele seja ativado.
  • false: Platform inclui somente perfis de usuário qualificados para o segmento após ele ser ativado.

Como essa configuração conecta todas as informações necessárias ao seu destino

Algumas de suas configurações de destino devem ser configuradas por meio do servidor de destino ou configuração de metadados do público-alvo. A configuração de destino descrita aqui conecta todas essas configurações fazendo referência às duas outras configurações da seguinte maneira:

  • Use o destinationServerId para fazer referência ao servidor de destino e à configuração do modelo configurada para o seu destino.
  • Use o audienceMetadataId para fazer referência à configuração de metadados do público-alvo configurada para o seu destino.

Nesta página