Usar o Destination SDK para configurar um destino de transmissão

Visão geral

Esta página descreve como usar as informações em Opções de configuração no SDK de destinos e em outros documentos de referência da API e funcionalidade do Destination SDK para configurar um destino de transmissão. As etapas são apresentadas na ordem sequencial abaixo.

OBSERVAÇÃO

No momento, não há suporte para configurar um destino em lote por meio do Destination SDK.

Pré-requisitos

Antes de avançar para as etapas ilustradas abaixo, leia o Introdução ao Destination SDK para obter informações sobre como obter as credenciais de autenticação do Adobe I/O e outros pré-requisitos necessários para funcionar com as APIs do Destination SDK.

Etapas para usar as opções de configuração no Destination SDK para configurar o destino

Etapas ilustradas do uso de pontos de extremidade do Destination SDK

Etapa 1: Criar um servidor e uma configuração de modelo

Comece criando uma configuração de servidor e modelo usando o /destinations-server endpoint (lido) Referência da API). Para obter mais informações sobre o servidor e a configuração do modelo, consulte Especificações do servidor e do modelo na seção de referência.

Veja abaixo um exemplo de configuração. Observe que o modelo de transformação de mensagem no requestBody.value é abordado na etapa 3, Criar modelo de transformação.

POST platform.adobe.io/data/core/activation/authoring/destination-servers

{
   "name":"Moviestar destination server",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"https://api.moviestar.com/data/{{customerData.region}}/items"
      }
   },
   "httpTemplate":{
      "httpMethod":"POST",
      "requestBody":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"insert after you create a template in step 3"
      },
      "contentType":"application/json"
   }
}

Etapa 2: Criar configuração de destino

Veja abaixo um exemplo de configuração para um modelo de destino, criado usando o /destinations Ponto de extremidade da API. Para obter mais informações sobre esse template, consulte Configuração de destino.

Para conectar o servidor e a configuração do modelo na etapa 1 a essa configuração de destino, adicione a ID da instância da configuração do servidor e do modelo como destinationServerId aqui.

IMPORTANTE

Para criar um destino configurado corretamente, must adicionar pelo menos uma identidade de destino em identityNamespaces, conforme mostrado abaixo. Se nenhuma identidade de destino estiver configurada, os usuários não poderão continuar após a Etapa de mapeamento do fluxo de trabalho de ativação.

POST platform.adobe.io/data/core/activation/authoring/destinations
 
{
   "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":""
      }
   ],
   "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
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },   
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "aggregationPolicyId":null,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":true,
            "groups":null
         },
         "splitUserById":true,
         "maxBatchAgeInSecs":360,
         "maxNumEventsInBatch":100
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ]
}

Etapa 3: Criar modelo de transformação de mensagem - use a linguagem de modelo para especificar o formato de saída da mensagem

Com base nas cargas que seu destino suporta, você deve criar um modelo que transforma o formato dos dados exportados do formato Adobe XDM em um formato compatível com seu destino. Consulte exemplos de modelo na seção Uso de uma linguagem de modelo para as transformações de identidade, atributos e associação de segmento e use o ferramenta de criação de modelo fornecido pelo Adobe.

Depois de criar um template de transformação de mensagem que funcione para você, adicione-o à configuração de servidor e modelo criada na etapa 1.

Etapa 4: Criar configuração de metadados de público-alvo

Para alguns destinos, o Destination SDK exige que você configure uma configuração de metadados de público-alvo para criar, atualizar ou excluir públicos-alvo de forma programática no seu destino. Consulte Gerenciamento de metadados do público-alvo para obter informações sobre quando você precisa configurar essa configuração e como fazer isso.

Se você usar uma configuração de metadados de público-alvo, é necessário conectá-los à configuração de destino criada na etapa 2. Adicione a ID da instância da configuração de metadados do público-alvo à configuração de destino como audienceTemplateId.

Etapa 5: Criar configuração de credenciais / Configurar autenticação

Dependendo de você especificar "authenticationRule": "CUSTOMER_AUTHENTICATION" ou "authenticationRule": "PLATFORM_AUTHENTICATION" na configuração de destino acima, você pode configurar a autenticação para seu destino usando o /destination ou /credentials endpoint .

  • Caso mais comum: Se você selecionou "authenticationRule": "CUSTOMER_AUTHENTICATION" na configuração de destino e seu destino oferece suporte ao método de autenticação OAuth 2, leia Autenticação OAuth 2.
  • Se você selecionou "authenticationRule": "PLATFORM_AUTHENTICATION", consulte o Configuração de autenticação.

Etapa 6: Teste seu destino

Depois de configurar seu destino usando os endpoints de configuração nas etapas anteriores, você pode usar a variável ferramenta de teste de destino para testar a integração entre o Adobe Experience Platform e seu destino.

Como parte do processo para testar seu destino, você deve usar a interface do usuário do Experience Platform para criar segmentos, que você ativará no seu destino. Consulte os dois recursos abaixo para obter instruções sobre como criar segmentos no Experience Platform:

Etapa 7: Publicar o destino

Após configurar e testar seu destino, use o API de publicação de destino para enviar sua configuração ao Adobe para revisão.

Etapa 8: Documente seu destino

Se você for um Fornecedor Independente de Software (ISV) ou um Integrador de Sistema (SI) criando um integração produzida, use o processo de documentação de autoatendimento para criar uma página de documentação do produto para seu destino no Catálogo de destinos Experience Platform.

Nesta página