Configuratie partnerschema

Experience Platform gebruikt schema's om de gegevensstructuur op een consistente en herbruikbare manier te beschrijven. Wanneer gegevens in Experience Platform worden opgenomen, worden ze gestructureerd volgens een XDM-schema. Voor meer informatie over het model van de schemacompositie, met inbegrip van ontwerpprincipes en beste praktijken, zie de grondbeginselen van schemacompositie.

Wanneer het bouwen van een bestemming met Destination SDK, kunt u uw eigen partnerschema bepalen dat door uw bestemmingsplatform moet worden gebruikt. Hiermee kunnen gebruikers profielkenmerken van Experience Platform toewijzen aan specifieke velden die uw doelplatform herkent, allemaal in de interface van Experience Platform.

Wanneer het vormen van het partnerschema voor uw bestemming, kunt u de gebiedstoewijzing verfijnen die door uw bestemmingsplatform wordt gesteund, zoals:

Om te begrijpen waar deze component in een integratie past die met Destination SDK wordt gecreeerd, zie het diagram in de configuratieoptiesdocumentatie of zie de gids op hoe te Destination SDK gebruiken om een op dossier-gebaseerde bestemmingte vormen.

U kunt uw schemamontages via het /authoring/destinations eindpunt vormen. Zie de volgende API verwijzingspagina's voor gedetailleerde API vraagvoorbeelden waar u de componenten kunt vormen die in deze pagina worden getoond.

Dit artikel beschrijft alle gesteunde opties van de schemaconfiguratie die u voor uw bestemming kunt gebruiken, en toont welke klanten in Experience Platform UI zullen zien.

Ondersteunde integratietypen supported-integration-types

Raadpleeg de onderstaande tabel voor meer informatie over de integratietypen die de op deze pagina beschreven functionaliteit ondersteunen.

Ondersteunde schemaconfiguratie supported-schema-types

Destination SDK ondersteunt meerdere schemeconfiguraties:

De sectie schemaConfig gebruikt veelvoudige configuratieparameters, afhankelijk van het type van schema dat u nodig hebt, zoals aangetoond in de hieronder secties.

Een statisch schema maken attributes-schema

Als u een statisch schema met profielkenmerken wilt maken, definieert u de doelkenmerken in de array profileFields , zoals hieronder wordt weergegeven.

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

}

De resulterende ervaring met de gebruikersinterface wordt weergegeven in de onderstaande afbeeldingen.

Wanneer gebruikers de doeltoewijzing selecteren, kunnen ze de velden zien die in de array profileFields zijn gedefinieerd.

Na het selecteren van de attributen, kunnen zij hen in de kolom van het doelgebied zien.

Een dynamisch schema maken dynamic-schema-configuration

Destination SDK steunt de verwezenlijking van dynamische partnerschema's. In tegenstelling tot een statisch schema gebruikt een dynamisch schema geen profileFields -array. In plaats daarvan gebruiken dynamische schema's een dynamische schemaserver die met uw eigen API verbindt van waar het de schemaconfiguratie terugwint.

In een dynamische schemaconfiguratie, wordt de profileFields serie vervangen door de dynamicSchemaConfig sectie, zoals hieronder getoond.

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

Vereiste toewijzingen required-mappings

Binnen de schemaconfiguratie, naast uw statisch of dynamisch schema, hebt u de optie om vereiste (of vooraf bepaalde) afbeeldingen toe te voegen. Dit zijn toewijzingen die gebruikers kunnen weergeven in de gebruikersinterface van Experience Platform, maar ze kunnen deze niet wijzigen wanneer ze een verbinding met uw doel instellen.

U kunt bijvoorbeeld afdwingen dat het veld E-mailadres altijd naar de bestemming wordt verzonden.

Zie onder twee voorbeelden van een schemaconfiguratie met vereiste afbeeldingen en wat deze in de afbeeldingsstap van kijken activeert gegevens aan batch bestemmingen werkschema.

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

Ondersteuning voor extern publiek configureren external-audiences

Om uw bestemming te vormen om de activering van extern geproduceerd publiekte steunen, omvat het hieronder fragment in de schemaConfig sectie.

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

Zie de bezitsbeschrijvingen in de lijstverder hierboven op deze pagina om meer over de segmentNamespaceDenyList functionaliteit te leren.

Volgende stappen next-steps

Na het lezen van dit artikel hebt u beter inzicht in welke schematypen door Destination SDK worden ondersteund en hoe u uw schema kunt configureren.

Raadpleeg de volgende artikelen voor meer informatie over de andere doelcomponenten: