APIを使用して AzureFlow Service Data LakeストレージGen2コネクタを作成する

Flow Service は、Adobe Experience Platform内のさまざまな異なるソースから顧客データを収集し、一元化するために使用されます。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。

このチュートリアルでは、 Flow Service APIを使用して、 Experience Platform Data LakeストレージGen2(以下「ADLS Gen2」と呼ばれる) Azure に接続する手順を順を追って説明します。

はじめに

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

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

次の節では、 Flow Service APIを使用してADLS Gen2ソースコネクタを正しく作成するために知っておく必要がある追加情報について説明します。

必要な資格情報の収集

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

Credential 説明
url アドレスURL。
servicePrincipalId アプリケーションのクライアントID。
servicePrincipalKey アプリのキー。
tenant アプリケーションを含むテナント情報。

これらの値の詳細については、 このADLS Gen2ドキュメントを参照してください

API 呼び出し例の読み取り

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

All resources in Experience Platform, including those belonging to Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

接続の作成

接続は、ソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込むために複数のソースコネクタを作成する場合に使用できるため、ADLS Gen2アカウントごとに必要な接続は1つだけです。

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": "adls-gen2",
        "description": "Connection for adls-gen2",
        "auth": {
            "specName": "Basic Authentication for adls-gen2",
            "params": {
                "url": "{URL}",
                "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}",
                "tenant": "{TENANT}"
            }
        },
        "connectionSpec": {
            "id": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.url ADLS Gen2アカウントのURLエンドポイントです。
auth.params.servicePrincipalId ADLS Gen2アカウントのサービスプリンシパルID。
auth.params.servicePrincipalKey ADLS Gen2アカウントのサービスプリンシパルキーです。
auth.params.tenant ADLS Gen2アカウントのテナント情報。
connectionSpec.id ADLS Gen2接続仕様ID: 0ed90a81-07f4-4586-8190-b40eccef1c5a1.

応答

正常な応答は、新たに作成された接続の詳細(一意の識別子(id)を含む)を返します。 このIDは、次の手順でクラウドストレージを調査するために必要です。

{
    "id": "7497ad71-6d32-4973-97ad-716d32797304",
    "etag": "\"23005f80-0000-0200-0000-5e1d00a20000\""
}

次の手順

このチュートリアルに従って、APIを使用してADLS Gen2接続を作成し、一意のIDを応答本文の一部として取得しました。 この接続IDを使用して、Flow Service APIを使用してクラウドストレージを 調べたり、Flow Service APIを使用してパーケーデータを 取り込んだりできます

このページ