Die On-Demand-Erfassung befindet sich derzeit in der Beta-Phase und Ihr Unternehmen hat möglicherweise noch keinen Zugriff darauf. Die in dieser Dokumentation beschriebene Funktionalität kann sich ändern.
Flussläufe stellen eine Instanz der Flussausführung dar. Wenn beispielsweise ein Fluss planmäßig um 9:00 Uhr, 10:00 Uhr und 11:00 Uhr ausgeführt wird, haben Sie drei Instanzen eines Flusslaufs. Flussläufe sind spezifisch für Ihre jeweilige Organisation.
Die On-Demand-Erfassung bietet Ihnen die Möglichkeit, einen Fluss zu erstellen, der für einen bestimmten Datenfluss ausgeführt wird. Auf diese Weise können Ihre Benutzer einen Flusslauf erstellen, der auf den angegebenen Parametern basiert, und einen Erfassungszyklus ohne Service-Token erstellen. Die On-Demand-Erfassung wird nur für Batch-Quellen unterstützt.
In diesem Tutorial werden die Schritte zum Verwenden der On-Demand-Erfassung und zum Erstellen eines Flusslaufs mit dem Flow Service API.
Um einen Flusslauf zu erstellen, müssen Sie zunächst über die Fluss-ID eines Datenflusses verfügen, der für die einmalige Erfassung geplant ist.
Dieses Tutorial setzt ein Grundverständnis der folgenden Komponenten von Adobe Experience Platform voraus:
Informationen darüber, wie Sie Platform-APIs erfolgreich aufrufen können, finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.
Um einen Fluss für eine tabellenbasierte Quelle zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service API bei Angabe der Kennung des Flusses, für den Sie die Ausführung erstellen möchten, sowie der Werte für Start-, Endzeit- und Delta-Spalte.
Tabellenbasierte Quellen umfassen die folgenden Quellkategorien: Werbung, Analysen, Einverständnis und Präferenzen, CRMs, Kundenerfolg, Datenbank, Marketing-Automatisierung, Zahlungen und Protokolle.
API-Format
POST /runs/
Anfrage
Die folgende Anfrage erstellt einen Flusslauf für Fluss-ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de
.
Sie müssen nur die Variable deltaColumn
beim Erstellen des ersten Flusslaufs. Danach deltaColumn
wird als Teil von copy
Transformation im Fluss und wird als Quelle der Wahrheit behandelt. Alle Versuche, die deltaColumn
-Wert durch die Flusslaufparameter führt zu einem Fehler.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/runs' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json'
-d '{
"flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
"params": {
"startTime": "1663735590",
"windowStartTime": "1651584991",
"windowEndTime": "16515859567",
"deltaColumn": {
"name": "DOB"
}
}
}'
Parameter | Beschreibung |
---|---|
flowId |
Die ID des Flusses, mit dem der Fluss erstellt wird. |
params.startTime |
Eine Ganzzahl, die die Startzeit der Ausführung definiert. Der Wert wird in Unix Epochenzeit dargestellt. |
params.windowStartTime |
Eine Ganzzahl, die die Startzeit des Fensters definiert, während dem Daten abgerufen werden sollen. Der Wert wird in Unix-Zeit dargestellt. |
params.windowEndTime |
Eine Ganzzahl, die die Endzeit des Fensters definiert, während dem Daten abgerufen werden sollen. Der Wert wird in Unix-Zeit dargestellt. |
params.deltaColumn |
Die Delta-Spalte ist erforderlich, um die Daten zu partitionieren und neu aufgenommene Daten von historischen Daten zu trennen. Hinweis: Die deltaColumn wird nur bei der Erstellung des ersten Durchlaufs benötigt. |
params.deltaColumn.name |
Der Name der Delta-Spalte. |
Antwort
Eine erfolgreiche Antwort gibt die Details des neu erstellten Flusslaufs zurück, einschließlich der eindeutigen Ausführung id
.
{
"items": [
{
"id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
"etag": "\"1100c53e-0000-0200-0000-627138980000\""
}
]
}
Eigenschaft | Beschreibung |
---|---|
id |
Die ID des neu erstellten Flusslaufs. Siehe Handbuch unter Abruf-Flussspezifikationen für weitere Informationen zu tabellenbasierten Ausführungsspezifikationen. |
etag |
Die Ressourcenversion des Flusslaufs. |
Um einen Fluss für eine dateibasierte Quelle zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service API bei Angabe der Kennung des Workflows, für den Sie die Ausführung erstellen möchten, und der Werte für Start- und Endzeit.
Dateibasierte Quellen enthalten alle Cloud-Speicherquellen.
API-Format
POST /runs/
Anfrage
Die folgende Anfrage erstellt einen Flusslauf für Fluss-ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de
.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/runs' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json'
-d '{
"flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
"params": {
"startTime": "1663735590",
"windowStartTime": "1651584991",
"windowEndTime": "16515859567"
}
}'
Parameter | Beschreibung |
---|---|
flowId |
Die ID des Flusses, mit dem der Fluss erstellt wird. |
params.startTime |
Eine Ganzzahl, die die Startzeit der Ausführung definiert. Der Wert wird in Unix Epochenzeit dargestellt. |
params.windowStartTime |
Eine Ganzzahl, die die Startzeit des Fensters definiert, während dem Daten abgerufen werden sollen. Der Wert wird in Unix-Zeit dargestellt. |
params.windowEndTime |
Eine Ganzzahl, die die Endzeit des Fensters definiert, während dem Daten abgerufen werden sollen. Der Wert wird in Unix-Zeit dargestellt. |
Antwort
Eine erfolgreiche Antwort gibt die Details des neu erstellten Flusslaufs zurück, einschließlich der eindeutigen Ausführung id
.
{
"items": [
{
"id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
"etag": "\"1100c53e-0000-0200-0000-627138980000\""
}
]
}
Eigenschaft | Beschreibung |
---|---|
id |
Die ID des neu erstellten Flusslaufs. Siehe Handbuch unter Abruf-Flussspezifikationen für weitere Informationen zu tabellenbasierten Ausführungsspezifikationen. |
etag |
Die Ressourcenversion des Flusslaufs. |
Nach der Erstellung des Flusslaufs können Sie die erfassten Daten überwachen, um Informationen über die Durchlaufvorgänge, den Abschlussstatus und Fehler anzuzeigen. Informationen zum Überwachen Ihrer Flussläufe mithilfe der API finden Sie im Tutorial zu Überwachen von Datenflüssen in der API . Informationen zum Überwachen Ihrer Flussläufe mithilfe der Platform-Benutzeroberfläche finden Sie im Handbuch unter Überwachen von Datenflüssen zu Quellen mithilfe des Monitoring-Dashboards.