Crear una configuración de destino

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:

IMPORTANT
Todos los nombres y valores de parámetro admitidos por el Destination SDK distinguen entre mayúsculas y minúsculas 1}. 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.

Introducción a las operaciones de la API de configuración de destino get-started

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 create

Puede crear una nueva configuración de destino realizando una solicitud de POST al extremo /authoring/destinations.

TIP
extremo de API: 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.

Solicitud
code language-shell
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
   }
}'
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 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. Imagen de IU de Platform que muestra la descripción del destino. {width="100" modal="regular"}
status Cadena Indica el estado del ciclo vital de la tarjeta de destino. Los valores aceptados son TEST, PUBLISHED y DELETED. Use TEST la primera vez que configure el destino.
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. Imagen de IU de Platform que muestra campos de datos de clientes. {width="100" modal="regular"}
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 de clientes 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 de una lista enum.
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, escriba ^[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 del catálogo de destinos para su destino. Use 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. Imagen de IU de Platform que muestra el enlace de documentación. {width="100" modal="regular"}
uiAttributes.category Cadena Se refiere a la categoría asignada a su destino en Adobe Experience Platform. Para obtener más información, lea Categorías de destino. Use 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 interfaz de usuario para obtener información detallada sobre esta configuración.
uiAttributes.connectionType Cadena

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 Cadena Se refiere al tipo de exportación de datos compatible con el destino. Se establece en Streaming para integraciones basadas en API o en 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 que pertenecen 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 el cliente Platform tiene direcciones de correo electrónico sin formato como atributo y la 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 qué áreas de nombres de identidad estándar (por ejemplo, IDFA) los clientes pueden asignar a la identidad que está configurando.
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 Cadena

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 seleccionara authType: OAUTH2 o authType:BEARER en customerAuthenticationConfigurations.
  • 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 Cadena instanceId de la plantilla de servidor de destino utilizada para este destino.
backfillHistoricalProfileData Booleano Controla si los datos de perfil históricos se exportan cuando las audiencias se activan en el destino. Establezca siempre esto en true.
segmentMappingConfig.mapUserInput Booleano Controla si el usuario introduce el ID de asignación de audiencia en el flujo de trabajo de activación de destino.
segmentMappingConfig.mapExperiencePlatformSegmentId Booleano Controla si el ID de asignación de audiencia en el flujo de trabajo de activación de destino es el ID de audiencia de Experience Platform.
segmentMappingConfig.mapExperiencePlatformSegmentName Booleano Controla si el ID de asignación de audiencia en el flujo de trabajo de activación de destino es el nombre de audiencia del Experience Platform.
segmentMappingConfig.audienceTemplateId Cadena instanceId de la plantilla de metadatos de audiencia utilizada para este destino.
schemaConfig.profileFields Matriz Cuando agregue 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 Booleano Utilice 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 Booleano Usar siempre segmentRequired:true.
schemaConfig.identityRequired Booleano Use true si los usuarios deben poder asignar áreas de nombres de identidad del Experience Platform al esquema deseado.
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con detalles de la configuración de destino recién creada.

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:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6