Konfiguration des Partnerschemas

Experience Platform verwendet Schemata, um die Struktur von Daten konsistent und wiederverwendbar zu beschreiben. Wenn Sie Daten in Experience Platform aufnehmen, werden sie nach einem XDM-Schema strukturiert. Weitere Informationen zum Schemakompositionsmodell, einschließlich Planungsgrundsätzen und Best Practices, finden Sie in den Grundlagen der Schemakomposition.

Beim Erstellen eines Ziels mit Destination SDK können Sie Ihr eigenes Partnerschema definieren, das von Ihrer Zielplattform verwendet werden soll. Verwenden Sie das Partnerschema, um Profilattribute von Experience Platform bestimmten Feldern zuzuordnen, die Ihre Zielplattform erkennt, und zwar alles in der Experience Platform-Benutzeroberfläche.

Beim Konfigurieren des Partnerschemas für Ihr Ziel können Sie die von Ihrer Zielplattform unterstützte Feldzuordnung anpassen, z. B.:

  • Ordnen Sie ein phoneNumber XDM-Attribut einem phone zu, das von Ihrer Zielplattform unterstützt wird.
  • Erstellen Sie dynamische Partnerschemata, die Experience Platform dynamisch aufrufen können, um eine Liste aller unterstützten Attribute in Ihrem Ziel abzurufen.
  • Erforderliche Feldzuordnungen definieren, die für Ihre Zielplattform erforderlich sind.

Informationen dazu, wo diese Komponente in eine mit Destination SDK erstellte Integration passt, finden Sie im Diagramm in der Dokumentation Konfigurationsoptionen oder im Handbuch Verwenden von Destination SDK zum Konfigurieren eines dateibasierten Ziels.

Die Schemaeinstellungen können über den Endpunkt /authoring/destinations konfiguriert werden. Detaillierte Beispiele für API-Aufrufe, in denen Sie die auf dieser Seite angezeigten Komponenten konfigurieren können, finden Sie auf den folgenden API-Referenzseiten.

Dieser Artikel beschreibt alle unterstützten Schemakonfigurationsoptionen, die Sie für Ihr Ziel verwenden können, und zeigt, was Sie in der Experience Platform-Benutzeroberfläche sehen.

IMPORTANT
Bei allen von Destination SDK unterstützten Parameternamen und Werte wird Groß-/Kleinschreibung. Um Fehler bei der Groß-/Kleinschreibung zu vermeiden, verwenden Sie die Parameternamen und -werte genau wie in der Dokumentation gezeigt.

Unterstützte Integrationstypen supported-integration-types

Die nachstehende Tabelle beschreibt ausführlich, welche Integrationstypen die auf dieser Seite beschriebenen Funktionen unterstützen.

Integrationstyp
Unterstützt Funktionen
Echtzeit-Integrationen (Streaming)
Ja
Dateibasierte (Batch-)Integrationen
Ja

Unterstützte Schemakonfiguration supported-schema-types

Destination SDK unterstützt mehrere Schemakonfigurationen:

  • Statische Schemata werden durch das Array profileFields im Abschnitt schemaConfig definiert. In einem statischen Schema definieren Sie jedes Zielattribut, das in der Experience Platform-Benutzeroberfläche angezeigt werden soll, im profileFields-Array. Wenn Sie Ihr Schema aktualisieren müssen, müssen Sie die Zielkonfiguration aktualisieren.
  • Dynamische Schemata verwenden einen zusätzlichen Typ von Ziel-Server, den sogenannten dynamischen Schema-Server, um basierend auf Ihrer eigenen API dynamisch die unterstützten Zielattribute abzurufen und Schemata zu genieren. Dynamische Schemata verwenden nicht das Array profileFields. Wenn Sie Ihr Schema aktualisieren müssen, müssen Sie die Zielkonfiguration aktualisieren. Stattdessen ruft der dynamische Schema-Server das aktualisierte Schema von Ihrer API ab.
  • Innerhalb der Schemakonfiguration haben Sie die Möglichkeit, erforderliche (oder vordefinierte) Zuordnungen hinzuzufügen. Hierbei handelt es sich um Zuordnungen, die Sie in der Experience Platform-Benutzeroberfläche anzeigen können. Sie können sie jedoch beim Einrichten einer Verbindung zu Ihrem Ziel nicht ändern. Beispielsweise können Sie erzwingen, dass das Feld für die E-Mail-Adresse immer an das Ziel gesendet wird.

Der Abschnitt schemaConfig verwendet mehrere Konfigurationsparameter, je nach dem benötigten Schematyp, wie in den folgenden Abschnitten dargestellt.

Erstellen eines statischen Schemas attributes-schema

Um ein statisches Schema mit Profilattributen zu erstellen, definieren Sie die Zielattribute im Array profileFields wie unten dargestellt.

"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
Erforderlich/Optional
Beschreibung
profileFields
Array
Optional
Definiert das Array von Zielattributen, die von Ihrer Zielplattform akzeptiert werden und denen Sie Ihre Profilattribute zuordnen können. Bei Verwendung des Arrays profileFields können Sie den Parameter useCustomerSchemaForAttributeMapping ganz weglassen.
useCustomerSchemaForAttributeMapping
Boolesch
Optional

Aktiviert oder deaktiviert die Zuordnung von Attributen aus dem Kundenschema zu den Attributen, die Sie im Array profileFields definieren.

  • Wenn auf true gesetzt, wird nur die Quellspalte im Zuordnungsfeld angezeigt. profileFields sind in diesem Fall nicht anwendbar.
  • Wenn auf false festgelegt, können Sie Quellattribute aus Ihrem Schema den Attributen zuordnen, die Sie im profileFields-Array definiert haben.

Der Standardwert lautet false.

profileRequired
Boolesch
Optional
Verwenden Sie true, wenn Sie in der Lage sein sollen, Profilattribute von Experience Platform benutzerdefinierten Attributen auf Ihrer Zielplattform zuzuordnen.
segmentRequired
Boolesch
Erforderlich
Dieser Parameter ist für Destination SDK erforderlich und sollte immer auf true gesetzt werden.
identityRequired
Boolesch
Erforderlich
Legen Sie ihn auf true fest, wenn Sie in der Lage sein sollen​ „Identitätstypen von Experience Platform den Attributen zuzuordnen, die Sie im profileFields-Array definiert haben.
segmentNamespaceAllowList
Array
Optional
Ordnet nur Zielgruppen aus den im -Array definierten Zielgruppen-Namespaces dem Ziel zu.

Von der Verwendung dieses Parameters wird in den meisten Fällen abgeraten. Verwenden Sie stattdessen "segmentNamespaceDenyList":[] , damit alle Arten von Zielgruppen an Ihr Ziel exportiert werden können.

Wenn in Ihrer Konfiguration sowohl segmentNamespaceAllowList als auch segmentNamespaceDenyList fehlen, können Sie nur Zielgruppen exportieren, die aus dem Segmentierungs-Service stammen.

segmentNamespaceAllowList und segmentNamespaceDenyList schließen sich gegenseitig aus.
segmentNamespaceDenyList
Array
Optional
Schränkt die Zuordnung von Zielgruppen aus den im Array definierten Zielgruppen-Namespaces auf das Ziel ein.

Adobe empfiehlt, den Export aller Zielgruppen unabhängig von ihrer Herkunft durch Festlegen von "segmentNamespaceDenyList":[] zuzulassen.

Wichtig: Wenn Sie in Ihrer schemaConfig keine segmentNamespaceDenyList angeben und keine segmentNamespaceAllowList verwenden, setzt das System segmentNamespaceDenyList automatisch auf []. Dadurch wird verhindert, dass in Zukunft benutzerdefinierte Zielgruppen verloren gehen. Aus Sicherheitsgründen empfiehlt Adobe, "segmentNamespaceDenyList":[] explizit in der Konfiguration festzulegen.

segmentNamespaceAllowList und segmentNamespaceDenyList schließen sich gegenseitig aus.

Das daraus resultierende Benutzeroberflächenerlebnis wird in den unten stehenden Bildern gezeigt.

Wenn Sie das Zielgruppen-Mapping auswählen, können Sie die im profileFields-Array definierten Felder sehen.

UI-Bild, das den Bildschirm mit den Zielattributen anzeigt.

Nach Auswahl der Attribute werden sie in der Spalte Zielfeld angezeigt.

UI-Bild, das ein statisches Zielschema mit Attributen anzeigt

Erstellen eines dynamischen Schemas dynamic-schema-configuration

Destination SDK unterstützt die Erstellung dynamischer Partnerschemata. Im Gegensatz zu statischen Schemata verwendet ein dynamisches Schema kein Array profileFields. Stattdessen verwenden dynamische Schemata einen dynamischen Schema-Server, der eine Verbindung zu Ihrer eigenen API herstellt, von der aus die Schemakonfiguration abgerufen wird.

IMPORTANT
Bevor Sie ein dynamisches Schema erstellen, müssen Sie einen dynamischen Schema-Server erstellen.

In einer dynamischen Schemakonfiguration wird das Array profileFields durch den Abschnitt dynamicSchemaConfig ersetzt, wie unten dargestellt.

"schemaConfig":{
   "dynamicSchemaConfig":{
      "dynamicEnum": {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"DYNAMIC_SCHEMA_SERVER_ID",
         "value": "Schema Name",
         "responseFormat": "SCHEMA"
      }
   },
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
}
Parameter
Typ
Erforderlich/Optional
Beschreibung
dynamicEnum.authenticationRule
Zeichenfolge
Erforderlich

Gibt an, wie Experience Platform-Kundinnen und -Kunden eine Verbindung zu Ihrem Ziel herstellen. Akzeptierte Werte sind CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.

  • Verwenden Sie CUSTOMER_AUTHENTICATION, wenn sich Experience Platform Kunden über eine der Authentifizierungsmethoden, die in der Dokumentation Kundenauthentifizierung) beschrieben sind, bei Ihrem ​ anmelden.
  • Verwenden Sie PLATFORM_AUTHENTICATION, wenn ein globales Authentifizierungssystem zwischen Adobe und Ihrem Ziel existiert und der Experience Platform-Kunde keine Authentifizierungs-Anmeldedaten bereitstellen muss, um eine Verbindung zu Ihrem Ziel herzustellen. In diesem Fall müssen Sie ein Anmeldeinformationsobjekt erstellen mithilfe der Anmeldeinformationen-API und die ID des Anmeldeinformationsobjekts im authenticationId Parameter in der Konfiguration Zielversand übergeben.
  • Verwenden Sie NONE, wenn keine Authentifizierung erforderlich ist, um Daten an Ihre Zielplattform zu senden.
dynamicEnum.destinationServerId
Zeichenfolge
Erforderlich
Die instanceId des dynamischen Schema-Servers. Dieser Ziel-Server enthält den API-Endpunkt, der Aufrufe zum Abrufen des dynamischen Schemas Experience Platform.
dynamicEnum.value
Zeichenfolge
Erforderlich
Der Name des dynamischen Schemas, wie in der Konfiguration des dynamischen Schema-Servers definiert.
dynamicEnum.responseFormat
Zeichenfolge
Erforderlich
Die Einstellung ist immer SCHEMA, wenn ein dynamisches Schema definiert wird.
profileRequired
Boolesch
Optional
Verwenden Sie true, wenn Sie in der Lage sein sollen, Profilattribute von Experience Platform benutzerdefinierten Attributen auf Ihrer Zielplattform zuzuordnen.
segmentRequired
Boolesch
Erforderlich
Dieser Parameter ist für Destination SDK erforderlich und sollte immer auf true gesetzt werden.
identityRequired
Boolesch
Erforderlich
Legen Sie ihn auf true fest, wenn Sie in der Lage sein sollen​ „Identitätstypen von Experience Platform den Attributen zuzuordnen, die Sie im profileFields-Array definiert haben.

Erforderliche Zuordnungen required-mappings

Innerhalb der Schemakonfiguration haben Sie neben Ihrem statischen oder dynamischen Schema die Möglichkeit, erforderliche (oder vordefinierte) Zuordnungen hinzuzufügen. Hierbei handelt es sich um Zuordnungen, die Sie in der Experience Platform-Benutzeroberfläche anzeigen können. Sie können sie jedoch beim Einrichten einer Verbindung zu Ihrem Ziel nicht ändern.

Beispielsweise können Sie erzwingen, dass das Feld für die E-Mail-Adresse immer an das Ziel gesendet wird.

NOTE
Die folgenden Kombinationen erforderlicher Zuordnungen werden derzeit unterstützt:
  • Sie können ein erforderliches Quellfeld und ein erforderliches Zielfeld konfigurieren. In diesem Fall können Sie keines der Felder bearbeiten oder auswählen und nur die Auswahl anzeigen.
  • Sie können auch nur ein erforderliches Zielfeld konfigurieren. In diesem Fall können Sie ein Quellfeld auswählen, das dem Ziel zugeordnet werden soll.
Die Konfiguration, dass nur ein Quellfeld erforderlich ist, wird derzeit nicht unterstützt.

Nachfolgend finden Sie zwei Beispiele für eine Schemakonfiguration mit erforderlichen Zuordnungen und dafür, wie diese im Zuordnungsschritt des Workflows „Daten für Batch-Ziele aktivieren“ aussehen.

Erforderliche Quell- und Zielzuordnungen

Das folgende Beispiel zeigt die erforderlichen Quell- und Zielzuordnungen. Wenn sowohl Quell- als auch Zielfelder als erforderliche Zuordnungen angegeben sind, können Sie keines der Felder auswählen oder bearbeiten und nur die vordefinierte Auswahl anzeigen.

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 Erforderlich/Optional Beschreibung
requiredMappingsOnly Boolesch Optional Wenn dies auf true festgelegt ist, können Sie keine anderen Attribute und Identitäten im Aktivierungsfluss zuordnen, abgesehen von den erforderlichen Zuordnungen, die Sie im requiredMappings-Array definieren.
requiredMappings.sourceType Zeichenfolge Erforderlich

Gibt den Typ des Felds source an. Unterstützte Werte:

  • text/x.schema-path: Verwenden Sie diesen Wert, wenn das Feld source ein Profilattribut aus einem XDM-Schema ist.
  • text/x.aep-xl: Verwenden Sie diesen Wert, wenn das Feld source durch einen regulären Ausdruck definiert wird. Beispiel: iif(segmentMembership.ups.aep_seg_id.status==\"exited\", \"1\", \"0\")
  • text/plain: Verwenden Sie diesen Wert, wenn das Feld source durch eine Makrovorlage definiert wird. Die einzige unterstützte Makrovorlage ist derzeit metadata.segment.alias.
requiredMappings.source Zeichenfolge Erforderlich

Gibt den Wert des Quellfelds an. Unterstützte Werttypen:

  • XDM-Profilattribute. Beispiel: personalEmail.address. Wenn Ihr Quellattribut ein XDM-Profilattribut ist, legen Sie den Parameter sourceType auf text/x.schema-path fest.
  • Reguläre Ausdrücke. Beispiel: iif(segmentMembership.ups.aep_seg_id.status==\"exited\", \"1\", \"0\"). Wenn Ihr Quellattribut ein regulärer Ausdruck ist, legen Sie den Parameter sourceType auf text/x.aep-xl fest.
  • Makrovorlagen. Beispiel:metadata.segment.alias. Wenn Ihr Quellattribut eine Makrovorlage ist, legen Sie den Parameter sourceType auf text/plain fest. Die einzige unterstützte Makrovorlage ist derzeit metadata.segment.alias.
requiredMappings.destination Zeichenfolge Erforderlich Gibt den Wert des Zielfelds an. Wenn sowohl Quell- als auch Zielfelder als erforderliche Zuordnungen angegeben sind, können Sie keines der Felder auswählen oder bearbeiten und nur die Auswahl anzeigen.

Daher werden sowohl die Abschnitte Source als auch Target in der Experience Platform-Benutzeroberfläche deaktiviert.

Bild der erforderlichen Zuordnungen im UI-Aktivierungsfluss.

Erforderliche Zielzuordnung

Das folgende Beispiel zeigt eine erforderliche Zielzuordnung. Wenn nur das Zielfeld als erforderlich angegeben wird, können Sie auswählen, welches Quellfeld ihm zugeordnet werden soll.

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 Erforderlich/Optional Beschreibung
requiredMappingsOnly Boolesch Optional Wenn dies auf true festgelegt ist, können Sie keine anderen Attribute und Identitäten im Aktivierungsfluss zuordnen, abgesehen von den erforderlichen Zuordnungen, die Sie im requiredMappings-Array definieren.
requiredMappings.destination Zeichenfolge Erforderlich Gibt den Wert des Zielfelds an. Wenn nur das Zielfeld angegeben ist, können Sie ein Quellfeld auswählen, das dem Ziel zugeordnet werden soll.
mandatoryRequired Boolesch Optional Gibt an, ob die Zuordnung als obligatorisches Attribut markiert werden soll.
primaryKeyRequired Boolesch Optional Gibt an, ob die Zuordnung als Deduplizierungsschlüssel markiert werden soll.

Daher ist der Abschnitt Zielfeld in der Experience Platform-Benutzeroberfläche deaktiviert, während der Abschnitt Source- aktiv ist und Sie damit interagieren können. Die Optionen Obligatorischer Schlüssel und Deduplizierungsschlüssel sind aktiviert und können nicht geändert werden.

Bild der erforderlichen Zuordnungen im UI-Aktivierungsfluss.

Konfigurieren der Unterstützung für externe Zielgruppen external-audiences

Um Ihr Ziel so zu konfigurieren, dass es die Aktivierung extern generierter Zielgruppen unterstützt, fügen Sie den folgenden Ausschnitt im Abschnitt schemaConfig ein.

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

Weitere Informationen zur segmentNamespaceDenyList-Funktion finden Sie ​ den Eigenschaftsbeschreibungen in ​Tabelle) weiter oben auf dieser Seite.

Nächste Schritte next-steps

Jetzt wissen Sie, welche statischen und dynamischen Schematypen von Destination SDK unterstützt werden, wie Sie erforderliche Zuordnungen hinzufügen und wie Sie Ihr Ziel konfigurieren, um externe Zielgruppen zu unterstützen.

Weitere Informationen zu den anderen Zielkomponenten finden Sie in den folgenden Artikeln:

recommendation-more-help
experience-platform-help-destinations