Experience Platform använder scheman för att beskriva datastrukturen på ett konsekvent och återanvändbart sätt. När data hämtas till Platform struktureras de enligt ett XDM-schema. Mer information om schemakompositionsmodellen, inklusive designprinciper och bästa praxis, finns i grunderna för schemakomposition.
När du skapar ett mål med Destination SDK kan du definiera ett eget partnerschema som ska användas av målplattformen. Detta ger användarna möjlighet att mappa profilattribut från Plattform till specifika fält som målplattformen känner igen, allt inom plattformens användargränssnitt.
När du konfigurerar partnerschemat för målet kan du finjustera den fältmappning som stöds av målplattformen, till exempel:
phoneNumber
XDM-attribut till en phone
attribut som stöds av målplattformen.Mer information om var den här komponenten passar in i en integrering som skapas med Destination SDK finns i diagrammet i konfigurationsalternativ eller se guiden om hur du använd Destination SDK för att konfigurera ett filbaserat mål.
Du kan konfigurera dina schemainställningar via /authoring/destinations
slutpunkt. På följande API-referenssidor finns detaljerade API-anropsexempel där du kan konfigurera komponenterna som visas på den här sidan.
I den här artikeln beskrivs alla schemakonfigurationsalternativ som stöds och som du kan använda för ditt mål. Här visas vad kunderna kommer att se i plattformsgränssnittet.
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänslig. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.
Se tabellen nedan för mer ingående information om vilka typer av integreringar som stöder de funktioner som beskrivs på den här sidan.
Integrationstyp | Stöder funktioner |
---|---|
Integrering i realtid (direktuppspelning) | Ja |
Filbaserade (batch) integreringar | Ja |
Destinationen SDK stöder flera schemakonfigurationer:
profileFields
i schemaConfig
-avsnitt. I ett statiskt schema definierar du alla målattribut som ska visas i användargränssnittet för Experience Platform i profileFields
array. Om du behöver uppdatera ditt schema måste du uppdatera målkonfigurationen.profileFields
array. Om du behöver uppdatera schemat behöver du inte uppdatera målkonfigurationen. I stället hämtar den dynamiska schemaservern det uppdaterade schemat från ditt API.The schemaConfig
-avsnittet använder flera konfigurationsparametrar, beroende på vilken typ av schema du behöver, vilket visas i avsnitten nedan.
Om du vill skapa ett statiskt schema med profilattribut definierar du målattributen i profileFields
som visas nedan.
"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"]
}
Parameter | Typ | Obligatoriskt/valfritt | Beskrivning |
---|---|---|---|
profileFields |
Array | Valfritt | Definierar den array med målattribut som accepteras av målplattformen och som kunderna kan mappa sina profilattribut till. När en profileFields kan du utesluta useCustomerSchemaForAttributeMapping parametern helt. |
useCustomerSchemaForAttributeMapping |
Boolean | Valfritt | Aktiverar eller inaktiverar mappning av attribut från kundschemat till de attribut som du definierar i profileFields array.
false . |
profileRequired |
Boolean | Valfritt | Använd true om användare ska kunna mappa profilattribut från Experience Platform till anpassade attribut på målplattformen. |
segmentRequired |
Boolean | Obligatoriskt | Den här parametern krävs av Destinationen SDK och ska alltid anges till true . |
identityRequired |
Boolean | Obligatoriskt | Ange till true om användare ska kunna mappa identitetstyper från Experience Platform till de attribut du definierade i dialogrutan profileFields array. |
segmentNamespaceAllowList |
Array | Valfritt | Definierar specifika målgruppsnamnutrymmen från vilka användare kan mappa målgrupper till målet. Använd den här parametern för att begränsa plattformsanvändare så att de bara kan exportera målgrupper från de målgruppsnamnutrymmen som du definierar i arrayen. Den här parametern kan inte användas tillsammans med segmentNamespaceDenyList .Exempel: "segmentNamespaceAllowList": ["AudienceManager"] tillåter användare att endast kartlägga målgrupper från AudienceManager namnutrymme till detta mål. Om du vill tillåta användare att exportera alla målgrupper till ditt mål, kan du ignorera den här parametern. Om båda segmentNamespaceAllowList och segmentNamespaceDenyList saknas i din konfiguration kan användare bara exportera målgrupper som kommer från Segmenteringstjänst. |
segmentNamespaceDenyList |
Array | Valfritt | Begränsar användare från att mappa målgrupper till målet från de målgruppsnamnutrymmen som definieras i arrayen. Kan inte användas tillsammans med segmentNamespaceAllowed . Exempel: "segmentNamespaceDenyList": ["AudienceManager"] blockerar användare från att mappa målgrupper från AudienceManager namnutrymme till detta mål. Om du vill tillåta användare att exportera alla målgrupper till ditt mål, kan du ignorera den här parametern. Om båda segmentNamespaceAllowed och segmentNamespaceDenyList saknas i din konfiguration kan användare bara exportera målgrupper som kommer från Segmenteringstjänst. Om du vill tillåta export av alla målgrupper, oavsett ursprung, anger du "segmentNamespaceDenyList":[] . |
Den slutliga användarupplevelsen visas i bilderna nedan.
När användarna väljer målmappning kan de se fälten som definierats i profileFields
array.
När attributen har markerats kan de se dem i målfältskolumnen.
Destination SDK stöder skapande av dynamiska partnerscheman. I motsats till ett statiskt schema använder ett dynamiskt schema inte ett profileFields
array. I stället använder dynamiska scheman en dynamisk schemaserver som ansluter till din egen API från den plats där schemakonfigurationen hämtas.
Innan du skapar ett dynamiskt schema måste du skapa en dynamisk schemaserver.
I en dynamisk schemakonfiguration profileFields
arrayen ersätts med dynamicSchemaConfig
som visas nedan.
"schemaConfig":{
"dynamicSchemaConfig":{
"dynamicEnum": {
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"DYNAMIC_SCHEMA_SERVER_ID",
"value": "Schema Name",
"responseFormat": "SCHEMA"
}
},
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
}
Parameter | Typ | Obligatoriskt/valfritt | Beskrivning |
---|---|---|---|
dynamicEnum.authenticationRule |
Sträng | Obligatoriskt | Anger hur Platform kunderna ansluter till er destination. Godkända värden är CUSTOMER_AUTHENTICATION , PLATFORM_AUTHENTICATION , NONE .
|
dynamicEnum.destinationServerId |
Sträng | Obligatoriskt | The instanceId av din dynamiska schemaserver. Målservern innehåller API-slutpunkten som Experience Platform ska anropa för att hämta det dynamiska schemat. |
dynamicEnum.value |
Sträng | Obligatoriskt | Namnet på det dynamiska schemat, enligt definitionen i den dynamiska schemaserverkonfigurationen. |
dynamicEnum.responseFormat |
Sträng | Obligatoriskt | Alltid inställt på SCHEMA när du definierar ett dynamiskt schema. |
profileRequired |
Boolean | Valfritt | Använd true om användare ska kunna mappa profilattribut från Experience Platform till anpassade attribut på målplattformen. |
segmentRequired |
Boolean | Obligatoriskt | Den här parametern krävs av Destinationen SDK och ska alltid anges till true . |
identityRequired |
Boolean | Obligatoriskt | Ange till true om användare ska kunna mappa identitetstyper från Experience Platform till de attribut du definierade i dialogrutan profileFields array. |
I schemakonfigurationen kan du, förutom ditt statiska eller dynamiska schema, lägga till nödvändiga (eller fördefinierade) mappningar. Det här är mappningar som användare kan visa i plattformsgränssnittet, men de kan inte ändra dem när de konfigurerar en anslutning till ditt mål.
Du kan t.ex. framtvinga att e-postadressfältet alltid skickas till målet.
Följande kombinationer av obligatoriska mappningar stöds för närvarande:
Konfigurering av endast ett obligatoriskt källfält pågår not stöds.
Se två exempel nedan på en schemakonfiguration med obligatoriska mappningar och hur dessa ser ut i mappningssteget i aktivera data till batchmålarbetsflöde.
I exemplet nedan visas både obligatoriska käll- och målmappningar. När både käll- och målfält anges som obligatoriska mappningar kan användare inte markera eller redigera något av de två fälten och bara visa den fördefinierade markeringen.
"schemaConfig": {
"requiredMappingsOnly": true,
"requiredMappings": [
{
"sourceType": "text/x.schema-path",
"source": "personalEmail.address",
"destination": "personalEmail.address"
}
]
}
Parameter | Typ | Obligatoriskt/valfritt | Beskrivning |
---|---|---|---|
requiredMappingsOnly |
Boolean | Valfritt | Om värdet är true kan användare inte mappa andra attribut och identiteter i aktiveringsflödet, förutom de mappningar som du anger i dialogrutan requiredMappings array. |
requiredMappings.sourceType |
Sträng | Obligatoriskt | Anger typen av source fält. Värden som stöds:
|
requiredMappings.source |
Sträng | Obligatoriskt | Anger värdet för källfältet. Värdetyper som stöds:
|
requiredMappings.destination |
Sträng | Obligatoriskt | Anger målfältets värde. När både käll- och målfält har angetts som obligatoriska mappningar kan användare inte markera eller redigera något av de två fälten och bara visa markeringen. |
Detta resulterar i att både Source field och Target field -avsnitt i plattformsgränssnittet är nedtonade.
I exemplet nedan visas en nödvändig målmappning. Om bara målfältet anges som obligatoriskt kan användarna välja vilket källfält som ska kopplas till det.
"schemaConfig": {
"requiredMappingsOnly": true,
"requiredMappings": [
{
"destination": "identityMap.ExamplePartner_ID",
"mandatoryRequired": true,
"primaryKeyRequired": true
}
]
}
Parameter | Typ | Obligatoriskt/valfritt | Beskrivning |
---|---|---|---|
requiredMappingsOnly |
Boolean | Valfritt | Om värdet är true kan användare inte mappa andra attribut och identiteter i aktiveringsflödet, förutom de mappningar som du anger i dialogrutan requiredMappings array. |
requiredMappings.destination |
Sträng | Obligatoriskt | Anger målfältets värde. När endast målfältet är angivet kan användarna välja ett källfält som ska kopplas till målet. |
mandatoryRequired |
Boolean | Valfritt | Anger om mappningen ska markeras som en obligatoriskt attribut. |
primaryKeyRequired |
Boolean | Valfritt | Anger om mappningen ska markeras som en dedupliceringsnyckel. |
Resultatet blev att Target field -avsnittet i plattformsgränssnittet är nedtonat, medan Source field -avsnittet är aktivt och användarna kan interagera med det. The Mandatory key och Deduplication key är aktiva och användarna kan inte ändra dem.
När du har läst den här artikeln bör du få en bättre förståelse för vilka schematyper som stöds av Destinationen SDK och hur du kan konfigurera ditt schema.
Mer information om de andra målkomponenterna finns i följande artiklar: