Erstellen einer Zielkonfiguration
Diese Seite veranschaulicht die API-Anfrage und die Payload, die Sie verwenden können, um Ihre eigene Zielkonfiguration unter Verwendung des API-Endpunkts /authoring/destinations
zu erstellen.
Eine ausführliche Beschreibung der Funktionen, die Sie über diesen Endpunkt konfigurieren können, finden Sie in den folgenden Artikeln:
- Konfiguration der Kundenauthentifizierung
- OAuth2-Autorisierung
- Benutzerdefinierte Datenfelder
- Benutzeroberflächenattribute
- Schemakonfiguration
- Konfiguration von Identity-Namespaces
- Zielbereitstellung
- Konfiguration von Zielgruppen-Metadaten
- Konfiguration von Zielgruppen-Metadaten
- Aggregationsrichtlinie
- Batch-Konfiguration
- Historische Profilqualifikationen
Erste Schritte mit API-Vorgängen für die Zielkonfiguration get-started
Bevor Sie fortfahren, lesen Sie Erste Schritte. Dort finden Sie die nötigen Informationen für den erfolgreichen Aufruf der API, einschließlich Details für den Abruf der erforderlichen Authoring-Berechtigung für Ziele und zu den erforderlichen Kopfzeilen.
Erstellen einer Zielkonfiguration create
Sie können eine neue Zielkonfiguration erstellen, indem Sie eine POST-Anfrage an den Endpunkt /authoring/destinations
senden.
platform.adobe.io/data/core/activation/authoring/destinations
API-Format
POST /authoring/destinations
Die folgende Anfrage erstellt eine neue Amazon S3-Zielkonfiguration, die durch die in der Payload bereitgestellten Parameter konfiguriert wird. Die nachstehende Payload enthält alle Parameter für dateibasierte Ziele, die vom Endpunkt /authoring/destinations
akzeptiert werden.
Beachten Sie, dass Sie nicht alle Parameter für den API-Aufruf hinzufügen müssen und dass die Payload entsprechend Ihren API-Anforderungen angepasst werden kann.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto | ||||
---|---|---|---|---|
Parameter | Typ | Beschreibung | ||
name |
Zeichenfolge | Gibt den Titel Ihres Ziels im Experience Platform-Katalog an. | ||
description |
Zeichenfolge |
Geben Sie eine Beschreibung ein, die Adobe im Zielkatalog von Experience Platform für Ihre Zielkarte verwenden soll. Es sollten nicht mehr als 4–5 Sätze sein.+----------------------------------------------------------------+ | img-md |
|
||
status |
Zeichenfolge | Gibt den Lebenszyklusstatus der Zielkarte an. Zulässige Werte sind TEST , PUBLISHED und DELETED . Verwenden Sie TEST , wenn Sie Ihr Ziel zum ersten Mal konfigurieren. |
||
customerAuthenticationConfigurations.authType |
Zeichenfolge | Gibt die Konfiguration an, die zum Authentifizieren von Experience Platform-Kundinnen und -Kunden auf Ihrem Ziel-Server verwendet wird. Siehe Konfiguration der Kundenauthentifizierung für detaillierte Informationen zu den unterstützten Authentifizierungstypen. | ||
customerDataFields.name |
Zeichenfolge |
Geben Sie einen Namen für das benutzerdefinierte Feld ein, das Sie einführen.
|
||
customerDataFields.type |
Zeichenfolge | Gibt an, welchen Typ von benutzerdefiniertem Feld Sie einführen. Zulässige Werte sind string , object , integer .Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. |
||
customerDataFields.title |
Zeichenfolge | Gibt den Feldnamen an, wie er den Kundinnen und Kunden in der Benutzeroberfläche von Experience Platform angezeigt wird. Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. |
||
customerDataFields.description |
Zeichenfolge | Geben Sie eine Beschreibung für das benutzerdefinierte Feld ein. Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. | ||
customerDataFields.isRequired |
Boolesch | Gibt an, ob dieses Feld im Ziel-Setup-Workflow erforderlich ist. Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. |
||
customerDataFields.enum |
Zeichenfolge | Rendert das benutzerdefinierte Feld als Dropdown-Menü und listet die für Benutzende verfügbaren Optionen auf. Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. |
||
customerDataFields.default |
Zeichenfolge | Definiert den Standardwert aus einer enum -Liste. |
||
customerDataFields.pattern |
Zeichenfolge | Erzwingt bei Bedarf ein Muster für das benutzerdefinierte Feld. Verwenden Sie reguläre Ausdrücke, um ein Muster zu erzwingen. Wenn Ihre Kunden-IDs beispielsweise keine Zahlen oder Unterstriche enthalten, geben Sie in dieses Feld ^[A-Za-z]+$ ein.Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen. |
||
uiAttributes.documentationLink |
Zeichenfolge |
Weitere Informationen finden Sie auf der Dokumentationsseite im Zielkatalog für Ihr Ziel. Verwenden Sie
|
||
uiAttributes.category |
Zeichenfolge | Bezieht sich auf die Ihrem Ziel in Adobe Experience Platform zugewiesene Kategorie. Weitere Informationen finden Sie unter Zielkategorien. Verwenden Sie einen der folgenden Werte: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments .Siehe Benutzeroberflächenattribute für detaillierte Informationen zu diesen Einstellungen. |
||
uiAttributes.connectionType |
Zeichenfolge |
Der Verbindungstyp, je nach Ziel. Unterstützte Werte:
|
||
uiAttributes.frequency |
Zeichenfolge | Bezieht sich auf die Art des Datenexports, die vom Ziel unterstützt wird. Setzen Sie diesen auf Streaming für API-basierte Integrationen oder auf Batch , wenn Sie Dateien in Ihre Ziele exportieren. |
||
identityNamespaces.externalId.acceptsAttributes |
Boolesch | Gibt an, ob Kundinnen und Kunden der Identität, die Sie konfigurieren, standardmäßige Profilattribute zuordnen können. | ||
identityNamespaces.externalId.acceptsCustomNamespaces |
Boolesch | Gibt an, ob Kundinnen und Kunden Identitäten, die zu benutzerdefinierten Namespaces gehören, der Identität zuordnen können, die Sie konfigurieren. | ||
identityNamespaces.externalId.transformation |
Zeichenfolge | Wird in der Beispielkonfiguration nicht angezeigt. Wird zum Beispiel verwendet, wenn der Platform-Kunde einfache E-Mail-Adressen als Attribut verwendet und Ihre Plattform nur E-Mails mit Hash akzeptiert. Hier geben Sie die Umwandlung an, die angewendet werden soll (z. B. Umwandlung der E-Mail in Kleinbuchstaben, dann Hash). | ||
identityNamespaces.externalId.acceptedGlobalNamespaces |
– | Gibt an, welche Standard-Identity-Namespaces (z. B. IDFA) Kundinnen und Kunden der Identität zuordnen können, die Sie konfigurieren. Wenn Sie acceptedGlobalNamespaces verwenden, können Sie E-Mail-Adressen oder Telefonnummern mithilfe von "requiredTransformation":"sha256(lower($))" in Kleinbuchstaben umwandeln und hashen. |
||
destinationDelivery.authenticationRule |
Zeichenfolge |
Gibt an, wie Platform-Kundinnen und -Kunden eine Verbindung zu Ihrem Ziel herstellen. Akzeptierte Werte sind
|
||
destinationDelivery.destinationServerId |
Zeichenfolge | Die instanceId der Ziel-Server-Vorlage, die für dieses Ziel verwendet wird. |
||
backfillHistoricalProfileData |
Boolesch | Steuert, ob historische Profildaten exportiert werden, wenn Zielgruppen für das Ziel aktiviert werden. Setzen Sie diesen Parameter immer auf true . |
||
segmentMappingConfig.mapUserInput |
Boolesch | Steuert, ob die Zielgruppenzuordnungs-ID im Zielaktivierungs-Workflow von der Benutzerin bzw. dem Benutzer eingegeben wird. | ||
segmentMappingConfig.mapExperiencePlatformSegmentId |
Boolesch | Steuert, ob die Zielgruppenzuordnungs-ID im Zielaktivierungs-Workflow die Experience Platform-Zielgruppen-ID ist. | ||
segmentMappingConfig.mapExperiencePlatformSegmentName |
Boolesch | Steuert, ob die Zielgruppenzuordnungs-ID im Zielaktivierungs-Workflow der Zielgruppenname von Experience Platform ist. | ||
segmentMappingConfig.audienceTemplateId |
Boolesch | Die instanceId der Zielgruppen-Metadatenvorlage, die für dieses Ziel verwendet wird. |
||
schemaConfig.profileFields |
Array | Beim Hinzufügen vordefinierter profileFields wie in der obigen Konfiguration können Benutzerinnen und Benutzer die Attribute von Experience Platform den vordefinierten Attributen Ihres Ziels zuordnen. |
||
schemaConfig.profileRequired |
Boolesch | Verwenden Sie true , wenn Benutzerinnen und Benutzer die Zuordnung von Profilattributen aus Experience Platform zu benutzerdefinierten Attributen des Ziels vornehmen dürfen, wie in der obigen Beispielkonfiguration dargestellt. |
||
schemaConfig.segmentRequired |
Boolesch | Verwenden Sie immer segmentRequired:true . |
||
schemaConfig.identityRequired |
Boolesch | Verwenden Sie true , wenn Benutzerinnen und Benutzer die Zuordnung von Identity-Namespaces von Experience Platform zu Ihrem gewünschten Schema vornehmen dürfen. |
Umgang mit API-Fehlern
Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-Status-Codes und Fehler im Anfrage-Header in der Anleitung zur Fehlerbehebung für Platform.
Nächste Schritte
Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie über den API-Endpunkt /authoring/destinations
von Destination SDK eine neue Zielkonfiguration erstellen.
Weitere Informationen dazu, was Sie mit diesem Endpunkt tun können, finden Sie in den folgenden Artikeln:
Informationen dazu, wo dieser Endpunkt in den Prozess zur Zielbearbeitung passt, finden Sie in den folgenden Artikeln: