Erstellen einer Google PubSub-Quellverbindung mithilfe der Flow Service-API

Dieses Tutorial führt Sie durch die Schritte zum Verbinden Google PubSub (nachstehend „PubSub“ genannt) mit Experience Platform mithilfe der Flow Service API.

Erste Schritte

Dieses Handbuch setzt ein Verstä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.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um PubSub mithilfe der Flow Service-API erfolgreich mit Platform verbinden zu können.

Sammeln erforderlicher Anmeldeinformationen

Um Flow Service mit PubSub zu verbinden, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Anmeldedaten Beschreibung
projectId Die zur Authentifizierung von PubSub erforderliche Projekt-ID.
credentials Die zur Authentifizierung von PubSub erforderlichen Anmeldeinformationen bzw. der Schlüssel.
topicId Die ID für die PubSub -Ressource, die einen Feed von Nachrichten darstellt. Sie müssen eine Themen-ID angeben, wenn Sie Zugriff auf einen bestimmten Datenstrom in Ihrer Google PubSub -Quelle.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich Authentifizierungsspezifikationen im Zusammenhang mit der Erstellung der Basis- und Quell-Target-Verbindungen. Die Spezifikations-ID der PubSub-Verbindung lautet: 70116022-a743-464a-bbfe-e226a7f8210c.

Weitere Informationen zu diesen Werten finden Sie in diesem Dokument zur PubSub Authentifizierung. Informationen zur Verwendung der auf Service-Konten basierenden Authentifizierung finden Sie in diesem PubSub Handbuch zum Erstellen von Service-Konten in den Schritten zum Erstellen von Anmeldedaten.

TIPP

Wenn Sie die auf Service-Konten basierende Authentifizierung verwenden, stellen Sie sicher, dass Sie einen ausreichenden Benutzerzugriff auf Ihr Service-Konto gewährt haben und dass in JSON keine zusätzlichen Leerzeichen vorhanden sind, wenn Sie Ihre Anmeldeinformationen kopieren und einfügen.

Verwenden von Platform-APIs

Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

Erstellen einer Basisverbindung

Der erste Schritt beim Erstellen einer Quellverbindung besteht darin, Ihre PubSub-Quelle zu authentifizieren und eine Basisverbindungs-ID zu generieren. Mittels einer Basisverbindungs-ID können Sie Dateien aus Ihrer Quelle durchsuchen, zwischen Dateien innerhalb der Quelle navigieren und bestimmte Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu Datentypen und Formaten.

Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den /connections-Endpunkt beim Bereitstellen der PubSub-Authentifizierungsberechtigungsdaten als Teil der Anfrageparameter.

In diesem Schritt können Sie die Daten definieren, auf die Ihr Konto Zugriff hat, indem Sie eine Themen-ID angeben. Nur die mit dieser Themen-ID verknüpften Abonnements sind verfügbar.

HINWEIS

einem öffentlichen Projekt zugewiesene Prinzipale (Rollen) werden in allen Themen und Abonnements übernommen, die innerhalb eines PubSub Projekt. Wenn Sie einen Prinzipal (eine Rolle) hinzufügen möchten, um Zugriff auf ein bestimmtes Thema zu erhalten, muss dieser Prinzipal (die Rolle) auch zum entsprechenden Abonnement des Themas hinzugefügt werden. Weitere Informationen finden Sie im Abschnitt PubSub Dokumentation zur Zugriffskontrolle.

API-Format

POST /connections

Anfrage

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -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 '{
      "name": "Google PubSub connection",
      "description": "Google PubSub connection",
      "auth": {
          "specName": "Google PubSub authentication credentials",
          "params": {
              "projectId": "acme-project",
              "credentials": "{CREDENTIALS}",
              "topicID": "acmeProjectAPI"
          }
      },
      "connectionSpec": {
          "id": "70116022-a743-464a-bbfe-e226a7f8210c",
          "version": "1.0"
      }
  }'
Eigenschaft Beschreibung
auth.params.projectId Die zur Authentifizierung von PubSub erforderliche Projekt-ID.
auth.params.credentials Die zur Authentifizierung von PubSub erforderlichen Anmeldeinformationen bzw. der Schlüssel.
auth.params.topicID Die Themen-ID Ihrer PubSub -Quelle, auf die Sie Zugriff gewähren möchten.
connectionSpec.id Die PubSub-Verbindungsspezifikations-ID: 70116022-a743-464a-bbfe-e226a7f8210c.

Antwort

Eine erfolgreiche Antwort gibt Details der neu erstellten Verbindung zurück, einschließlich ihrer eindeutigen Kennung (id). Diese Basisverbindungs-ID wird im nächsten Schritt benötigt, um eine Quellverbindung zu erstellen.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Erstellen einer Quellverbindung

Eine Quellverbindung erstellt und verwaltet die Verbindung zu der externen Quelle, aus der Daten erfasst werden. Eine Quellverbindung besteht aus Informationen wie Datenquelle, Datenformat und einer Quell-Verbindungs-ID, die zum Erzeugen eines Datenflusses erforderlich sind. Eine Quellverbindungsinstanz ist für einen Mandanten und eine Organisation spezifisch.

Um eine Quellverbindung zu erstellen, stellen Sie eine POST-Anfrage an den /sourceConnections-Endpunkt der Flow Service-API.

API-Format

POST /sourceConnections

Anfrage

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -H 'authorization: Bearer {ACCESS_TOKEN}' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
      "name": "Google PubSub source connection",
      "description": "A source connection for Google PubSub",
      "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
      "connectionSpec": {
          "id": "70116022-a743-464a-bbfe-e226a7f8210c",
          "version": "1.0"
      },
      "data": {
          "format": "json"
      },
      "params": {
          "topicId": "acme-project",
          "subscriptionId": "{SUBSCRIPTION_ID}",
          "dataType": "raw"
      }
  }'
Eigenschaft Beschreibung
name Der Name Ihrer Quellverbindung. Stellen Sie sicher, dass der Name Ihrer Quellverbindung beschreibend ist, da Sie damit Informationen zu Ihrer Quellverbindung nachschlagen können.
description Ein optionaler Wert, den Sie angeben können, um weitere Informationen zu Ihrer Quellverbindung einzuschließen.
baseConnectionId Die ID der Basisverbindung Ihrer PubSub-Quelle, die im vorhergehenden Schritt generiert wurde.
connectionSpec.id Die feste Verbindungsspezifikations-ID für PubSub. Diese ID lautet: 70116022-a743-464a-bbfe-e226a7f8210c
data.format Das Format der PubSub-Daten, die Sie aufnehmen möchten. Derzeit wird nur das Datenformat json unterstützt.
params.topicId Der Name oder die ID Ihrer PubSub Thema. In PubSub, ist ein Thema eine benannte Ressource, die einen Feed von Nachrichten darstellt.
params.subscriptionId Die Anmelde-ID, die einem bestimmten Thema entspricht. In PubSub, können Sie mit Abonnements Nachrichten aus einem Thema lesen. Einem Thema können ein oder mehrere Abonnements zugewiesen werden.
params.dataType Dieser Parameter definiert den Typ der aufgenommenen Daten. Zu den unterstützten Datentypen gehören: raw und xdm.

Antwort

Eine erfolgreiche Antwort gibt die eindeutige Kennung (id) der neu erstellten Quellverbindung zurück. Diese ID ist im nächsten Tutorial zum Erstellen eines Datenflusses erforderlich.

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine PubSub-Quellverbindung mithilfe der Flow Service-API erstellt. Sie können diese Quellverbindungs-ID im nächsten Tutorial verwenden, um einen Streaming-Datenfluss mit der Flow Service -API zu erstellen.

Auf dieser Seite