Ponto de extremidade da API: platform.adobe.io/data/core/activation/authoring/destinations
Esta página lista e descreve todas as operações de API que você pode executar usando o /authoring/destinations
Ponto de extremidade da API. Para obter uma descrição da funcionalidade suportada por este ponto de extremidade, leia configuração de destino.
Antes de continuar, reveja o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas para a API com sucesso, incluindo como obter a permissão de criação de destino necessária e os cabeçalhos necessários.
Você pode criar uma nova configuração de destino, fazendo uma solicitação de POST para o /authoring/destinations
endpoint .
Formato da API
POST /authoring/destinations
Solicitação
A solicitação a seguir cria uma nova configuração de destino de transmissão, configurada pelos parâmetros fornecidos no payload. A carga abaixo inclui todos os parâmetros para destinos de transmissão aceitos pelo /authoring/destinations
endpoint . Observe que não é necessário adicionar todos os parâmetros na chamada do e que o modelo é personalizável, de acordo com os requisitos da API.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"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":"https://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
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"schemaConfig":{
"profileFields":[
{
"name":"a_custom_attribute",
"title":"a_custom_attribute",
"description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
"type":"string",
"isRequired":false,
"readOnly":false,
"hidden":false
}
],
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"aggregation":{
"aggregationType":"BEST_EFFORT",
"bestEffortAggregation":{
"maxUsersPerRequest":10,
"splitUserById":false
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
],
"backfillHistoricalProfileData":true
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | Indica o título do seu destino no catálogo de Experience Platform |
description |
String | Forneça uma descrição que o Adobe usará no catálogo de destinos do Experience Platform para o cartão de destino. 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. |
customerAuthenticationConfigurations |
String | Indica a configuração usada para autenticar clientes do Experience Platform para o servidor. Consulte authType abaixo para valores aceitos. |
customerAuthenticationConfigurations.authType |
String | Os valores compatíveis para destinos de transmissão são:
|
customerDataFields.name |
String | Forneça um nome para o campo personalizado que está sendo introduzido. |
customerDataFields.type |
String | Indica o tipo de campo personalizado que está sendo introduzido. Os valores aceitos são string , object , integer |
customerDataFields.title |
String | Indica o nome do campo, como é visto pelos clientes na interface do usuário do Experience Platform |
customerDataFields.description |
String | Forneça uma descrição para o campo personalizado. |
customerDataFields.isRequired |
Booleano | Indica se esse campo é necessário no fluxo de trabalho de configuração de destino. |
customerDataFields.enum |
String | Renderiza o campo personalizado como um menu suspenso e lista as opções disponíveis para o usuário. |
customerDataFields.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. |
uiAttributes.documentationLink |
String | Refere-se à página de documentação na Catálogo de destinos para o seu destino. Use https://www.adobe.com/go/destinations-YOURDESTINATION-en , onde YOURDESTINATION é o nome do seu destino. Para um destino chamado Moviestar, você usaria https://www.adobe.com/go/destinations-moviestar-en . |
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 . |
uiAttributes.connectionType |
String | Server-to-server no momento, é a única opção disponível. |
uiAttributes.frequency |
String | Streaming no momento, é a única opção disponível. |
identityNamespaces.externalId.acceptsAttributes |
Booleano | Indica se o destino aceita atributos de perfil padrão. Normalmente, esses atributos são destacados na documentação de nossos parceiros. |
identityNamespaces.externalId.acceptsCustomNamespaces |
Booleano | Indica se os clientes podem configurar namespaces personalizados no seu destino. |
identityNamespaces.externalId.transformation |
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. É aqui que você fornece a transformação que precisa ser aplicada (por exemplo, transformar o email em minúsculas e, em seguida, em hash). |
identityNamespaces.externalId.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. Ao utilizar acceptedGlobalNamespaces , você pode usar "requiredTransformation":"sha256(lower($))" para endereços de email em minúsculas e hash ou números de telefone. |
destinationDelivery.authenticationRule |
String | Indica como Platform Os clientes do se conectam ao seu destino. Os valores aceitos são CUSTOMER_AUTHENTICATION , PLATFORM_AUTHENTICATION , NONE .
|
destinationDelivery.destinationServerId |
String | O 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 segmentos são ativados para o destino.
|
segmentMappingConfig.mapUserInput |
Booleano | Controla se a id de mapeamento de segmento no workflow de ativação de destino é inserida pelo usuário. |
segmentMappingConfig.mapExperiencePlatformSegmentId |
Booleano | Controla se a ID de mapeamento de segmento no fluxo de trabalho de ativação de destino é a ID de segmento de Experience Platform. |
segmentMappingConfig.mapExperiencePlatformSegmentName |
Booleano | Controla se a id de mapeamento de segmento no fluxo de trabalho de ativação de destino é o nome do segmento de Experience Platform. |
segmentMappingConfig.audienceTemplateId |
Booleano | O instanceId do modelo de metadados de público-alvo usado para este destino. |
schemaConfig.profileFields |
Matriz | Ao adicionar predefinido profileFields como 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 | 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. |
schemaConfig.segmentRequired |
Booleano | Sempre use segmentRequired:true . |
schemaConfig.identityRequired |
Booleano | Use true se os usuários forem capazes de mapear os namespaces de identidade do Experience Platform para o esquema desejado. |
aggregation.aggregationType |
- | Selecione BEST_EFFORT ou CONFIGURABLE_AGGREGATION . A configuração de exemplo acima inclui BEST_EFFORT agregação. Para obter um exemplo de CONFIGURABLE_AGGREGATION , consulte o exemplo de configuração no configuração de destino documento. Os parâmetros relevantes para a agregação configurável são documentados abaixo nesta tabela. |
aggregation.bestEffortAggregation.maxUsersPerRequest |
Número inteiro | O Experience Platform pode agregar vários perfis exportados em uma única chamada HTTP. Especifique o número máximo de perfis que seu terminal deve receber em uma única chamada HTTP. Observe que esta é a melhor agregação de esforço. Por exemplo, se você especificar o valor 100, a Platform poderá enviar qualquer número de perfis menor que 100 em uma chamada. Se o servidor não aceitar vários usuários por solicitação, defina esse valor como 1. |
aggregation.bestEffortAggregation.splitUserById |
Booleano | Use esse sinalizador se a chamada para o destino deve ser dividida por identidade. Defina este sinalizador como true se o servidor aceitar apenas uma identidade por chamada, para um determinado namespace. |
aggregation.configurableAggregation.splitUserById |
Booleano | Consulte parâmetro na configuração de exemplo here. Use esse sinalizador se a chamada para o destino deve ser dividida por identidade. Defina este sinalizador como true se o servidor aceitar apenas uma identidade por chamada, para um determinado namespace. |
aggregation.configurableAggregation.maxBatchAgeInSecs |
Número inteiro |
|
aggregation.configurableAggregation.maxNumEventsInBatch |
Número inteiro |
|
aggregation.configurableAggregation.aggregationKey |
Booleano | Consulte parâmetro na configuração de exemplo here. Permite agregar os perfis exportados mapeados para o destino com base nos parâmetros abaixo:
|
aggregation.configurableAggregation.aggregationKey.includeSegmentId |
Booleano | Consulte parâmetro na configuração de exemplo here. Defina como true se desejar agrupar perfis exportados para seu destino por ID de segmento. |
aggregation.configurableAggregation.aggregationKey.includeSegmentStatus |
Booleano | Consulte parâmetro na configuração de exemplo here. Você deve definir ambos includeSegmentId:true e includeSegmentStatus:true se desejar agrupar perfis exportados para seu destino por ID de segmento E status do segmento. |
aggregation.configurableAggregation.aggregationKey.includeIdentity |
Booleano | Consulte parâmetro na configuração de exemplo here. Defina como true se quiser agrupar perfis exportados para seu destino pelo namespace de identidade. |
aggregation.configurableAggregation.aggregationKey.oneIdentityPerGroup |
Booleano | Consulte parâmetro na configuração de exemplo here. Use esse parâmetro para especificar se deseja que os perfis exportados sejam agregados em grupos de uma única identidade (GAID, IDFA, números de telefone, email, etc.). |
aggregation.configurableAggregation.aggregationKey.groups |
String | Consulte parâmetro na configuração de exemplo here. Crie listas de grupos de identidade se quiser agrupar perfis exportados para seu destino por grupos de namespace de identidade. Por exemplo, você pode combinar perfis que contêm os identificadores móveis IDFA e GAID em uma chamada para seu destino e emails em outra usando a configuração no exemplo. |
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de destino recém-criada.
Você pode criar uma nova configuração de destino, fazendo uma solicitação de POST para o /authoring/destinations
endpoint .
Formato da API
POST /authoring/destinations
Solicitação
A solicitação a seguir cria um novo Amazon S3 configuração de destino baseada em arquivo, configurada pelos parâmetros fornecidos no payload. A carga abaixo inclui todos os parâmetros para destinos com base em arquivo aceitos pela /authoring/destinations
endpoint . Observe que não é necessário adicionar todos os parâmetros na chamada do e que o modelo é personalizável, de acordo com os requisitos da API.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name": "S3 Destination with CSV Options",
"description": "S3 Destination with CSV Options",
"releaseNotes": "S3 Destination with CSV Options",
"status": "TEST",
"customerAuthenticationConfigurations": [
{
"authType": "S3"
}
],
"customerEncryptionConfigurations": [
{
"encryptionAlgo": ""
}
],
"customerDataFields": [
{
"name": "bucket",
"title": "Select S3 Bucket",
"description": "Select S3 Bucket",
"type": "string",
"isRequired": true,
"readOnly": false,
"hidden": false
},
{
"name": "path",
"title": "S3 path",
"description": "Select S3 Bucket",
"type": "string",
"isRequired": true,
"pattern": "^[A-Za-z]+$",
"readOnly": false,
"hidden": false
},
{
"name": "sep",
"title": "Select separator for each field and value",
"description": "Select for each field and value",
"type": "string",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "encoding",
"title": "Specify encoding (charset) of saved CSV files",
"description": "Select encoding of csv files",
"type": "string",
"enum": ["UTF-8", "UTF-16"],
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "quote",
"title": "Select a single character used for escaping quoted values",
"description": "Select single charachter for escaping quoted values",
"type": "string",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "quoteAll",
"title": "Quote All",
"description": "Select flag for escaping quoted values",
"type": "string",
"enum" : ["true","false"],
"default": "true",
"isRequired": true,
"readOnly": false,
"hidden": false
},
{
"name": "escape",
"title": "Select a single character used for escaping quotes",
"description": "Select a single character used for escaping quotes inside an already quoted value",
"type": "string",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "escapeQuotes",
"title": "Escape quotes",
"description": "A flag indicating whether values containing quotes should always be enclosed in quotes",
"type": "string",
"enum" : ["true","false"],
"isRequired": false,
"default": "true",
"readOnly": false,
"hidden": false
},
{
"name": "header",
"title": "header",
"description": "Writes the names of columns as the first line.",
"type": "string",
"isRequired": false,
"enum" : ["true","false"],
"readOnly": false,
"default": "true",
"hidden": false
},
{
"name": "ignoreLeadingWhiteSpace",
"title": "Ignore leading white space",
"description": "A flag indicating whether or not leading whitespaces from values being written should be skipped.",
"type": "string",
"isRequired": false,
"enum" : ["true","false"],
"readOnly": false,
"default": "true",
"hidden": false
},
{
"name": "nullValue",
"title": "Select the string representation of a null value",
"description": "Sets the string representation of a null value. ",
"type": "string",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "dateFormat",
"title": "Date format",
"description": "Select the string that indicates a date format. ",
"type": "string",
"default": "yyyy-MM-dd",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "charToEscapeQuoteEscaping",
"title": "Char to escape quote escaping",
"description": "Sets a single character used for escaping the escape for the quote character",
"type": "string",
"isRequired": false,
"readOnly": false,
"hidden": false
},
{
"name": "emptyValue",
"title": "Select the string representation of an empty value",
"description": "Select the string representation of an empty value",
"type": "string",
"isRequired": false,
"readOnly": false,
"default": "",
"hidden": false
},
{
"name": "compression",
"title": "Select compression",
"description": "Select compressiont",
"type": "string",
"isRequired": true,
"readOnly": false,
"enum" : ["SNAPPY","GZIP","DEFLATE", "NONE"]
},
{
"name": "fileType",
"title": "Select a fileType",
"description": "Select fileType",
"type": "string",
"isRequired": true,
"readOnly": false,
"hidden": false,
"enum" :["csv", "json", "parquet"],
"default" : "csv"
}
],
"uiAttributes": {
"documentationLink": "https://www.adobe.io/apis/experienceplatform.html",
"category": "S3",
"iconUrl": "https://dc5tqsrhldvnl.cloudfront.net/2/90048/da276e30c730ce6cd666c8ca78360df21.png",
"connectionType": "S3",
"flowRunsSupported": true,
"monitoringSupported": true,
"frequency": "Batch"
},
"destinationDelivery": [
{
"deliveryMatchers" : [
{
"type" : "SOURCE",
"value" : [
"batch"
]
}
],
"authenticationRule": "CUSTOMER_AUTHENTICATION",
"destinationServerId": "{{destinationServerId}}"
}
],
"schemaConfig" : {
"profileRequired" : true,
"segmentRequired" : true,
"identityRequired" : true
},
"batchConfig":{
"allowMandatoryFieldSelection": true,
"allowJoinKeyFieldSelection": true,
"defaultExportMode": "DAILY_FULL_EXPORT",
"allowedExportMode":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE",
"EVERY_HOUR"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00"
},
"backfillHistoricalProfileData": true
}
Para obter descrições detalhadas de todos os parâmetros acima, consulte configuração de destino baseada em arquivo.
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes da configuração de destino recém-criada.
Você pode recuperar uma lista de todas as configurações de destino para sua Organização IMS fazendo uma solicitação de GET para a /authoring/destinations
endpoint .
Formato da API
GET /authoring/destinations
Solicitação
A solicitação a seguir recuperará a lista de configurações de destino às quais você tem acesso, com base na Organização IMS e na configuração da sandbox.
curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations \
-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}'
Resposta
A resposta a seguir retorna o status HTTP 200 com uma lista de configurações de destino às quais você tem acesso, com base na IMS Organization ID e no nome da sandbox usados. One instanceId
corresponde ao modelo para um destino. A resposta é truncada por brevidade.
{
"items":[
{
"instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
"createdDate":"2020-10-28T06:14:09.784471Z",
"lastModifiedDate":"2021-06-28T06:14:09.784471Z",
"imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
"sandboxName":"prod",
"sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
"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":"https://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
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"schemaConfig":{
"profileFields":[
{
"name":"a_custom_attribute",
"title":"a_custom_attribute",
"description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
"type":"string",
"isRequired":false,
"readOnly":false,
"hidden":false
}
],
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"aggregation":{
"aggregationType":"BEST_EFFORT",
"bestEffortAggregation":{
"maxUsersPerRequest":10,
"splitUserById":false
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
],
"destConfigId":"410631b8-f6b3-4b7c-82da-7998aa3f327c",
"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 que o Adobe usará no catálogo de destinos do Experience Platform para o cartão de destino. 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. |
customerAuthenticationConfigurations |
String | Indica a configuração usada para autenticar clientes do Experience Platform para o servidor. Consulte authType abaixo para valores aceitos. |
customerAuthenticationConfigurations.authType |
String | Os valores aceitos são OAUTH2, BEARER . |
customerDataFields.name |
String | Forneça um nome para o campo personalizado que está sendo introduzido. |
customerDataFields.type |
String | Indica o tipo de campo personalizado que está sendo introduzido. Os valores aceitos são string , object , integer |
customerDataFields.title |
String | Indica o nome do campo, como é visto pelos clientes na interface do usuário do Experience Platform |
customerDataFields.description |
String | Forneça uma descrição para o campo personalizado. |
customerDataFields.isRequired |
Booleano | Indica se esse campo é necessário no fluxo de trabalho de configuração de destino. |
customerDataFields.enum |
String | Renderiza o campo personalizado como um menu suspenso e lista as opções disponíveis para o usuário. |
customerDataFields.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. |
uiAttributes.documentationLink |
String | Refere-se à página de documentação na Catálogo de destinos para o seu destino. Use https://www.adobe.com/go/destinations-YOURDESTINATION-en , onde YOURDESTINATION é o nome do seu destino. Para um destino chamado Moviestar, você usaria https://www.adobe.com/go/destinations-moviestar-en |
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 |
uiAttributes.connectionType |
String | Server-to-server no momento, é a única opção disponível. |
uiAttributes.frequency |
String | Streaming no momento, é a única opção disponível. |
identityNamespaces.externalId.acceptsAttributes |
Booleano | Indica se o destino aceita atributos de perfil padrão. Normalmente, esses atributos são destacados na documentação de nossos parceiros. |
identityNamespaces.externalId.acceptsCustomNamespaces |
Booleano | Indica se os clientes podem configurar namespaces personalizados no seu destino. Leia mais sobre namespaces personalizados no Adobe Experience Platform. |
identityNamespaces.externalId.transformation |
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. É aqui que você fornece a transformação que precisa ser aplicada (por exemplo, transformar o email em minúsculas e, em seguida, em hash). |
identityNamespaces.externalId.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. |
destinationDelivery.authenticationRule |
String | Indica como Platform Os clientes do se conectam ao seu destino. Os valores aceitos são CUSTOMER_AUTHENTICATION , PLATFORM_AUTHENTICATION , NONE .
|
destinationDelivery.destinationServerId |
String | O instanceId do modelo do servidor de destino usado para este destino. |
destConfigId |
String | Este campo é gerado automaticamente e não requer sua entrada. |
backfillHistoricalProfileData |
Booleano | Controla se os dados históricos do perfil são exportados quando os segmentos são ativados para o destino.
|
segmentMappingConfig.mapUserInput |
Booleano | Controla se a id de mapeamento de segmento no workflow de ativação de destino é inserida pelo usuário. |
segmentMappingConfig.mapExperiencePlatformSegmentId |
Booleano | Controla se a ID de mapeamento de segmento no fluxo de trabalho de ativação de destino é a ID de segmento de Experience Platform. |
segmentMappingConfig.mapExperiencePlatformSegmentName |
Booleano | Controla se a id de mapeamento de segmento no fluxo de trabalho de ativação de destino é o nome do segmento de Experience Platform. |
segmentMappingConfig.audienceTemplateId |
Booleano | O instanceId do modelo de metadados de público-alvo usado para este destino. Para configurar um modelo de metadados de público-alvo, leia a referência da API de metadados do público-alvo. |
Você pode atualizar uma configuração de destino existente fazendo uma solicitação de PUT para a variável /authoring/destinations
endpoint e fornecer a ID da instância da configuração de destino que deseja atualizar. No corpo da chamada , forneça a configuração de destino atualizada.
Formato da API
PUT /authoring/destinations/{INSTANCE_ID}
Parâmetro | Descrição |
---|---|
{INSTANCE_ID} |
A ID da configuração de destino que você deseja atualizar. |
Solicitação
A solicitação a seguir atualiza uma configuração de destino existente, configurada pelos parâmetros fornecidos no payload. Na chamada de exemplo abaixo, estamos atualizando a configuração criado anteriormente para aceitar agora identificadores de email com hash, GAID e IDFA como namespaces de identidade.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
-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 '
{
"instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
"createdDate":"2020-10-28T06:14:09.784471Z",
"lastModifiedDate":"2021-04-28T06:14:09.784471Z",
"imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
"sandboxName":"prod",
"sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
"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":"https://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
},
"gaid":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"acceptedGlobalNamespaces":{
"GAID":{
}
}
},
"idfa":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"acceptedGlobalNamespaces":{
"IDFA":{
}
}
},
"email_lc_sha256":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"transformation":"sha256(lower($))",
"acceptedGlobalNamespaces":{
"Email":{
"requiredTransformation":"sha256(lower($))"
},
"Email_LC_SHA256":{
}
}
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"schemaConfig":{
"profileFields":[
{
"name":"a_custom_attribute",
"title":"a_custom_attribute",
"description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
"type":"string",
"isRequired":false,
"readOnly":false,
"hidden":false
}
],
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"aggregation":{
"aggregationType":"BEST_EFFORT",
"bestEffortAggregation":{
"maxUsersPerRequest":10,
"splitUserById":false
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
],
"backfillHistoricalProfileData":true
}
Você pode recuperar informações detalhadas sobre uma configuração de destino específica fazendo uma solicitação de GET para a /authoring/destinations
endpoint e fornecer a ID da instância da configuração de destino que deseja recuperar.
Formato da API
GET /authoring/destinations/{INSTANCE_ID}
Parâmetro | Descrição |
---|---|
{INSTANCE_ID} |
A ID da configuração de destino que você deseja recuperar. |
Solicitação
curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
-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}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com informações detalhadas sobre a configuração de destino especificada.
{
"instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
"createdDate":"2020-10-28T06:14:09.784471Z",
"lastModifiedDate":"2021-06-04T06:14:09.784471Z",
"imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
"sandboxName":"prod",
"sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
"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":"https://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
},
"gaid":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"acceptedGlobalNamespaces":{
"GAID":{
}
}
},
"idfa":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"acceptedGlobalNamespaces":{
"IDFA":{
}
}
},
"email_lc_sha256":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true,
"transformation":"sha256(lower($))",
"acceptedGlobalNamespaces":{
"Email":{
"requiredTransformation":"sha256(lower($))"
},
"Email_LC_SHA256":{
}
}
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"schemaConfig":{
"profileFields":[
{
"name":"a_custom_attribute",
"title":"a_custom_attribute",
"description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
"type":"string",
"isRequired":false,
"readOnly":false,
"hidden":false
}
],
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"aggregation":{
"aggregationType":"BEST_EFFORT",
"bestEffortAggregation":{
"maxUsersPerRequest":10,
"splitUserById":false
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
],
"backfillHistoricalProfileData":true
}
Você pode excluir a configuração de destino especificada, fazendo uma solicitação DELETE para a variável /authoring/destinations
endpoint e fornecer a ID da configuração de destino que deseja excluir no caminho da solicitação.
Formato da API
DELETE /authoring/destinations/{INSTANCE_ID}
Parâmetro | Descrição |
---|---|
{INSTANCE_ID} |
O id da configuração de destino que deseja excluir. |
Solicitação
curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
-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}' \
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 junto com uma resposta HTTP vazia.
Os pontos de extremidade da API do Destination SDK seguem os princípios gerais da mensagem de erro da API do Experience Platform. Consulte Códigos de status da API e erros do cabeçalho da solicitação no guia de solução de problemas da plataforma.
Depois de ler este documento, você agora sabe como configurar seu destino usando o /authoring/destinations
Ponto de extremidade da API. Ler como usar o Destination SDK para configurar seu destino para entender onde essa etapa se encaixa no processo de configuração do seu destino.