DokumentationExperience PlatformAnleitung zu Quell-Connectoren

Erstellen eines Flusslaufs für die On-Demand-Erfassung mithilfe der Flow Service-API

Last update: Wed Jul 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler

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 mithilfe der Flow Service API beschrieben.

Erste Schritte

NOTE
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:

  • Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.

Verwenden von Platform-APIs

Informationen darüber, wie Sie Platform-APIs erfolgreich aufrufen können, finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

Erstellen eines Flusslaufs für eine tabellenbasierte Quelle

Um einen Fluss für eine tabellenbasierte Quelle zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service -API und geben Sie dabei die Kennung des Flusses an, für den Sie die Ausführung erstellen möchten, sowie Werte für Start-, Endzeit- und Delta-Spalte.

TIP
Zu den tabellenbasierten Quellen gehören die folgenden Quellkategorien: Werbung, Analysen, Zustimmung und Voreinstellungen, CRMs, Kundenerfolg, Datenbank, Marketing-Automatisierung, Zahlungen und Protokolle.

API-Format

POST /runs/

Anfrage

Die folgende Anfrage erstellt einen Flusslauf für die Fluss-ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de.

NOTE
Sie müssen nur den Wert deltaColumn angeben, wenn Sie den ersten Flusslauf erstellen. Danach wird deltaColumn als Teil der copy-Transformation im Fluss gepatcht und als "Source of Truth"behandelt. Alle Versuche, den Wert deltaColumn durch die Ausführungsparameter des Flusses zu ändern, führen 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
Die geplante Zeit, zu der der On-Demand-Fluss beginnt. Dieser Wert wird in Unix-Zeit dargestellt.
params.windowStartTime
Das früheste Datum und die früheste Uhrzeit, aus der Daten abgerufen werden. Dieser Wert wird in Unix-Zeit dargestellt.
params.windowEndTime
Datum und Uhrzeit des Abrufs der Daten. Dieser 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: Der deltaColumn ist nur erforderlich, wenn Sie Ihren ersten Flusslauf erstellen.
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. Weitere Informationen zu tabellenbasierten Ausführungsspezifikationen finden Sie im Handbuch zum Abrufen von Flussspezifikationen .
etag
Die Ressourcenversion des Flusslaufs.

Erstellen eines Flusslaufs für eine dateibasierte Quelle

Um einen Fluss für eine dateibasierte Quelle zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service -API und geben Sie dabei die ID des Flusses an, für den Sie die Ausführung erstellen möchten, sowie die Werte für Start- und Endzeit.

TIP
Dateibasierte Quellen enthalten alle Cloud-Speicherquellen.

API-Format

POST /runs/

Anfrage

Die folgende Anfrage erstellt einen Flusslauf für die 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
Die geplante Zeit, zu der der On-Demand-Fluss beginnt. Dieser Wert wird in Unix-Zeit dargestellt.
params.windowStartTime
Das früheste Datum und die früheste Uhrzeit, aus der Daten abgerufen werden. Dieser Wert wird in Unix-Zeit dargestellt.
params.windowEndTime
Datum und Uhrzeit des Abrufs der Daten. Dieser 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. Weitere Informationen zu tabellenbasierten Ausführungsspezifikationen finden Sie im Handbuch zum Abrufen von Flussspezifikationen .
etag
Die Ressourcenversion des Flusslaufs.

Überwachen der Durchsatzabläufe

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 zum Überwachen von Datenflüssen in der API. Informationen zum Überwachen Ihrer Flussläufe mithilfe der Platform-Benutzeroberfläche finden Sie im Handbuch zum Überwachen von Datenflüssen für Quellen mithilfe des Monitoring-Dashboards.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089