Erstellen einer Zielgruppenvorlage
platform.adobe.io/data/core/activation/authoring/audience-templates
Für einige Ziele, die mit Destination SDK erstellt wurden, müssen Sie eine Zielgruppen-Metadatenkonfiguration erstellen, um Zielgruppenmetadaten im Ziel programmgesteuert zu erstellen, zu aktualisieren oder zu löschen. Auf dieser Seite erfahren Sie, wie Sie den API-Endpunkt /authoring/audience-templates
zum Erstellen der Konfiguration verwenden.
Eine ausführliche Beschreibung der Funktionen, die Sie über diesen Endpunkt konfigurieren können, finden Sie unter Verwaltung von Zielgruppen-Metadaten.
Erste Schritte mit API-Vorgängen für Zielgruppenvorlagen 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 Zielgruppenvorlage create
Sie können eine neue Zielgruppenvorlage erstellen, indem Sie eine POST
-Anfrage an den Endpunkt /authoring/audience-templates
stellen.
API-Format
POST /authoring/audience-templates
Die folgende Anfrage erstellt eine neue Zielgruppenvorlage, die durch die in der Payload angegebenen Parameter konfiguriert wird. Die nachstehende Payload enthält alle Parameter, die vom Endpunkt /authoring/audience-templates
akzeptiert werden. Beachten Sie, dass Sie nicht alle Parameter für den Aufruf hinzufügen müssen und dass die Vorlage 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 layout-auto | ||
---|---|---|
Eigenschaft | Typ | Beschreibung |
name |
Zeichenfolge | Der Name der Zielgruppen-Metadatenvorlage für Ihr Ziel. Dieser Name wird in jeder partnerspezifischen Fehlermeldung in der Benutzeroberfläche von Experience Platform angezeigt. |
url |
String | Die URL und der Endpunkt Ihrer API, die zum Erstellen, Aktualisieren, Löschen oder Validieren von Audiences und/oder Datenflüssen in Ihrer Plattform verwendet wird. Zwei branchenübliche Beispiele sind https://adsapi.snapchat.com/v1/adaccounts/{{customerData.accountId}}/segments und https://api.linkedin.com/v2/dmpSegments/{{segment.alias}} . |
httpMethod |
Zeichenfolge | Die Methode, die für Ihren Endpunkt verwendet wird, um die Zielgruppe in Ihrem Ziel programmgesteuert zu erstellen, zu aktualisieren, zu löschen oder zu validieren. Beispiel: POST , PUT , DELETE |
headers.header |
Zeichenfolge | Gibt alle HTTP-Header an, die zum Aufruf Ihrer API hinzugefügt werden sollen. Beispiel: "Content-Type" |
headers.value |
Zeichenfolge | Gibt den Wert von HTTP-Headern an, die zum Aufruf Ihrer API hinzugefügt werden sollen. Beispiel: "application/x-www-form-urlencoded" |
requestBody |
Zeichenfolge | Gibt den Inhalt des Nachrichtentextes an, der an Ihre API gesendet werden soll. Welche Parameter zum Objekt requestBody hinzugefügt werden sollten, hängt davon ab, welche Felder Ihre API akzeptiert. In der Dokumentation zu unterstützten Makros erfahren Sie, was Sie in den Nachrichtentext einfügen können. |
responseFields.name |
Zeichenfolge | Geben Sie alle Antwortfelder an, die Ihre API beim Aufruf zurückgibt. Ein Beispiel finden Sie im Abschnitt Vorlagenbeispiele im Dokument über die Funktionalität von Zielgruppen-Metadaten. |
responseFields.value |
Zeichenfolge | Geben Sie den Wert aller Antwortfelder an, die Ihre API beim Aufruf zurückgibt. |
responseErrorFields.name |
Zeichenfolge | Geben Sie alle Antwortfelder an, die Ihre API beim Aufruf zurückgibt. Ein Beispiel finden Sie im Abschnitt Vorlagenbeispiele im Dokument über die Funktionalität von Zielgruppen-Metadaten. |
responseErrorFields.value |
Zeichenfolge | Analysiert alle Fehlermeldungen, die bei Antworten auf API-Aufrufe von Ihrem Ziel zurückgegeben werden. Diese Fehlermeldungen werden Benutzerinnen und Benutzern in der Benutzeroberfläche von Experience Platform angezeigt. |
validations.field |
Zeichenfolge | Gibt an, ob Überprüfungen für Felder durchgeführt werden sollen, bevor API-Aufrufe an Ihr Ziel gesendet werden. Sie können beispielsweise {{validations.accountId}} verwenden, um die Konto-ID des Benutzers zu überprüfen. |
validations.regex |
Zeichenfolge | Gibt an, wie das Feld strukturiert sein sollte, damit die Validierung erfolgreich ist. |
Umgang mit API-Fehlern
Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-StatusCodes und Fehler in der Anfragekopfzeile im Handbuch zur Fehlerbehebung bei Experience Platform.
Nächste Schritte
Nach dem Lesen dieses Dokuments wissen Sie jetzt, wann Sie Zielgruppenvorlagen verwenden sollten und wie Sie eine Zielgruppenvorlage mithilfe des API-Endpunkts /authoring/audience-templates
konfigurieren. Lesen Sie Verwenden des Destination SDK zum Konfigurieren Ihres Ziels, um zu verstehen, wo dieser Schritt in den Prozess der Konfiguration Ihres Ziels passt.