の作成 Google PubSub フローサービス API を使用したソース接続

メモ

この Google PubSub コネクタはベータ版です。 詳しくは、 ソースの概要 ベータ版のコネクタの使用に関する詳細

このチュートリアルでは、接続の手順について説明します Google PubSub (以下「」という。)PubSub") をExperience Platform、 Flow Service API.

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。

  • ソース:Experience Platformを使用すると、様々なソースからデータを取り込みながら、Platform サービスを使用して、受信データの構造化、ラベル付け、拡張をおこなうことができます。
  • サンドボックス:Experience Platform は、単一の Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展を支援する仮想サンドボックスを提供します。

次の節では、接続を成功させるために知っておく必要がある追加情報を示します PubSub を使用して Platform に Flow Service API

必要な資格情報の収集

次のために Flow Service 接続する PubSubを使用する場合、次の接続プロパティの値を指定する必要があります。

資格情報 説明
projectId 認証に必要なプロジェクト ID PubSub.
credentials 認証に必要な資格情報またはキー PubSub.
connectionSpec.id 接続仕様は、ベース接続とソースターゲット接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。 この PubSub 接続仕様 ID: 70116022-a743-464a-bbfe-e226a7f8210c.

これらの値について詳しくは、 PubSub 認証 文書。 サービスアカウントベースの認証を使用するには、次を参照してください PubSub サービスアカウント作成のガイド 資格情報の生成手順については、を参照してください。

ヒント

サービスアカウントベースの認証を使用している場合は、資格情報をコピー&ペーストする際に、サービスアカウントへの十分なユーザーアクセス権が付与され、JSON に余分な空白がないことを確認します。

Platform API の使用

Platform API への呼び出しを正常に実行する方法について詳しくは、 Platform API の概要.

ベース接続を作成する

ソース接続を作成する最初の手順は、 PubSub ソースおよびベース接続 ID を生成します。 ベース接続 ID を使用すると、ソース内からファイルを参照および移動し、取り込む特定の項目(データのタイプや形式に関する情報を含む)を識別できます。

ベース接続 ID を作成するには、 /connections エンドポイントを PubSub 認証資格情報をリクエストパラメーターの一部として使用します。

API 形式

POST /connections

リクエスト

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"
        }
    }'
プロパティ 説明
auth.params.projectId 認証に必要なプロジェクト ID PubSub.
auth.params.credentials 認証に必要な資格情報またはキー PubSub.
connectionSpec.id この PubSub 接続仕様 ID : 70116022-a743-464a-bbfe-e226a7f8210c.

応答

正常な応答は、新しく作成された接続の詳細 ( 一意の識別子 (id) をクリックします。 このベース接続 ID は、次の手順でソース接続を作成する際に必要になります。

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

ソース接続の作成

ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。 ソース接続は、データソース、データ形式、データフローの作成に必要なソース接続 ID などの情報で構成されます。 ソース接続インスタンスは、テナントと IMS 組織に固有です。

ソース接続を作成するには、 /sourceConnections エンドポイント Flow Service API

API 形式

POST /sourceConnections

リクエスト

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"
        }
    }'
プロパティ 説明
name ソース接続の名前。 ソース接続の情報を検索する際に使用できるので、ソース接続の名前がわかりやすい名前になっていることを確認します。
description ソース接続に関する詳細情報を含めるために指定できるオプションの値です。
baseConnectionId のベース接続 ID PubSub 前の手順で生成されたソース。
connectionSpec.id の固定接続仕様 ID PubSub. この ID は次のとおりです。 70116022-a743-464a-bbfe-e226a7f8210c
data.format の形式 PubSub 取り込むデータ。 現在、サポートされているデータ形式は次のみです。 json.
params.topicId トピック ID は、パブリッシャーから送信されるメッセージの特定の名前付きリソースを定義します
params.subscriptionId 購読 ID は、購読アプリケーションに配信される単一の特定のトピックからのメッセージストリームを表す特定の名前付きリソースを定義します。
params.dataType このパラメーターは、取り込まれるデータのタイプを定義します。 次のようなデータタイプがサポートされています。 raw および xdm.

応答

正常な応答は、一意の識別子 (id) に含まれます。 この ID は、次のチュートリアルでデータフローを作成する際に必要です。

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

次の手順

このチュートリアルに従って、 PubSub を使用したソース接続 Flow Service API 次のチュートリアルでは、このソース接続 ID を使用して、 を使用してストリーミングデータフローを作成する Flow Service API.

このページ