Flow Service wird zur Erfassung und Zentralisierung von Kundendaten aus unterschiedlichen Quellen innerhalb von Adobe Experience Platform verwendet. Der Dienst stellt eine Benutzeroberfläche und eine RESTful-API bereit, über die alle unterstützten Quellen verbunden werden können.
In diesem Lernprogramm wird die Flow Service-API verwendet, um Anzeigen-Systeme zu untersuchen.
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um mit der Flow Service-API eine erfolgreiche Verbindung zu einem Anzeigen-System herzustellen.
Für dieses Lernprogramm müssen Sie über eine gültige Verbindung zur Werbeanwendung eines Drittanbieters verfügen, von der Sie Daten erfassen möchten. Eine gültige Verbindung besteht aus der Verbindungs-ID und der Verbindungs-ID der Anwendung. Weitere Informationen zum Erstellen einer Werbeverbindung und zum Abrufen dieser Werte finden Sie im Tutorial Verbinden einer Werbequelle mit Platform.
In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform
Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Alle Ressourcen in Experience Platform, einschließlich derjenigen, die zu Flow Service gehören, werden zu bestimmten virtuellen Sandboxen isoliert. Für alle Anforderungen an Platform-APIs ist ein Header erforderlich, der den Namen der Sandbox angibt, in der der Vorgang ausgeführt wird in:
x-sandbox-name: {SANDBOX_NAME}
Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:
Content-Type: application/json
Mithilfe der Basisverbindung für Ihr Werbesystem können Sie Ihre Datentabellen untersuchen, indem Sie GET anfordern. Verwenden Sie den folgenden Aufruf, um den Pfad der Tabelle zu finden, die Sie überprüfen oder in Platform aufnehmen möchten.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parameter | Beschreibung |
---|---|
{BASE_CONNECTION_ID} |
Die ID der Basis-Verbindung für Ihr Werbesystem. |
Anfrage
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/2484f2df-c057-4ab5-84f2-dfc0577ab592/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Eine erfolgreiche Antwort ist eine Reihe von Tabellen, die von zu Ihrem Werbesystem reichen. Suchen Sie die Tabelle, die Sie in Platform einbinden möchten, und beachten Sie die path
-Eigenschaft, da Sie sie im nächsten Schritt bereitstellen müssen, um die Struktur zu überprüfen.
[
{
"type": "table",
"name": "v201809.ACCOUNT_PERFORMANCE_REPORT",
"path": "v201809.ACCOUNT_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.ADGROUP_PERFORMANCE_REPORT",
"path": "v201809.ADGROUP_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.AD_CUSTOMIZERS_FEED_ITEM_REPORT",
"path": "v201809.AD_CUSTOMIZERS_FEED_ITEM_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.AD_PERFORMANCE_REPORT",
"path": "v201809.AD_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
}
]
Um die Tabellenstruktur von Ihrem Werbetechniksystem aus zu überprüfen, führen Sie eine GET durch und geben Sie den Tabellenpfad als Abfrage-Parameter an.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parameter | Beschreibung |
---|---|
{BASE_CONNECTION_ID} |
Die Verbindungs-ID für Ihr Werbesystem. |
{TABLE_PATH} |
Der Pfad einer Tabelle in Ihrem Werbetext. |
Anfrage
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/2484f2df-c057-4ab5-84f2-dfc0577ab592/explore?objectType=table&object=v201809.AD_PERFORMANCE_REPORT' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Eine erfolgreiche Antwort gibt die Struktur einer Tabelle zurück. Details zu den einzelnen Spalten der Tabelle befinden sich innerhalb der Elemente des columns
-Arrays.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "CallOnlyPhoneNumber",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "AdGroupId",
"type": "long",
"xdm": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
}
},
{
"name": "AdGroupName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Date",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
]
}
}
Mit diesem Tutorial haben Sie Ihr Werbesystem erforscht, den Pfad der Tabelle gefunden, die Sie in Platform einbringen möchten, und erhalten Informationen über die Struktur. Sie können diese Informationen im nächsten Lernprogramm zu verwenden, um Daten aus Ihrem Werbetechniksystem zu erfassen und in Platform zu bringen.