Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para crear su propia configuración de destino con /authoring/destinations
Extremo de API.
Para obtener una descripción detallada de las capacidades que puede configurar a través de este extremo, lea los siguientes artículos:
Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.
Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.
Puede crear una nueva configuración de destino realizando una solicitud de POST a /authoring/destinations
punto final.
Extremo de API: platform.adobe.io/data/core/activation/authoring/destinations
Formato de API
POST /authoring/destinations
La siguiente solicitud crea un nuevo Amazon S3 configuración de destino, 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 /authoring/destinations
punto final.
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
}
}'
Parámetro | Tipo | Descripción |
---|---|---|
name |
Cadena | Indica el título del destino en el catálogo del Experience Platform. |
description |
Cadena | Proporcione una descripción que el Adobe utilizará en el catálogo de destinos de Experience Platform para la tarjeta de destino. Apunte a no más de 4-5 oraciones. ![]() |
status |
Cadena | Indica el estado del ciclo vital de la tarjeta de destino. Los valores aceptados son TEST , PUBLISHED y DELETED . Uso TEST al configurar el destino por primera vez. |
customerAuthenticationConfigurations.authType |
Cadena | Indica la configuración utilizada para autenticar a los clientes Experience Platform en el servidor de destino. Consulte configuración de autenticación de cliente para obtener información detallada sobre los tipos de autenticación admitidos. |
customerDataFields.name |
Cadena | Proporcione un nombre para el campo personalizado que está introduciendo. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. ![]() |
customerDataFields.type |
Cadena | Indica qué tipo de campo personalizado está introduciendo. Los valores aceptados son string , object , integer . Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
customerDataFields.title |
Cadena | Indica el nombre del campo tal como lo ven los clientes en la interfaz de usuario del Experience Platform. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
customerDataFields.description |
Cadena | Proporcione una descripción para el campo personalizado. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
customerDataFields.isRequired |
Booleano | Indica si este campo es necesario en el flujo de trabajo de configuración de destino. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
customerDataFields.enum |
Cadena | Procesa el campo personalizado como un menú desplegable y enumera las opciones disponibles para el usuario. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
customerDataFields.default |
Cadena | Define el valor predeterminado a partir de un enum lista. |
customerDataFields.pattern |
Cadena | Aplica un motivo al campo personalizado, si es necesario. Utilice expresiones regulares para aplicar un patrón. Por ejemplo, si los ID de cliente no incluyen números ni guiones bajos, introduzca ^[A-Za-z]+$ en este campo. Consulte Campos de datos del cliente para obtener información detallada sobre esta configuración. |
uiAttributes.documentationLink |
Cadena | Hace referencia a la página de documentación de la Catálogo de destinos para su destino. Uso https://www.adobe.com/go/destinations-YOURDESTINATION-en , donde YOURDESTINATION es el nombre de su destino. Para un destino llamado Moviestar, debe utilizar 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 IU para obtener información detallada sobre esta configuración. ![]() |
uiAttributes.category |
Cadena | Se refiere a la categoría asignada a su destino en Adobe Experience Platform. Para obtener más información, consulte Categorías de destino. Utilice uno de los siguientes 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 de IU para obtener información detallada sobre esta configuración. |
uiAttributes.connectionType |
Cadena | El tipo de conexión, según el destino. Valores compatibles:
|
uiAttributes.frequency |
Cadena | Se refiere al tipo de exportación de datos compatible con el destino. Configure como. Streaming para integraciones basadas en API, o Batch al exportar archivos a sus destinos. |
identityNamespaces.externalId.acceptsAttributes |
Booleano | Indica si los clientes pueden asignar atributos de perfil estándar a la identidad que está configurando. |
identityNamespaces.externalId.acceptsCustomNamespaces |
Booleano | Indica si los clientes pueden asignar identidades pertenecientes a áreas de nombres personalizadas a la identidad que está configurando. |
identityNamespaces.externalId.transformation |
Cadena | No se muestra en la configuración de ejemplo. Se utiliza, por ejemplo, cuando Platform el cliente tiene direcciones de correo electrónico sin formato como atributo y su plataforma solo acepta correos electrónicos con hash. Aquí es donde proporcionaría la transformación que debe aplicarse (por ejemplo, transformar el correo electrónico a minúsculas y, a continuación, a hash). |
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | Indica cuál áreas de nombres de identidad estándar (por ejemplo, IDFA) los clientes pueden asignarse a la identidad que está configurando. Cuando se usa acceptedGlobalNamespaces , puede utilizar "requiredTransformation":"sha256(lower($))" para escribir direcciones de correo electrónico o números de teléfono en minúsculas y hash. |
destinationDelivery.authenticationRule |
Cadena | Indica cómo Platform los clientes se conectan a su destino. Los valores aceptados son CUSTOMER_AUTHENTICATION , PLATFORM_AUTHENTICATION , NONE .
|
destinationDelivery.destinationServerId |
Cadena | El instanceId de la plantilla del servidor de destino se utiliza para este destino. |
backfillHistoricalProfileData |
Booleano | Controla si los datos de perfil históricos se exportan cuando los segmentos se activan en el destino. Establezca siempre esto como true . |
segmentMappingConfig.mapUserInput |
Booleano | Controla si el usuario introduce el ID de asignación de segmentos en el flujo de trabajo de activación de destino. |
segmentMappingConfig.mapExperiencePlatformSegmentId |
Booleano | Controla si el ID de asignación de segmentos en el flujo de trabajo de activación de destino es el ID de segmento del Experience Platform. |
segmentMappingConfig.mapExperiencePlatformSegmentName |
Booleano | Controla si el ID de asignación de segmentos en el flujo de trabajo de activación de destino es el nombre del segmento del Experience Platform. |
segmentMappingConfig.audienceTemplateId |
Booleano | El instanceId de la plantilla de metadatos de audiencia se utiliza para este destino. |
schemaConfig.profileFields |
Matriz | Cuando se añaden variables predefinidas profileFields 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 |
Booleano | Uso true si los usuarios deben poder asignar atributos de perfil de Experience Platform a atributos personalizados del lado del destino, como se muestra en el ejemplo de configuración anterior. |
schemaConfig.segmentRequired |
Booleano | Usar siempre segmentRequired:true . |
schemaConfig.identityRequired |
Booleano | Uso true si los usuarios deben poder asignar áreas de nombres de identidad de Experience Platform al esquema deseado. |
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de destino recién creada.
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.
Después de leer este documento, ahora sabe cómo crear una nueva configuración de destino a través del Destination SDK /authoring/destinations
Extremo de API.
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: