Konfiguration av partnerschema

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:

  • Tillåt användare att mappa ett phoneNumber XDM-attribut till ett phone-attribut som stöds av målplattformen.
  • Skapa dynamiska partnerscheman som Experience Platform kan anropa dynamiskt för att hämta en lista över alla attribut som stöds i destinationen.
  • Definiera obligatoriska fältmappningar som målplattformen kräver.

Mer information om var den här komponenten passar in i en integrering som skapats med Destination SDK finns i diagrammet i dokumentationen för konfigurationsalternativ eller i guiden om hur du använder Destination SDK för att konfigurera ett filbaserat mål.

Du kan konfigurera schemainställningarna via slutpunkten /authoring/destinations. 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.

IMPORTANT
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänsliga. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Integrationstyper som stöds supported-integration-types

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

Schemakonfiguration som stöds supported-schema-types

Destinationen SDK stöder flera schemakonfigurationer:

  • Statiska scheman definieras via arrayen profileFields i avsnittet schemaConfig. I ett statiskt schema definierar du alla målattribut som ska visas i användargränssnittet i Experience Platform i profileFields-arrayen. Om du behöver uppdatera ditt schema måste du uppdatera målkonfigurationen.
  • Dynamiska scheman använder en ytterligare målservertyp, som kallas dynamisk schemaserver, för att dynamiskt hämta de målattribut som stöds och generera scheman baserat på ditt eget API. Dynamiska scheman använder inte profileFields-arrayen. 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.
  • I schemakonfigurationen kan du lägga till obligatoriska (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.

Avsnittet schemaConfig använder flera konfigurationsparametrar, beroende på vilken typ av schema du behöver, vilket visas i avsnitten nedan.

Skapa ett statiskt schema attributes-schema

Om du vill skapa ett statiskt schema med profilattribut definierar du målattributen i profileFields-arrayen enligt 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 du använder en profileFields-array kan du helt utelämna parametern useCustomerSchemaForAttributeMapping.
useCustomerSchemaForAttributeMapping
Boolean
Valfritt

Aktiverar eller inaktiverar mappningen av attribut från kundschemat till de attribut som du definierar i profileFields-arrayen.

  • Om värdet är true kan användarna bara se källkolumnen i mappningsfältet. profileFields kan inte användas i det här fallet.
  • Om värdet är false kan användare mappa källattribut från sitt schema till de attribut du definierade i profileFields-arrayen.

Standardvärdet är 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 true om användare ska kunna mappa identitetstyper från Experience Platform till de attribut du definierade i arrayen profileFields .
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 mappa målgrupper från namnområdet AudienceManager till det här målet.

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åde segmentNamespaceAllowList och segmentNamespaceDenyList saknas i konfigurationen kan användarna bara exportera målgrupper som kommer från segmenteringstjänsten.
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"] kommer att blockera användare från att mappa målgrupper från namnområdet AudienceManager till det här målet.

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åde segmentNamespaceAllowed och segmentNamespaceDenyList saknas i konfigurationen kan användarna bara exportera målgrupper som kommer från segmenteringstjänsten.

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-arrayen.

Gränssnittsbild som visar skärmen för målattribut.

När attributen har markerats kan de se dem i målfältskolumnen.

Användargränssnittsbilden visar ett statiskt målschema med attribut

Skapa ett dynamiskt schema dynamic-schema-configuration

Destination SDK stöder skapande av dynamiska partnerscheman. I motsats till ett statiskt schema använder inte ett dynamiskt schema en profileFields-matris. 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.

IMPORTANT
Innan du skapar ett dynamiskt schema måste du skapa en dynamisk schemaserver.

I en dynamisk schemakonfiguration ersätts profileFields-arrayen av avsnittet dynamicSchemaConfig, vilket 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-kunder ansluter till ditt mål. Godkända värden är CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.

  • Använd CUSTOMER_AUTHENTICATION om plattformskunder loggar in i systemet med någon av de autentiseringsmetoder som beskrivs här.
  • Använd PLATFORM_AUTHENTICATION om det finns ett globalt autentiseringssystem mellan Adobe och ditt mål och Platform-kunden inte behöver ange några autentiseringsuppgifter för att ansluta till ditt mål. I det här fallet måste du skapa ett autentiseringsobjekt med hjälp av API:t för autentiseringsuppgifter.
  • Använd NONE om ingen autentisering krävs för att skicka data till målplattformen.
dynamicEnum.destinationServerId
Sträng
Obligatoriskt
instanceId för 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 ett dynamiskt schema definieras.
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 true om användare ska kunna mappa identitetstyper från Experience Platform till de attribut du definierade i arrayen profileFields .

Obligatoriska mappningar required-mappings

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.

NOTE
Följande kombinationer av obligatoriska mappningar stöds för närvarande:
  • Du kan konfigurera ett obligatoriskt källfält och ett obligatoriskt målfält. I det här fallet kan användare inte redigera eller markera något av de två fälten och bara visa markeringen.
  • Du kan bara konfigurera ett obligatoriskt målfält. I det här fallet kan användarna välja ett källfält som ska kopplas till målet.
Det går för närvarande inte att konfigurera endast ett obligatoriskt källfält och.

Se två exempel nedan på en schemakonfiguration med obligatoriska mappningar och hur dessa ser ut i mappningssteget i arbetsflödet för att aktivera data till batchmål.

Krävda käll- och målmappningar

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.

code language-json
"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "sourceType": "text/x.schema-path",
        "source": "personalEmail.address",
        "destination": "personalEmail.address"
      }
    ]
}
table 0-row-4 1-row-4 2-row-4 3-row-4 4-row-4 layout-auto
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 nödvändiga mappningarna som du definierar i requiredMappings-arrayen.
requiredMappings.sourceType Sträng Obligatoriskt

Anger typen för fältet source. Värden som stöds:

  • text/x.schema-path: Använd det här värdet när fältet source är ett profilattribut från ett XDM-schema.
  • text/x.aep-xl: Använd det här värdet när fältet source definieras av ett reguljärt uttryck. Exempel: iif(segmentMembership.ups.aep_seg_id.status==\"exited\", \"1\", \"0\")
  • text/plain: Använd det här värdet när fältet source definieras av en makromall. Den enda makromall som stöds är metadata.segment.alias.
requiredMappings.source Sträng Obligatoriskt

Anger värdet för källfältet. Värdetyper som stöds:

  • XDM-profilattribut. Exempel: personalEmail.address. När källattributet är ett XDM-profilattribut anger du parametern sourceType till text/x.schema-path.
  • Reguljära uttryck. Exempel: iif(segmentMembership.ups.aep_seg_id.status==\"exited\", \"1\", \"0\"). När källattributet är ett reguljärt uttryck anger du parametern sourceType till text/x.aep-xl.
  • Makromallar. Exempel:metadata.segment.alias. När källattributet är en makromall ställer du in parametern sourceTypetext/plain. Den enda makromall som stöds är metadata.segment.alias.
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.

Därför är både Source field- och Target field-avsnitten i plattformsgränssnittet nedtonade.

Bild av nödvändiga mappningar i gränssnittets aktiveringsflöde.

Obligatorisk målmappning

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.

code language-json
"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "destination": "identityMap.ExamplePartner_ID",
        "mandatoryRequired": true,
        "primaryKeyRequired": true
      }
    ]
}
table 0-row-4 1-row-4 2-row-4 3-row-4 4-row-4 layout-auto
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 nödvändiga mappningarna som du definierar i requiredMappings-arrayen.
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 ett obligatoriskt attribut.
primaryKeyRequired Boolean Valfritt Anger om mappningen ska markeras som en dedupliceringsnyckel.

Därför är avsnittet Target field i plattformsgränssnittet nedtonat, medan avsnittet Source field är aktivt och användarna kan interagera med det. Alternativen Mandatory key och Deduplication key är aktiva, och användare kan inte ändra dem.

Bild av nödvändiga mappningar i gränssnittets aktiveringsflöde.

Konfigurera stöd för externa målgrupper external-audiences

Om du vill konfigurera målet så att det stöder aktivering av externt genererade målgrupper inkluderar du fragmentet nedan i avsnittet schemaConfig.

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

Mer information om funktionen segmentNamespaceDenyList finns i egenskapsbeskrivningarna i tabellen ovan på den här sidan.

Nästa steg next-steps

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:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6