Crea un Google PubSub Connessione sorgente tramite l’API del servizio di flusso

NOTA

La Google PubSub connettore in versione beta. Consulta la sezione Panoramica delle origini per ulteriori informazioni sull’utilizzo dei connettori con etichetta beta.

Questa esercitazione descrive i passaggi per la connessione Google PubSub (in appresso denominato "PubSub") ad Experience Platform, utilizzando Flow Service API.

Introduzione

Questa guida richiede una buona comprensione dei seguenti componenti di Adobe Experience Platform:

  • Origini: L’Experience Platform consente di acquisire dati da varie sorgenti e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi correttamente PubSub su Platform utilizzando Flow Service API.

Raccogli credenziali richieste

Per Flow Service per connettersi a PubSub, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
projectId ID progetto necessario per l'autenticazione PubSub.
credentials Credenziale o chiave necessaria per l'autenticazione PubSub.
connectionSpec.id La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di destinazione di origine. La PubSub ID della specifica di connessione: 70116022-a743-464a-bbfe-e226a7f8210c.

Per ulteriori informazioni su questi valori, consulta PubSub autenticazione documento. Per utilizzare l'autenticazione basata sull'account del servizio, consulta PubSub guida alla creazione di account di servizio per i passaggi su come generare le credenziali.

SUGGERIMENTO

Se utilizzi l’autenticazione basata sull’account del servizio, assicurati di aver concesso un accesso utente sufficiente all’account del servizio e che non vi siano spazi bianchi aggiuntivi nel JSON durante la copia e l’incolla delle credenziali.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente le chiamate alle API di Platform, consulta la guida su guida introduttiva alle API di Platform.

Creare una connessione di base

Il primo passaggio nella creazione di una connessione sorgente è quello di autenticare il PubSub e genera un ID di connessione di base. Un ID di connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

Per creare un ID di connessione di base, invia una richiesta POST al /connections l'endpoint durante la fornitura del PubSub credenziali di autenticazione come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

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: {IMS_ORG}' \
    -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": "{PROJECT_ID}",
                "credentials": "{CREDENTIALS}"
            }
        },
        "connectionSpec": {
            "id": "70116022-a743-464a-bbfe-e226a7f8210c",
            "version": "1.0"
        }
    }'
Proprietà Descrizione
auth.params.projectId ID progetto necessario per l'autenticazione PubSub.
auth.params.credentials Credenziale o chiave necessaria per l'autenticazione PubSub.
connectionSpec.id La PubSub ID delle specifiche di connessione: 70116022-a743-464a-bbfe-e226a7f8210c.

Risposta

Una risposta corretta restituisce i dettagli della nuova connessione creata, incluso il relativo identificatore univoco (id). Questo ID di connessione di base è necessario nel passaggio successivo per creare una connessione di origine.

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

Creazione di una connessione sorgente

Una connessione di origine crea e gestisce la connessione all’origine esterna da cui vengono acquisiti i dati. Una connessione di origine è costituita da informazioni quali l’origine dati, il formato dati e un ID di connessione di origine necessari per creare un flusso di dati. Un’istanza di connessione di origine è specifica per un tenant e un’organizzazione IMS.

Per creare una connessione di origine, invia una richiesta POST al /sourceConnections punto finale Flow Service API.

Formato API

POST /sourceConnections

Richiesta

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: {IMS_Org}' \
    -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": "{TOPIC_ID}",
            "subscriptionId": "{SUBSCRIPTION_ID}",
            "dataType": "raw"
        }
    }'
Proprietà Descrizione
name Nome della connessione di origine. Assicurati che il nome della connessione sorgente sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione sorgente.
description Valore facoltativo che è possibile fornire per includere ulteriori informazioni sulla connessione sorgente.
baseConnectionId L'ID di connessione di base del PubSub origine generata nel passaggio precedente.
connectionSpec.id ID della specifica di connessione fissa per PubSub. Questo ID è: 70116022-a743-464a-bbfe-e226a7f8210c
data.format Il formato del PubSub dati da acquisire. Attualmente, l’unico formato di dati supportato è json.
params.topicId L’ID argomento definisce la risorsa specifica denominata i messaggi inviati dagli editori
params.subscriptionId L’ID sottoscrizione definisce la risorsa denominata specifica che rappresenta il flusso di messaggi da un singolo argomento specifico, da distribuire all’applicazione che si abbona.
params.dataType Questo parametro definisce il tipo di dati da acquisire. I tipi di dati supportati includono: raw e xdm.

Risposta

Una risposta corretta restituisce l'identificatore univoco (id) della nuova connessione sorgente creata. Questo ID è necessario nell’esercitazione successiva per creare un flusso di dati.

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

Passaggi successivi

Seguendo questa esercitazione, hai creato un PubSub connessione di origine tramite Flow Service API. Puoi usare questo ID di connessione sorgente nell’esercitazione successiva per creare un flusso di dati in streaming utilizzando Flow Service API.

In questa pagina