Criar uma configuração de destino
Esta página exemplifica a solicitação de API e a carga que você pode usar para criar sua própria configuração de destino usando o /authoring/destinations
Endpoint da API.
Para obter uma descrição detalhada dos recursos que você pode configurar por meio desse endpoint, leia os seguintes artigos:
- Configuração de autenticação do cliente
- Autorização OAuth2
- Campos de dados do cliente
- Atributos da interface
- Configuração do esquema
- Configuração do namespace de identidade
- Entrega de destino
- Configuração de metadados de público
- Configuração de metadados de público
- Política de agregação
- Configuração em lote
- Qualificações do perfil histórico
Introdução às operações de API de configuração de destino get-started
Antes de continuar, reveja 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.
Criar uma configuração de destino create
Você pode criar uma nova configuração de destino fazendo uma solicitação POST para o /authoring/destinations
terminal.
platform.adobe.io/data/core/activation/authoring/destinations
Formato da API
POST /authoring/destinations
A solicitação a seguir cria um novo Amazon S3 configuração de destino, configurada pelos parâmetros fornecidos na carga. A carga abaixo inclui todos os parâmetros para destinos baseados em arquivo aceitos pelo /authoring/destinations
terminal.
Observe que não é necessário adicionar todos os parâmetros à chamada de API e que a carga é personalizável, de acordo com os requisitos da API.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto | ||||
---|---|---|---|---|
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 que o Adobe usará no catálogo de destinos de Experience Platform para o cartão de destino. Mire não mais do que 4-5 frases.+-----------------------------------------------------------------------------------------+ | img-md |
|
||
status |
String | Indica o status do ciclo de vida do cartão de destino. Os valores aceitos são TEST , PUBLISHED , e DELETED . Uso TEST ao configurar seu destino pela primeira vez. |
||
customerAuthenticationConfigurations.authType |
String | Indica a configuração usada para autenticar clientes do Experience Platform no servidor de destino. Consulte configuração de autenticação do cliente para obter informações detalhadas sobre os tipos de autenticação compatíveis. | ||
customerDataFields.name |
String |
Forneça um nome para o campo personalizado que você está introduzindo.
|
||
customerDataFields.type |
String | Indica o tipo de campo personalizado que você está introduzindo. Os valores aceitos são string , object , integer .Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. |
||
customerDataFields.title |
String | Indica o nome do campo, como visto pelos clientes na interface do usuário do Experience Platform. Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. |
||
customerDataFields.description |
String | Forneça uma descrição para o campo personalizado. Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. | ||
customerDataFields.isRequired |
Booleano | Indica se esse campo é necessário no fluxo de trabalho de configuração de destino. Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. |
||
customerDataFields.enum |
String | Renderiza o campo personalizado como um menu suspenso e lista as opções disponíveis para o usuário. Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. |
||
customerDataFields.default |
String | Define o valor padrão a partir de um enum lista. |
||
customerDataFields.pattern |
String | Impõe um padrão para o campo personalizado, se necessário. Use expressões regulares para aplicar um padrão. Por exemplo, se as IDs do cliente não incluírem números ou sublinhados, insira ^[A-Za-z]+$ neste campo.Consulte Campos de dados do cliente para obter informações detalhadas sobre essas configurações. |
||
uiAttributes.documentationLink |
String |
Refere-se à página da documentação no Catálogo de destinos para o seu destino. Uso
|
||
uiAttributes.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 .Consulte Atributos da interface para obter informações detalhadas sobre essas configurações. |
||
uiAttributes.connectionType |
String |
O tipo de conexão, dependendo do destino. Valores compatíveis:
|
||
uiAttributes.frequency |
String | Refere-se ao tipo de exportação de dados compatível com o destino. Defina como Streaming para integrações baseadas em API, ou Batch ao exportar arquivos para seus destinos. |
||
identityNamespaces.externalId.acceptsAttributes |
Booleano | Indica se os clientes podem mapear atributos de perfil padrão para a identidade que você está configurando. | ||
identityNamespaces.externalId.acceptsCustomNamespaces |
Booleano | Indica se os clientes podem mapear identidades pertencentes a namespaces personalizados à identidade que você está configurando. | ||
identityNamespaces.externalId.transformation |
String | Não mostrado no exemplo de configuração. 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. É aqui que você forneceria a transformação que precisa ser aplicada (por exemplo, transformar o email em minúsculas e depois em hash). | ||
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | Indica qual namespaces de identidade padrão (por exemplo, IDFA), os clientes podem mapear para a identidade que você está configurando. Quando você usa acceptedGlobalNamespaces , você pode usar "requiredTransformation":"sha256(lower($))" para endereços de email ou números de telefone em letras minúsculas e com hash. |
||
destinationDelivery.authenticationRule |
String |
Indica como Platform Os clientes do se conectam ao seu destino. Os valores aceitos são
|
||
destinationDelivery.destinationServerId |
String | A variável instanceId do modelo do servidor de destino usado para este destino. |
||
backfillHistoricalProfileData |
Booleano | Controla se os dados históricos do perfil são exportados quando os públicos são ativados para o destino. Sempre definir como true . |
||
segmentMappingConfig.mapUserInput |
Booleano | Controla se a ID do mapeamento de público no fluxo de trabalho de ativação de destino é entrada pelo usuário. | ||
segmentMappingConfig.mapExperiencePlatformSegmentId |
Booleano | Controla se a ID de mapeamento de público-alvo no fluxo de trabalho de ativação de destino é a ID de público-alvo Experience Platform. | ||
segmentMappingConfig.mapExperiencePlatformSegmentName |
Booleano | Controla se a ID de mapeamento de público no fluxo de trabalho de ativação de destino é o nome do público-alvo Experience Platform. | ||
segmentMappingConfig.audienceTemplateId |
Booleano | A variável instanceId do modelo de metadados de público usado para este destino. |
||
schemaConfig.profileFields |
Matriz | Quando você adiciona predefinidos profileFields conforme mostrado na configuração acima, os usuários terão a opção de mapear atributos de Experience Platform para os atributos predefinidos no lado do destino. |
||
schemaConfig.profileRequired |
Booleano | Uso true se os usuários precisarem mapear atributos de perfil do Experience Platform para atributos personalizados no seu destino, conforme mostrado no exemplo de configuração acima. |
||
schemaConfig.segmentRequired |
Booleano | Sempre usar segmentRequired:true . |
||
schemaConfig.identityRequired |
Booleano | Uso true se os usuários precisarem mapear namespaces de identidade do Experience Platform para o esquema desejado. |
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, você sabe como criar uma nova configuração de destino por meio do Destination SDK /authoring/destinations
Endpoint da API.
Para saber mais sobre o que você pode fazer com esse endpoint, consulte os seguintes artigos:
Para entender onde esse endpoint se encaixa no processo de criação de destino, consulte os seguintes artigos: