Crear una configuración de destino
- Temas:
- Destinos
Creado para:
- Administrador
- Usuario
Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para crear su propia configuración de destino mediante el extremo de API /authoring/destinations
.
Para obtener una descripción detallada de las capacidades que puede configurar a través de este extremo, lea los siguientes artículos:
- Configuración de autenticación del cliente
- Autorización de OAuth2
- Campos de datos del cliente
- Atributos de IU
- Configuración del esquema
- Configuración del área de nombres de identidad
- Envío de destino
- Configuración de metadatos de audiencia
- Configuración de metadatos de audiencia
- Política de agregación
- Configuración por lotes
- Cualificaciones históricas del perfil
Introducción a las operaciones de la API de configuración de destino
Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.
Crear una configuración de destino
Puede crear una nueva configuración de destino realizando una solicitud de POST al extremo /authoring/destinations
.
platform.adobe.io/data/core/activation/authoring/destinations
Formato de API
POST /authoring/destinations
La siguiente solicitud crea una nueva configuración de destino Amazon S3, configurada por los parámetros proporcionados en la carga útil. La carga útil siguiente incluye todos los parámetros para destinos basados en archivos aceptados por el extremo /authoring/destinations
.
Tenga en cuenta que no tiene que añadir todos los parámetros a la llamada de API y que la carga útil se puede personalizar, según los requisitos de la 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":"Amazon S3 destination with predefined CSV formatting options",
"description":"Amazon S3 destination with predefined CSV formatting options",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"S3"
}
],
"customerDataFields":[
{
"name":"bucket",
"title":"Enter the name of your Amazon S3 bucket",
"description":"Amazon S3 bucket name",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false
},
{
"name":"path",
"title":"Enter the path to your S3 bucket folder",
"description":"Enter the path to your S3 bucket folder",
"type":"string",
"isRequired":true,
"pattern":"^[A-Za-z]+$",
"readOnly":false,
"hidden":false
},
{
"name":"compression",
"title":"Compression format",
"description":"Select the desired file compression format.",
"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.com/go/destinations-amazon-s3-en",
"category":"cloudStorage",
"icon":{
"key":"amazonS3"
},
"connectionType":"S3",
"frequency":"Batch"
},
"destinationDelivery":[
{
"deliveryMatchers":[
{
"type":"SOURCE",
"value":[
"batch"
]
}
],
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
],
"schemaConfig":{
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":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"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
},
"backfillHistoricalProfileData":true
}
}'
name
description

status
TEST
, PUBLISHED
y DELETED
. Use TEST
la primera vez que configure el destino.customerAuthenticationConfigurations.authType
customerDataFields.name
Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.

customerDataFields.type
string
, object
, integer
.Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.
customerDataFields.title
Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.
customerDataFields.description
customerDataFields.isRequired
Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.
customerDataFields.enum
Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.
customerDataFields.default
enum
.customerDataFields.pattern
^[A-Za-z]+$
en este campo.Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración.
uiAttributes.documentationLink
https://www.adobe.com/go/destinations-YOURDESTINATION-en
, donde YOURDESTINATION
es el nombre de su destino. Para un destino llamado Moviestar, utilizaría https://www.adobe.com/go/destinations-moviestar-en
. Tenga en cuenta que este vínculo solo funciona después de que el Adobe active el destino y se publique la documentación.Consulte atributos de interfaz de usuario para obtener información detallada sobre esta configuración.

uiAttributes.category
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 de interfaz de usuario para obtener información detallada sobre esta configuración.
uiAttributes.connectionType
El tipo de conexión, según el destino. Valores compatibles:
Server-to-server
Cloud storage
Azure Blob
Azure Data Lake Storage
S3
SFTP
DLZ
uiAttributes.frequency
Streaming
para integraciones basadas en API o en Batch
al exportar archivos a sus destinos.identityNamespaces.externalId.acceptsAttributes
identityNamespaces.externalId.acceptsCustomNamespaces
identityNamespaces.externalId.transformation
identityNamespaces.externalId.acceptedGlobalNamespaces
Si usa
acceptedGlobalNamespaces
, puede usar "requiredTransformation":"sha256(lower($))"
para escribir direcciones de correo electrónico o números de teléfono en minúsculas y hash.destinationDelivery.authenticationRule
Indica cómo se conectan los clientes de Platform a su destino. Los valores aceptados son CUSTOMER_AUTHENTICATION
, PLATFORM_AUTHENTICATION
, NONE
.
- Use
CUSTOMER_AUTHENTICATION
si los clientes de Platform inician sesión en el sistema con un nombre de usuario y una contraseña, un token de portador u otro método de autenticación. Por ejemplo, seleccionaría esta opción si también seleccionaraauthType: OAUTH2
oauthType:BEARER
encustomerAuthenticationConfigurations
. - Use
PLATFORM_AUTHENTICATION
si existe un sistema de autenticación global entre el Adobe y el destino y el cliente Platform no necesita proporcionar credenciales de autenticación para conectarse al destino. En este caso, debe crear un objeto de credenciales con la configuración de la API credentials. - Use
NONE
si no se requiere autenticación para enviar datos a la plataforma de destino.
destinationDelivery.destinationServerId
instanceId
de la plantilla de servidor de destino utilizada para este destino.backfillHistoricalProfileData
true
.segmentMappingConfig.mapUserInput
segmentMappingConfig.mapExperiencePlatformSegmentId
segmentMappingConfig.mapExperiencePlatformSegmentName
segmentMappingConfig.audienceTemplateId
instanceId
de la plantilla de metadatos de audiencia utilizada para este destino.schemaConfig.profileFields
profileFields
predefinido como se muestra en la configuración anterior, los usuarios tendrán la opción de asignar atributos de Experience Platform a los atributos predefinidos del lado del destino.schemaConfig.profileRequired
true
si los usuarios deben poder asignar atributos de perfil de Experience Platform a atributos personalizados del lado del destino, como se muestra en la configuración de ejemplo anterior.schemaConfig.segmentRequired
segmentRequired:true
.schemaConfig.identityRequired
true
si los usuarios deben poder asignar áreas de nombres de identidad del Experience Platform al esquema deseado.Administración de errores de API
Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.
Pasos siguientes
Después de leer este documento, ahora sabe cómo crear una nueva configuración de destino a través del extremo de API del Destination SDK /authoring/destinations
.
Para obtener más información acerca de lo que puede hacer con este extremo, consulte los siguientes artículos:
Para saber dónde encaja este extremo en el proceso de creación de destinos, consulte los siguientes artículos: