Configuración de destino

Información general

Esta configuración le permite indicar información esencial como el nombre de destino, la categoría, la descripción y mucho más. Los ajustes de esta configuración también determinan cómo se autentican los usuarios Experience Platform en el destino, cómo aparece en la interfaz de usuario del Experience Platform y las identidades que se pueden exportar al destino.

Esta configuración también conecta a esta las demás configuraciones necesarias para que funcione su destino (servidor de destino y metadatos de audiencia). Lea cómo puede hacer referencia a las dos configuraciones en una sección siguiente.

Puede configurar la funcionalidad descrita en este documento utilizando la variable /authoring/destinations extremo de API. Lectura Operaciones de extremo de la API de destinos para obtener una lista completa de las operaciones que puede realizar en el punto final.

Ejemplo de configuración

A continuación se muestra un ejemplo de configuración de un destino ficticio, Moviestar, que tiene extremos en cuatro ubicaciones del mundo. El destino pertenece a la categoría destinos móviles . Las secciones siguientes desglosan cómo se construye esta configuración.

{
   "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":"http://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
      }
   },
   "schemaConfig":{
      "profileRequired":false,
      "segmentRequired":true,
      "identityRequired":true
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "splitUserById":true,
         "maxBatchAgeInSecs":0,
         "maxNumEventsInBatch":0,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":false,
            "groups":[
               {
                  "namespaces":[
                     "IDFA",
                     "GAID"
                  ]
               },
               {
                  "namespaces":[
                     "EMAIL"
                  ]
               }
            ]
         }
      }
   },
   "backfillHistoricalProfileData":true
}
Parámetro Tipo Descripción
name Cadena Indica el título del destino en el catálogo de Experience Platform.
description Cadena Proporcione una descripción para su tarjeta de destino en el catálogo de destinos de Experience Platform. Apunte a no más de 4-5 frases.
status Cadena Indica el estado del ciclo vital de la tarjeta de destino. Los valores aceptados son TEST, PUBLISHED y DELETED. Uso TEST la primera vez que configure el destino.

Configuraciones de autenticación de clientes

Esta sección en la configuración de destinos genera la variable Configurar nuevo destino en la interfaz de usuario del Experience Platform, donde los usuarios se conectan Experience Platform a las cuentas que tienen con el destino. Según la opción de autenticación que indique en la variable authType , la página Experience Platform se genera para los usuarios de la siguiente manera:

Autenticación del portador

Al configurar el tipo de autenticación al portador, los usuarios deben introducir el token al portador que obtienen de su destino.

Renderización de la interfaz de usuario con autenticación del portador

Autenticación OAuth 2

Usuarios seleccionar Conectarse al destino para almacenar en déclencheur el flujo de autenticación de OAuth 2 en el destino, como se muestra en el ejemplo siguiente para el destino Audiencias personalizadas de Twitter. Para obtener información detallada sobre la configuración de la autenticación OAuth 2 en el punto final de destino, lea la Página de autenticación del SDK de destino OAuth 2.

Renderización de la interfaz de usuario con autenticación OAuth 2

Parámetro Tipo Descripción
customerAuthenticationConfigurations Cadena Indica la configuración utilizada para autenticar a los clientes Experience Platform en el servidor. Consulte authType abajo para los valores aceptados.
authType Cadena Los valores aceptados son OAUTH2, BEARER.

Campos de datos del cliente

Esta sección permite a los socios introducir campos personalizados. En el ejemplo de configuración anterior, customerDataFields requiere que los usuarios seleccionen un extremo en el flujo de autenticación e indiquen su ID de cliente con el destino. La configuración se refleja en el flujo de autenticación como se muestra a continuación:

Flujo de autenticación de campo personalizado

Parámetro Tipo Descripción
name Cadena Proporcione un nombre para el campo personalizado que está introduciendo.
type Cadena Indica qué tipo de campo personalizado está introduciendo. Los valores aceptados son string, object, integer.
title Cadena Indica el nombre del campo, tal como lo ven los clientes en la interfaz de usuario del Experience Platform.
description Cadena Proporcione una descripción para el campo personalizado.
isRequired Booleano Indica si este campo es necesario en el flujo de trabajo de configuración de destino.
enum Cadena Representa el campo personalizado como un menú desplegable y enumera las opciones disponibles para el usuario.
pattern Cadena Aplica un patrón para el campo personalizado, si es necesario. Utilice expresiones regulares para aplicar un patrón. Por ejemplo, si los ID de cliente no incluyen números o guiones bajos, introduzca ^[A-Za-z]+$ en este campo.

Atributos de interfaz de usuario

Esta sección se refiere a los elementos de IU de la configuración anterior que el Adobe debe utilizar para el destino en la interfaz de usuario de Adobe Experience Platform. Vea lo siguiente:

Parámetro Tipo Descripción
documentationLink Cadena Se refiere a la página de documentación de la Catálogo de destinos para su destino. Uso http://www.adobe.com/go/destinations-YOURDESTINATION-en, donde YOURDESTINATION es el nombre de su destino. Para un destino llamado Moviestar, debe usar http://www.adobe.com/go/destinations-moviestar-en
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. 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.
connectionType Cadena Server-to-server actualmente es la única opción disponible.
frequency Cadena Streaming actualmente es la única opción disponible.

Configuración del esquema en el paso de asignación

Habilitar paso de asignación

Utilice los parámetros de schemaConfig para habilitar el paso de asignación del flujo de trabajo de activación de destino. Mediante los parámetros que se describen a continuación, puede determinar si los usuarios Experience Platform pueden asignar atributos de perfil o identidades al esquema deseado en el lado del destino.

Parámetro Tipo Descripción
profileFields Matriz No se muestra en la configuración de ejemplo anterior. Al agregar una profileFields, los usuarios Experience Platform tienen la opción de asignar atributos de Platform a los atributos predefinidos en el lado del destino.
profileRequired Booleano Uso true si los usuarios deben poder asignar atributos de perfil de Experience Platform a atributos personalizados en el lado del destino, como se muestra en el ejemplo de configuración anterior.
segmentRequired Booleano Utilice siempre segmentRequired:true.
identityRequired Booleano Uso true si los usuarios deben poder asignar áreas de nombres de identidad desde el Experience Platform al esquema deseado.

Identidades y atributos

Los parámetros de esta sección determinan qué identidades acepta el destino. Esta configuración también rellena las identidades y atributos de destino en la variable paso de asignación de la interfaz de usuario del Experience Platform, donde los usuarios asignan identidades y atributos de sus esquemas XDM al esquema en el destino.

Debe indicar qué Platform identidades que los clientes pueden exportar a su destino. Algunos ejemplos son Experience Cloud ID, correo electrónico con hash, ID de dispositivo (IDFA, GAID). Estos valores son Platform áreas de nombres de identidad que los clientes pueden asignar a áreas de nombres de identidad desde su destino. También puede indicar si los clientes pueden asignar áreas de nombres personalizadas a identidades compatibles con el destino.

Las áreas de nombres de identidad no requieren una correspondencia de 1 a 1 entre Platform y su destino.
Por ejemplo, los clientes podrían asignar un Platform IDFA espacio de nombres a un IDFA del destino o pueden asignar el mismo Platform IDFA espacio de nombres a Customer ID en el destino.

Obtenga más información en la Información general sobre el área de nombres de identidad.

Representar identidades de objetivo en la interfaz de usuario

Parámetro Tipo Descripción
acceptsAttributes Booleano Indica si el destino acepta atributos de perfil estándar. Normalmente, estos atributos se resaltan en la documentación de los socios.
acceptsCustomNamespaces Booleano Indica si los clientes pueden configurar áreas de nombres personalizadas en el destino.
allowedAttributesTransformation Cadena No se muestra en la configuración de ejemplo. Se utiliza, por ejemplo, cuando la variable Platform El cliente tiene direcciones de correo electrónico simples como atributo y la plataforma solo acepta correos electrónicos con hash. En este objeto, puede aplicar la transformación que debe aplicarse (por ejemplo, transformar el correo electrónico en minúsculas y, a continuación, en hash). Para ver un ejemplo, consulte requiredTransformation en el referencia de la API de configuración de destino.
acceptedGlobalNamespaces - Se utiliza para casos en los que la plataforma acepta áreas de nombres de identidad estándar (por ejemplo, IDFA), para que pueda restringir a los usuarios de Platform a que solo seleccionen estas áreas de nombres de identidad.

Entrega de destino

Parámetro Tipo Descripción
authenticationRule Cadena Indica cómo Platform los clientes se conectan a su destino. Los valores aceptados son CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Uso CUSTOMER_AUTHENTICATION si los clientes de Platform inician sesión en su sistema mediante un nombre de usuario y una contraseña, un token al portador u otro método de autenticación. Por ejemplo, puede seleccionar esta opción si también selecciona authType: OAUTH2 o authType:BEARER en customerAuthenticationConfigurations.
  • Uso PLATFORM_AUTHENTICATION si hay un sistema de autenticación global entre el Adobe y el destino y la variable Platform El cliente no necesita proporcionar credenciales de autenticación para conectarse al destino. En este caso, debe crear un objeto credentials utilizando la variable Credenciales configuración.
  • Uso NONE si no se requiere autenticación para enviar datos a la plataforma de destino.
destinationServerId Cadena La variable instanceId del configuración del servidor de destino para este destino.

Configuración de asignación de segmentos

Sección de configuración de asignación de segmentos

Esta sección de la configuración de destino se relaciona con la forma en que los metadatos de segmento, como los nombres o ID de segmentos, deben compartirse entre el Experience Platform y el destino.

A través de audienceTemplateId, esta sección también vincula esta configuración con el configuración de metadatos de audiencia.

Los parámetros que se muestran en la configuración anterior se describen en la sección referencia de la API del extremo de destinos.

Política de agregación

Directiva de agregación en la plantilla de configuración

Esta sección le permite establecer las políticas de agregación que debe utilizar el Experience Platform al exportar los datos a su destino.

Una política de agregación determina cómo se combinan los perfiles exportados en las exportaciones de datos. Entre las opciones disponibles se encuentran:

  • Mejor agregación de esfuerzos
  • Agregación configurable (tal y como se muestra en la configuración anterior)

Lea la sección en uso de plantillas y ejemplos clave de agregación para comprender cómo incluir la política de agregación en la plantilla de transformación de mensajes en función de la política de agregación seleccionada.

Mejor agregación de esfuerzos

SUGERENCIA

Utilice esta opción si el extremo de la API acepta menos de 100 perfiles por llamada de API.

Esta opción funciona mejor para destinos que prefieren menos perfiles por solicitud y prefieren aceptar más solicitudes con menos datos que menos solicitudes con más datos.

Utilice la variable maxUsersPerRequest para especificar el número máximo de perfiles que el destino puede tener en una solicitud.

Agregación configurable

Esta opción funciona mejor si prefiere tomar lotes grandes, con miles de perfiles en la misma llamada. Esta opción también le permite agregar los perfiles exportados en función de reglas de agregación complejas.

Esta opción le permite:

  • Establezca el tiempo máximo y el número máximo de perfiles que se agregarán antes de que se realice una llamada de API al destino.
  • Agregue los perfiles exportados asignados al destino en función de:
    • ID de segmento;
    • Estado del segmento;
    • Identidad o grupos de identidades.

Para obtener explicaciones detalladas de los parámetros de agregación, consulte la Operaciones de extremo de la API de destinos página de referencia, donde se describe cada parámetro.

Calificaciones históricas de perfil

Puede usar la variable backfillHistoricalProfileData en la configuración de destinos para determinar si se deben exportar a su destino las cualificaciones históricas de perfil.

Parámetro Tipo Descripción
backfillHistoricalProfileData Booleano Controla si los datos del perfil histórico se exportan cuando los segmentos se activan en el destino.
  • true: Platform envía los perfiles de usuario históricos que cumplen los requisitos para el segmento antes de que se active el segmento.
  • false: Platform solo incluye perfiles de usuario que cumplen los requisitos para el segmento una vez activado el segmento.

Conexión de esta configuración a toda la información necesaria para el destino

Algunos de los ajustes de destino deben configurarse mediante el servidor de destino o configuración de metadatos de audiencia. La configuración de destino descrita conecta todos estos ajustes haciendo referencia a las otras dos configuraciones de la siguiente manera:

  • Utilice la variable destinationServerId para hacer referencia al servidor de destino y a la configuración de plantilla configurada para el destino.
  • Utilice la variable audienceMetadataId para hacer referencia a la configuración de metadatos de audiencia configurada para el destino.

En esta página