このチュートリアルでは、 Flow Service API を使用して Google PubSub(以下「PubSub」)を Experience Platform に接続する手順を詳しく説明します。
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
以下の節では、Flow Service API を使用して PubSub を Platform に正しく接続するために必要な追加情報を示します。
Flow Service を PubSub に接続するには、次の接続プロパティの値を指定する必要があります。
資格情報 | 説明 |
---|---|
projectId |
PubSub の認証に必要なプロジェクト ID。 |
credentials |
PubSub の認証に必要な資格情報またはキー。 |
connectionSpec.id |
接続仕様は、ベース接続とソースターゲット接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。PubSub 接続仕様 ID は 70116022-a743-464a-bbfe-e226a7f8210c です。 |
これらの値について詳しくは、こちらの PubSub 認証に関するドキュメントを参照してください。サービスアカウントベースの認証を使用するには、こちらのPubSub サービスアカウントの作成に関するガイドで、資格情報の生成手順を確認してください。
サービスアカウントベースの認証を使用している場合は、サービスアカウントに十分なユーザーアクセス権が付与され、資格情報をコピー&ペーストする際に、JSON 内に余分な空白がないことを確認してください。
Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。
ソース接続を作成する最初の手順は、PubSub ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。
ベース接続 ID を作成するには、/connections
エンドポイントに対して POST リクエストを実行し、その際に 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: {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": "{PROJECT_ID}",
"credentials": "{CREDENTIALS}"
}
},
"connectionSpec": {
"id": "70116022-a743-464a-bbfe-e226a7f8210c",
"version": "1.0"
}
}'
プロパティ | 説明 |
---|---|
auth.params.projectId |
PubSub の認証に必要なプロジェクト ID。 |
auth.params.credentials |
PubSub の認証に必要な資格情報またはキー。 |
connectionSpec.id |
PubSub 接続仕様 ID:70116022-a743-464a-bbfe-e226a7f8210c 。 |
応答
リクエストが成功した場合は、一意の ID(id
)を含む、新しく作成した接続の詳細が返されます。このベース接続 ID は、次の手順でソース接続を作成する際に必要になります。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。ソース接続は、データソース、データ形式、データフローの作成に必要なソース接続 ID などの情報で構成されます。ソース接続インスタンスは、テナントと IMS 組織に固有です。
ソース接続を作成するには、Flow Service API の /sourceConnections
エンドポイントに POST リクエストを実行します。
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: {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": "{TOPIC_ID}",
"subscriptionId": "{SUBSCRIPTION_ID}",
"dataType": "raw"
}
}'
プロパティ | 説明 |
---|---|
name |
ソース接続の名前。 ソース接続の情報を検索する際に使用できるので、ソース接続の名前はわかりやすいものにしてください。 |
description |
指定するとソース接続に関する詳細情報を含めることができるオプションの値。 |
baseConnectionId |
前の手順で生成された PubSub ソースのベース接続 ID。 |
connectionSpec.id |
PubSub の固定接続仕様 ID。この ID は 70116022-a743-464a-bbfe-e226a7f8210c です。 |
data.format |
取り込む PubSub データの形式。現在、サポートされているデータ形式は json のみです。 |
params.topicId |
トピック ID は、メッセージがパブリッシャーから送信される特定の名前付きリソースを定義します |
params.subscriptionId |
サブスクリプション ID は、サブスクリプション登録しているアプリケーションに配信される、単一の特定のトピックからのメッセージストリームを表す特定の名前付きリソースを定義します。 |
params.dataType |
このパラメーターは、取り込まれるデータのタイプを定義します。raw および xdm を含むデータタイプがサポートされています。 |
応答
リクエストが成功した場合は、新しく作成されたソース接続の一意の ID(id
)が返されます。この ID は、次のチュートリアルでデータフローを作成する際に必要です。
{
"id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
"etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}
このチュートリアルでは、Flow Service API を使用して PubSub ソース接続を作成しました。次のチュートリアルでは、このソース接続 ID を使用して、 Flow Service API を使用したストリーミングデータフローの作成を行います。