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. Quand des données sont ingérées dans Platform, elles sont structurées en fonction d’un schéma XDM. Pour plus d’informations sur le modèle de composition de schémas, notamment 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. Cela permet aux utilisateurs de mapper les attributs de profil de Platform à des champs spécifiques reconnus par votre plateforme de destination, le tout dans l’interface utilisateur de 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 où ce composant entre dans une intégration créée avec Destination SDK, reportez-vous au diagramme de la section options de configuration ou consulter le guide sur la manière d’effectuer utiliser la 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 la clientèle verra dans l’interface utilisateur de 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.

Quand les utilisateurs sélectionnent le mapping de ciblage, ils peuvent voir les champs définis dans le tableau profileFields.

Après avoir sélectionné les attributs, les utilisateurs peuvent 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 les utilisateurs peuvent afficher dans l’interface utilisateur de Platform, mais qu’ils ne peuvent pas modifier pendant 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
      }
    ]
}

Étapes suivantes next-steps

Vous êtes arrivé au bout de cet article. À présent, vous devriez mieux comprendre quels types de schémas sont pris en charge par Destination SDK et comment le configurer.

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