Flow Service API を使用した HubSpot ベース接続の作成

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、Flow Service API を使用して、HubSpot のベース接続を作成する手順を説明します。

はじめに

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

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

次の節では、Flow Service APIを使用してHubSpotに正常に接続するために知っておく必要がある追加情報を示します。

必要な資格情報の収集

Flow ServiceがHubSpotと接続するには、次の接続プロパティを指定する必要があります。

資格情報
説明
clientId
HubSpot アプリケーションに関連付けられているクライアント ID。
clientSecret
HubSpot アプリケーションに関連付けられているクライアント秘密鍵。
accessToken
OAuth統合を最初に認証する際に取得されたアクセストークン。
refreshToken
OAuth統合を最初に認証する際に取得された更新トークン。
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 HubSpot の接続仕様 ID は cc6a4487-9e91-433e-a3a3-9cf6626c1806 です。

開始の詳細については、このHubSpot ドキュメント ​を参照してください。

Experience Platform APIの使用

Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。

ベース接続の作成

ベース接続は、ソースの認証情報、接続の現在の状態、一意のベース接続IDなど、ソースとExperience Platform間の情報を保持します。 ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

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

API 形式

POST /connections

リクエスト

次のリクエストは、HubSpot のベース接続を作成します。

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": "connection for HubSpot",
        "description": "connection for HubSpot",
        "auth": {
            "specName": "OAuth2 Refresh Code",
            "params": {
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }
プロパティ
説明
auth.params.clientId
HubSpot アプリケーションに関連付けられているクライアント ID。
auth.params.clientSecret
HubSpot アプリケーションに関連付けられているクライアント秘密鍵。
auth.params.accessToken
OAuth統合を最初に認証する際に取得されたアクセストークン。
auth.params.refreshToken
OAuth統合を最初に認証する際に取得された更新トークン。
connectionSpec.id
HubSpot接続仕様ID: cc6a4487-9e91-433e-a3a3-9cf6626c1806

応答

応答が成功すると、一意の接続識別子(id)を含む、新しく作成された接続が返されます。 このIDは、次のチュートリアルでデータを検索するために必要です。

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

ソース接続の作成

ソース接続は、接続ID、ソースデータの検索に必要な情報、接続仕様IDで構成されます。 Source接続は、ベース接続、ターゲット接続、マッピング IDと並行して使用され、データフローを作成します。

ソース接続を作成するには、Flow Service APIの/sourceConnections エンドポイントにPOST リクエストを行い、ベース接続IDと、取り込むHubSpot テーブルの名前を指定します。

API 形式

POST /sourceConnections

リクエスト

次のリクエストは、HubSpot のソース接続を作成します。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "HubSpot source connection",
        "baseConnectionId": "b4a738db-8696-4e2a-bf95-08d2927c911e",
        "description": "HubSpot source connection",
        "params": {
            "columns": [],
            "tableName": "CRM.Objects.Contacts"
        },
        "data": {
            "format": "tabular",
            "schema": null,
            "properties": null
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }'
プロパティ
説明
baseConnectionId
前の手順で作成したHubSpot ベース接続の一意の接続ID。
params.columns
Experience Platformに取り込むデータの特定のテーブル列。 すべての列を取り込むには、この値を空の配列のままにします。
params.tableName
取り込むHubSpot テーブルの名前(形式:<HubSpot Category>.<Sub Category>.<Object Name>)。 例:CRM.Commerce.Discounts
connectionSpec.id
HubSpot接続仕様ID: cc6a4487-9e91-433e-a3a3-9cf6626c1806

応答

応答が成功すると、一意の接続識別子(id)を含む、新しく作成されたソース接続が返されます。

{
    "id": "cbfd6fe0-0d1f-4c26-bd06-f00d1f4c26fc",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0001\""
}

次の手順

このチュートリアルに従って、Flow Service APIを使用してHubSpot ベース接続とソース接続を作成しました。 これらの接続IDは、次のチュートリアルで使用できます。

recommendation-more-help
experience-platform-help-sources