Ultimate

Skapa en Google PubSub Källanslutning med API:t för Flow Service

IMPORTANT
The Google PubSub Källan är tillgänglig i källkatalogen för användare som har köpt Real-time Customer Data Platform Ultimate.

I den här självstudiekursen får du hjälp med att koppla samman Google PubSub (nedan kalladPubSub") till Experience Platform med [Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/).

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter att data kan hämtas från olika källor samtidigt som du kan strukturera, märka och förbättra inkommande data med hjälp av plattformstjänster.
  • Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda plattformsinstans i separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna ansluta PubSub till plattform med Flow Service API.

Samla in nödvändiga inloggningsuppgifter

För att Flow Service för att ansluta till PubSubmåste du ange värden för följande anslutningsegenskaper:

Projektbaserad autentisering
table 0-row-2 1-row-2 2-row-2 3-row-2
Autentiseringsuppgifter Beskrivning
projectId Det projekt-ID som krävs för autentisering PubSub.
credentials Autentiseringsuppgifterna som krävs för autentisering PubSub. Du måste se till att du skickar den fullständiga JSON-filen när du har tagit bort blanktecknen från inloggningsuppgifterna.
connectionSpec.id Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer som är kopplade till att skapa bas- och källmålanslutningarna. The PubSub anslutningsspecifikation-ID: 70116022-a743-464a-bbfe-e226a7f8210c.
Ämnesbaserad och prenumerationsbaserad autentisering
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Autentiseringsuppgifter Beskrivning
credentials Autentiseringsuppgifterna som krävs för autentisering PubSub. Du måste se till att du skickar den fullständiga JSON-filen när du har tagit bort blanktecknen från inloggningsuppgifterna.
topicName Namnet på resursen som representerar en feed med meddelanden. Du måste ange ett ämnesnamn om du vill ge åtkomst till en viss dataström i ditt PubSub källa. Ämnesnamnets format är: projects/{PROJECT_ID}/topics/{TOPIC_ID}.
subscriptionName Namnet på PubSub prenumeration. I PubSubkan du få meddelanden genom att prenumerera på det ämne som meddelanden har publicerats i. Anteckning: En enda PubSub prenumerationen kan bara användas för ett dataflöde. Om du vill kunna skapa flera dataflöden måste du ha flera prenumerationer. Prenumerationens namnformat är: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_ID}.
connectionSpec.id Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer som är kopplade till att skapa bas- och källmålanslutningarna. The PubSub anslutningsspecifikation-ID: 70116022-a743-464a-bbfe-e226a7f8210c.

Mer information om dessa värden finns i PubSub autentisering -dokument. Om du vill använda tjänstkontobaserad autentisering läser du följande PubSub guide om hur du skapar tjänstkonton för steg om hur du genererar dina autentiseringsuppgifter.

TIP
Om du använder kontobaserad autentisering för tjänster måste du se till att du har beviljat tillräcklig användaråtkomst till ditt tjänstkonto och att det inte finns några extra tomrum i JSON när du kopierar och klistrar in dina autentiseringsuppgifter.

Använda plattforms-API:er

Mer information om hur du kan anropa API:er för plattformar finns i handboken komma igång med plattforms-API:er.

Skapa en basanslutning

TIP
När du har skapat en fil kan du inte ändra autentiseringstypen för en Google PubSub basanslutning. Om du vill ändra autentiseringstypen måste du skapa en ny basanslutning.

Det första steget i att skapa en källanslutning är att autentisera PubSub och generera ett anslutnings-ID. Med ett grundläggande anslutnings-ID kan du utforska och navigera bland filer inifrån källan och identifiera specifika objekt som du vill importera, inklusive information om deras datatyper och format.

Om du vill skapa ett basanslutnings-ID skickar du en POST till /connections slutpunkt när du ger PubSub autentiseringsuppgifter som en del av parametrarna för begäran.

The PubSub Med -källa kan du ange vilken typ av åtkomst du vill tillåta under autentiseringen. Du kan konfigurera ditt konto så att det har rotåtkomst eller begränsa åtkomsten till en viss PubSub ämne och prenumeration.

NOTE
Principal (roller) som tilldelats en PubSub -projektet ärvs i alla ämnen och prenumerationer som skapas i ett PubSub projekt. Om du vill att ett huvudämne (en roll) ska ha tillgång till ett visst ämne, måste det huvudämnet (rollen) också läggas till i ämnets motsvarande prenumeration. Mer information finns i [PubSub dokumentation om åtkomstkontroll] (https://cloud.google.com/pubsub/docs/access-control).

API-format

POST /connections
Projektbaserad autentisering

Om du vill skapa en grundläggande anslutning med projektbaserad autentisering skickar du en POST till /connections slutpunkt och ange projectId och credentials i begärandetexten.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.projectId Det projekt-ID som krävs för autentisering PubSub.
auth.params.credentials Autentiseringsuppgifter eller nyckel som krävs för autentisering PubSub.
connectionSpec.id The PubSub anslutningsspec-ID: 70116022-a743-464a-bbfe-e226a7f8210c.
accordion
svar

Ett godkänt svar returnerar information om den nya anslutningen, inklusive dess unika identifierare (id). Detta grundläggande anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Om du vill skapa en grundläggande anslutning med ämne- och prenumerationsbaserad autentisering skickar du en POST till /connections slutpunkt och ange credentials, topicNameoch subscriptionName i begärandetexten.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.credentials Autentiseringsuppgifter eller nyckel som krävs för autentisering PubSub.
auth.params.topicName Projekt-ID och ämne-ID-par för PubSub källa som du vill ge åtkomst till.
auth.params.subscriptionName Projekt-ID och prenumerations-ID-par för PubSub källa som du vill ge åtkomst till.
connectionSpec.id The PubSub anslutningsspec-ID: 70116022-a743-464a-bbfe-e226a7f8210c.
accordion
svar

Ett godkänt svar returnerar information om den nya anslutningen, inklusive dess unika identifierare (id). Detta grundläggande anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Skapa en källanslutning source

En källanslutning skapar och hanterar anslutningen till den externa källan som data importeras från. En källanslutning består av information som datakälla, dataformat och ett källanslutnings-ID som behövs för att skapa ett dataflöde. En källanslutningsinstans är specifik för en klientorganisation och organisation.

Om du vill skapa en källanslutning skickar du en POST till /sourceConnections slutpunkt för Flow Service API.

API-format

POST /sourceConnections

Begäran

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"
      }
  }'
Egenskap
Beskrivning
name
Namnet på källanslutningen. Kontrollera att namnet på källanslutningen är beskrivande, eftersom du kan använda det här för att söka efter information om källanslutningen.
description
Ett valfritt värde som du kan ange för att inkludera mer information om din källanslutning.
baseConnectionId
Basanslutnings-ID för din PubSub källa som genererades i föregående steg.
connectionSpec.id
ID för fast anslutningsspecifikation för PubSub. Detta ID är: 70116022-a743-464a-bbfe-e226a7f8210c
data.format
Formatet på PubSub data som du vill importera. För närvarande är det enda dataformatet som stöds json.
params.topicName
Namnet på PubSub ämne. I PubSubär ett ämne en namngiven resurs som representerar en feed med meddelanden.
params.subscriptionName
Prenumerationsnamnet som motsvarar ett visst ämne. I PubSubkan du läsa meddelanden från ett ämne. En eller flera prenumerationer kan tilldelas till ett enskilt ämne.
params.dataType
Den här parametern definierar vilken typ av data som importeras. Datatyper som stöds är: raw och xdm.

Svar

Ett godkänt svar returnerar den unika identifieraren (id) för den nyligen skapade källanslutningen. Detta ID krävs i nästa självstudie för att skapa ett dataflöde.

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

Nästa steg

Genom att följa den här självstudiekursen har du skapat en PubSub källanslutning med Flow Service API. Du kan använda det här källanslutnings-ID:t i nästa självstudie för att skapa ett direktuppspelat dataflöde med Flow Service API.

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