[Ultimate]{class="badge positive"}

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

IMPORTANT
Die Google PubSub -Quelle ist im Quellkatalog für Benutzer verfügbar, die Real-time Customer Data Platform Ultimate erworben haben.

Dieses Tutorial führt Sie durch die Schritte zum Verbinden Google PubSub (nachstehend „PubSub“ genannt) mit Experience Platform mithilfe der [Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/).

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

Sie müssen Werte für die unten beschriebenen Verbindungseigenschaften angeben, um Ihre PubSub -Konto Flow Service. Weitere Informationen zur Authentifizierung und zur Einrichtung der Voraussetzungen finden Sie im Abschnitt PubSub source Übersicht.

Projektbasierte Authentifizierung
table 0-row-2 1-row-2 2-row-2 3-row-2
Anmeldedaten Beschreibung
projectId Die zur Authentifizierung von PubSub erforderliche Projekt-ID.
credentials Die zum Authentifizieren erforderliche Berechtigung PubSub. Sie müssen sicherstellen, dass Sie die vollständige JSON-Datei platzieren, nachdem Sie die Leerzeichen aus Ihren Anmeldedaten entfernt haben.
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.
Themen- und Abonnement-basierte Authentifizierung
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Anmeldedaten Beschreibung
credentials Die zum Authentifizieren erforderliche Berechtigung PubSub. Sie müssen sicherstellen, dass Sie die vollständige JSON-Datei platzieren, nachdem Sie die Leerzeichen aus Ihren Anmeldedaten entfernt haben.
topicName Der Name der Ressource, die einen Feed von Nachrichten darstellt. Sie müssen einen Themennamen angeben, wenn Sie Zugriff auf einen bestimmten Datenstrom in Ihrer PubSub -Quelle. Das Format des Themennamens lautet: projects/{PROJECT_ID}/topics/{TOPIC_ID}.
subscriptionName Der Name Ihres PubSub Abonnement. In PubSub, können Sie über Abonnements Nachrichten empfangen, indem Sie sich für das Thema anmelden, in dem Nachrichten veröffentlicht wurden. Hinweis: Eine einzelne PubSub Abonnements können nur für einen Datenfluss verwendet werden. Um mehrere Datenflüsse erstellen zu können, müssen Sie über mehrere Abonnements verfügen. Das Format des Abonnementnamens lautet: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_ID}.
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 PubSub Authentifizierung Dokument. Informationen zur Verwendung der kontobasierten Dienstauthentifizierung finden Sie in diesem Abschnitt PubSub Handbuch zum Erstellen von Dienstkonten für Schritte zum Generieren Ihrer Anmeldedaten.

TIP
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

TIP
Nach der Erstellung können Sie den Authentifizierungstyp eines Google PubSub Basisverbindung. Um den Authentifizierungstyp zu ändern, müssen Sie eine neue Basisverbindung erstellen.

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.

Die PubSub -Quelle können Sie den Zugriffstyp angeben, den Sie während der Authentifizierung zulassen möchten. Sie können Ihr Konto so einrichten, dass es über Root-Zugriff verfügt oder den Zugriff auf eine bestimmte PubSub Thema und Abonnement.

NOTE
Prinzipal (Rollen), das einem PubSub -Projekt wird in allen Themen und Abonnements übernommen, die innerhalb eines PubSub Projekt. Wenn Sie möchten, dass ein Prinzipal (eine Rolle) Zugriff auf ein bestimmtes Thema hat, muss dieser Prinzipal (die Rolle) auch zum entsprechenden Abonnement des Themas hinzugefügt werden. Weitere Informationen finden Sie im Abschnitt [PubSub Dokumentation zur Zugriffskontrolle] (https://cloud.google.com/pubsub/docs/access-control).

API-Format

POST /connections
Projektbasierte Authentifizierung

Um eine Basisverbindung mit projektbasierter Authentifizierung zu erstellen, stellen Sie eine POST-Anfrage an die /connections -Endpunkt und geben Sie Ihre projectId und credentials im Anfrageinhalt.

accordion
Anfrage
code language-shell
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": "Project Based Authentication",
          "params": {
              "projectId": "{PROJECT_ID}",
              "credentials": "{CREDENTIALS}"
          }
      },
      "connectionSpec": {
          "id": "70116022-a743-464a-bbfe-e226a7f8210c",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2
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.
connectionSpec.id Die PubSub-Verbindungsspezifikations-ID: 70116022-a743-464a-bbfe-e226a7f8210c.
accordion
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.

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Themen- und Abonnement-basierte Authentifizierung

Wenn Sie eine Basisverbindung mit der themenbezogenen und Abonnement-basierten Authentifizierung erstellen möchten, stellen Sie eine POST-Anfrage an die /connections -Endpunkt und geben Sie Ihre credentials, topicName, und subscriptionName im Anfrageinhalt.

accordion
Anfrage
code language-shell
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": "Topic & Subscription Based Authentication",
          "params": {
              "credentials": "{CREDENTIALS}",
              "topicName": "projects/{PROJECT_ID}/topics/{TOPIC_ID}",
              "subscriptionName": "projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_ID}"
          }
      },
      "connectionSpec": {
          "id": "70116022-a743-464a-bbfe-e226a7f8210c",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Eigenschaft Beschreibung
auth.params.credentials Die zur Authentifizierung von PubSub erforderlichen Anmeldeinformationen bzw. der Schlüssel.
auth.params.topicName Projekt-ID und Themen-ID-Paar für die PubSub -Quelle, auf die Sie Zugriff gewähren möchten.
auth.params.subscriptionName Projekt-ID und Abonnement-ID-Paar für die PubSub -Quelle, auf die Sie Zugriff gewähren möchten.
connectionSpec.id Die PubSub-Verbindungsspezifikations-ID: 70116022-a743-464a-bbfe-e226a7f8210c.
accordion
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.

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

Erstellen einer Quellverbindung source

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": {
          "topicName": "projects/{PROJECT_ID}/topics/{TOPIC_ID}",
          "subscriptionName": "projects/{PROJECT_ID}/subscriptions/{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.topicName
Der Name Ihres PubSub Thema. In PubSub, ist ein Thema eine benannte Ressource, die einen Feed von Nachrichten darstellt.
params.subscriptionName
Der Abonnementname, der 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.

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