Configuration des schémas de partenaire

Experience Platform utilise des schémas pour décrire la structure des données de manière cohérente et réutilisable. Lorsque vous ingérez des données dans Experience Platform, elles sont structurées selon un schéma XDM. Pour plus d’informations sur le modèle de composition de schémas, y compris sur les principes de conception et les bonnes pratiques, consultez les bases de la composition de schémas.

Pendant la création d’une destination avec Destination SDK, vous pouvez définir votre propre schéma de partenaire à utiliser par votre plateforme de destination. Utilisez le schéma de partenaire pour mapper les attributs de profil de Experience Platform à des champs spécifiques reconnus par votre plateforme de destination, le tout dans l’interface utilisateur de Experience Platform.

Pendant la configuration du schéma de partenaire pour la destination, vous pouvez affiner le mappage des champs pris en charge par votre plateforme de destination, par exemple :

Pour comprendre la place de ce composant dans une intégration créée avec Destination SDK, consultez le diagramme de la documentation options de configuration ou consultez le guide sur la utilisation de Destination SDK pour configurer une destination basée sur des fichiers.

Vous pouvez configurer vos paramètres de schéma via le point d’entrée /authoring/destinations. Pour obtenir des exemples d’appels API détaillés dans lesquels vous pouvez configurer les composants affichés sur cette page, consultez les pages de référence de l’API suivantes.

Cet article décrit toutes les options de configuration de schéma prises en charge que vous pouvez utiliser pour la destination et montre ce que vous voyez dans l’interface utilisateur de Experience Platform.

Types d’intégration pris en charge supported-integration-types

Pour en savoir plus sur les types d’intégration qui prennent en charge les fonctionnalités décrites sur cette page, consultez le tableau ci-dessous.

Configuration de schéma prise en charge supported-schema-types

Destination SDK prend en charge plusieurs configurations de schéma :

schemaConfig utilise plusieurs paramètres de configuration, en fonction du type de schéma dont vous avez besoin, comme indiqué dans les sections ci-dessous.

Création d’un schéma statique attributes-schema

Pour créer un schéma statique avec des attributs de profil, définissez les attributs de la cible dans profileFields comme illustré ci-dessous.

"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"]

}

L’expérience de l’interface utilisateur qui en résulte est affichée dans les images ci-dessous.

Lorsque vous sélectionnez le mapping de ciblage, vous pouvez voir les champs définis dans le tableau de profileFields.

Après avoir sélectionné les attributs, vous pouvez les voir dans la colonne du champ cible.

Création d’un schéma dynamique dynamic-schema-configuration

Destination SDK prend en charge la création de schémas de partenaire dynamiques. Contrairement à un schéma statique, un schéma dynamique n’utilise pas de tableau profileFields, mais un serveur de schéma dynamique qui se connecte à votre propre API à partir de laquelle il récupère la configuration du schéma.

Dans une configuration de schéma dynamique, le tableau profileFields est remplacé par dynamicSchemaConfig, comme illustré ci-dessous.

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

Mappages obligatoires required-mappings

Dans la configuration du schéma, en plus de votre schéma statique ou dynamique, vous avez la possibilité d’ajouter des mappages obligatoires (ou prédéfinis). Il s’agit de mappages que vous pouvez afficher dans l’interface utilisateur de Experience Platform, mais que vous ne pouvez pas modifier lors de la configuration d’une connexion à la destination.

Vous pouvez, par exemple, appliquer le champ de l’adresse e-mail pour qu’il soit toujours envoyé à la destination.

Vous trouverez ci-dessous deux exemples de configuration de schéma avec les mappages obligatoires et ce à quoi ils ressemblent dans l’étape de mappage du flux de travail d’activation des données vers les destinations des lots.

"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
      }
    ]
}

Configuration de la prise en charge des audiences externes external-audiences

Pour configurer la destination afin de prendre en charge l’activation des audiences générées en externe, incluez le fragment de code ci-dessous dans la section schemaConfig.

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

Consultez les descriptions des propriétés dans le tableau plus haut sur cette page pour en savoir plus sur la fonctionnalité de segmentNamespaceDenyList.

Étapes suivantes next-steps

Vous comprenez désormais les types de schéma statiques et dynamiques pris en charge par Destination SDK, comment ajouter les mappages requis et comment configurer la destination pour prendre en charge les audiences externes.

Pour en savoir plus sur les autres composants de destination, consultez les articles suivants :