Configuración del esquema de socio

Experience Platform utiliza esquemas para describir la estructura de los datos de una manera uniforme y reutilizable. Al ingerir datos en Experience Platform, se estructuran según un esquema XDM. Para obtener más información sobre el modelo de composición de esquema, incluidos los principios de diseño y las prácticas recomendadas, vea los conceptos básicos de la composición de esquema.

Al crear un destino con Destination SDK, puede definir su propio esquema de socio para que lo utilice su plataforma de destino. Utilice el esquema del socio para asignar atributos de perfil de Experience Platform a campos específicos que la plataforma de destino reconoce, todo ello dentro de la interfaz de usuario de Experience Platform.

Al configurar el esquema de socio para el destino, puede ajustar la asignación de campos admitida por la plataforma de destino, como:

Para saber dónde encaja este componente en una integración creada con Destination SDK, consulte el diagrama en la documentación de opciones de configuración o vea la guía sobre cómo usar Destination SDK para configurar un destino basado en archivos.

Puede configurar las opciones del esquema a través del extremo /authoring/destinations. Consulte las siguientes páginas de referencia de la API para ver ejemplos detallados de llamadas de la API donde puede configurar los componentes que se muestran en esta página.

Este artículo describe todas las opciones de configuración de esquema admitidas que puede usar para el destino y muestra lo que ve en la interfaz de usuario de Experience Platform.

Tipos de integración admitidos supported-integration-types

Consulte la tabla siguiente para obtener detalles sobre qué tipos de integraciones admiten la funcionalidad descrita en esta página.

Configuración de esquema admitida supported-schema-types

Destination SDK admite varias configuraciones de esquema:

La sección schemaConfig utiliza varios parámetros de configuración, según el tipo de esquema que necesite, como se muestra en las secciones siguientes.

Creación de un esquema estático attributes-schema

Para crear un esquema estático con atributos de perfil, defina los atributos de destino en la matriz profileFields como se muestra a continuación.

"schemaConfig":{
      "profileFields":[
           {
              "name":"phoneNo",
              "title":"phoneNo",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the mobilePhone.number value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"firstName",
              "title":"firstName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.firstName value in Experience Platform could be firstName on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"lastName",
              "title":"lastName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.lastName value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           }
        ],
      "useCustomerSchemaForAttributeMapping":false,
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true,
      "segmentNamespaceAllowList": ["someNamespace"],
      "segmentNamespaceDenyList": ["someOtherNamespace"]

}

La experiencia de IU resultante se muestra en las imágenes siguientes.

Al seleccionar la asignación de destino, puede ver los campos definidos en la matriz profileFields.

Después de seleccionar los atributos, puede verlos en la columna del campo de destinatario.

Creación de un esquema dinámico dynamic-schema-configuration

Destination SDK admite la creación de esquemas de socios dinámicos. A diferencia de un esquema estático, un esquema dinámico no utiliza una matriz profileFields. En su lugar, los esquemas dinámicos utilizan un servidor de esquema dinámico que se conecta a su propia API desde donde recupera la configuración de esquema.

En una configuración de esquema dinámico, la matriz profileFields se reemplaza por la sección dynamicSchemaConfig, como se muestra a continuación.

"schemaConfig":{
   "dynamicSchemaConfig":{
      "dynamicEnum": {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"DYNAMIC_SCHEMA_SERVER_ID",
         "value": "Schema Name",
         "responseFormat": "SCHEMA"
      }
   },
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
}

Asignaciones requeridas required-mappings

En la configuración del esquema, además del esquema estático o dinámico, tiene la opción de añadir las asignaciones necesarias (o predefinidas). Son asignaciones que se pueden ver en la interfaz de usuario de Experience Platform, pero no se pueden modificar al configurar una conexión con el destino.

Por ejemplo, puede hacer que el campo de dirección de correo electrónico se envíe siempre al destino.

Vea a continuación dos ejemplos de una configuración de esquema con asignaciones requeridas y cómo se ven en el paso de asignación de activar datos en el flujo de trabajo de destinos por lotes.

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "sourceType": "text/x.schema-path",
        "source": "personalEmail.address",
        "destination": "personalEmail.address"
      }
    ]
}

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "destination": "identityMap.ExamplePartner_ID",
        "mandatoryRequired": true,
        "primaryKeyRequired": true
      }
    ]
}

Configuración de la compatibilidad con audiencias externas external-audiences

Para configurar el destino de modo que admita la activación de audiencias generadas externamente, incluya el fragmento de código siguiente en la sección schemaConfig.

"schemaConfig": {
  "segmentNamespaceDenyList": [],
  ...
}

Consulte las descripciones de las propiedades en la tabla más arriba en esta página para obtener más información acerca de la funcionalidad segmentNamespaceDenyList.

Próximos pasos next-steps

Ahora comprende los tipos de esquema estático y dinámico admitidos por Destination SDK, cómo agregar las asignaciones necesarias y cómo configurar el destino para que admita audiencias externas.

Para obtener más información acerca de los demás componentes de destino, consulte los siguientes artículos: