Flow Service API を使用したデータセットの書き出し
- この機能は、Real-Time CDP Prime および Ultimate パッケージ、Adobe Journey OptimizerまたはCustomer Journey Analyticsを購入したお客様が利用できます。 詳しくは、Adobe担当者にお問い合わせください。
endTime
定日を設定するオプションが導入されました。 また、Adobeでは、(9 月のリリースより前に 作成されたすべてのデータセット書き出しデータフローのデフォルト終了日として、2025 年 5 月 1 日(PT が導入されます。 これらのデータフローのいずれについても、終了日より前にデータフローの終了日を手動で更新する必要があります。そうしないと、書き出しがその日に停止します。 Experience PlatformUI を使用して、5 月 1 日に停止に設定されるデータフローを確認します。endTime
定日を指定せずに作成したデータフローの場合、デフォルトでは作成時点から 6 か月後の終了時刻になります。この記事では、Flow Service API を使用して、Adobe Experience Platformから目的のクラウドストレージの場所(Amazon S3、SFTP の場所または Google Cloud Storage など 🔗 データセット を書き出すために必要なワークフローについて説明します。
書き出すことができるデータセット datasets-to-export
書き出し可能なデータセットは、Experience Platformアプリケーション(Real-Time CDP、Adobe Journey Optimizer)、層(Prime または Ultimate)、購入したアドオン(例:Data Distiller)によって異なります。
書き出し可能なデータセットについては、UI チュートリアルページの表を参照してください。
サポートされる宛先 supported-destinations
現在、スクリーンショットでハイライト表示され、以下に示されているクラウドストレージの宛先にデータセットを書き出すことができます。
はじめに get-started
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
- Experience Platform datasets:Adobe Experience Platformに正常に取り込まれたすべてのデータは、Data Lake 内にデータセットとして保持されます。 データセットは、通常、スキーマ(列)とフィールド(行)を含むテーブルであるデータコレクションのストレージと管理をおこなう構成体です。データセットには、保存するデータの様々な側面を記述したメタデータも含まれます。
- Sandboxes:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
以下の節では、Platform のクラウドストレージ宛先にデータセットを書き出すために知っておく必要がある追加情報を示します。
必要な権限 permissions
データセットを書き出すには、宛先の表示、データセットの表示 および データセットの宛先の管理とアクティブ化 アクセス制御権限が必要です。 必要な権限を取得するには、アクセス制御の概要を参照するか、製品管理者に問い合わせてください。
データセットの書き出しに必要な権限があることと、宛先でデータセットの書き出しがサポートされていることを確認するには、宛先カタログを参照します。 宛先に「アクティブ化」または「データセットを書き出し」コントロールがある場合、適切な権限を持っています。
API 呼び出し例の読み取り reading-sample-api-calls
このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーおよびオプションヘッダーの値の収集 gather-values-headers
Platform API を呼び出すには、まず Experience Platform認証チュートリアルを完了する必要があります。 次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
- Authorization: Bearer
{ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Experience Platform のリソースは、特定の仮想サンドボックスに分離できます。Platform API へのリクエストでは、操作を実行するサンドボックスの名前と ID を指定できます。次に、オプションのパラメーターを示します。
- x-sandbox-name:
{SANDBOX_NAME}
ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。
- Content-Type:
application/json
API リファレンスドキュメント api-reference-documentation
このチュートリアルに含まれるすべての API 操作について、付属リファレンスドキュメントが用意されています。Adobe Developer web サイト 🔗 で Flow Service - Destinations API ドキュメントを参照してください。 このチュートリアルと API リファレンスのドキュメントを並行して使用することをお勧めします。
用語集 glossary
この API チュートリアルで発生する用語については、API リファレンスドキュメントの 用語集の節を参照してください。
目的の宛先の接続仕様とフロー仕様を収集します gather-connection-spec-flow-spec
データセットの書き出しワークフローを開始する前に、データセットの書き出し先となる宛先の接続仕様およびフロー仕様 ID を特定します。 以下の表を参照してください。
4fce964d-3f37-408f-9778-e597338a21ee
269ba276-16fc-47db-92b0-c1049a3c131f
6d6b59bf-fb58-4107-9064-4d246c0e5bb2
95bd8965-fc8a-4119-b9c3-944c2c2df6d2
be2c3209-53bc-47e7-ab25-145db8b873e1
17be2013-2549-41ce-96e7-a70363bec293
10440537-2a7b-4583-ac39-ed38d4b848e8
cd2fc47e-e838-4f38-a581-8fff2f99b63a
c5d93acb-ea8b-4b14-8f53-02138444ae99
585c15c4-6cbf-4126-8f87-e26bff78b657
36965a81-b1c6-401b-99f8-22508f1e6a26
354d6aad-4754-46e4-a576-1b384561c440
様々な Flow Service エンティティを作成するには、これらの ID が必要です。 また、Flow Service APIs から Connection Spec ータを取得できるように、Connection Spec 自体の一部を参照して、特定のエンティティを設定する必要があります。 テーブル内のすべての宛先の接続仕様を取得する例を以下に示します。
リクエスト
accordion | ||
---|---|---|
Amazon S3 の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Amazon S3 – 接続仕様 | ||
|
リクエスト
accordion | ||
---|---|---|
Azure Blob Storage の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Azure Blob Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2 の connection spec の取得) | ||
|
応答
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Data Landing Zone(DLZ) の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Google Cloud Storage の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Google Cloud Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
SFTP の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
SFTP - Connection spec | ||
|
クラウドストレージの宛先へのデータセットデータフローを設定するには、次の手順に従います。 一部の手順では、リクエストと応答はクラウドストレージの様々な宛先間で異なります。 その場合、ページ上のタブを使用して、データセットの接続および書き出し先となる宛先に固有のリクエストと応答を取得します。 設定している宛先に適した connection spec と flow spec を使用してください。
データセットのリストの取得 retrieve-list-of-available-datasets
アクティベーションの対象となるデータセットのリストを取得するには、まず以下のエンドポイントに対して API 呼び出しを行います。
リクエスト
code language-shell |
---|
|
適格なデータセットを取得するには、リクエスト URL で使用される connection spec ID が Data Lake ソース接続仕様 ID の 23598e46-f560-407b-88d5-ea6207e49db0
である必要があり、outputField=datasets
と outputType=activationDatasets
の 2 つのクエリパラメーターを指定する必要があります。 その他のすべてのクエリパラメーターは、Catalog Service API でサポートされる標準のクエリパラメーターです。
応答
code language-json |
---|
|
成功した応答には、アクティブ化の対象となるデータセットのリストが含まれます。 これらのデータセットは、次の手順でソース接続を作成するときに使用できます。
返される各データセットの様々な応答パラメーターについて詳しくは、 データセット API 開発者向けドキュメントを参照してください。
ソース接続の作成 create-source-connection
書き出すデータセットのリストを取得したら、それらのデータセット ID を使用してソース接続を作成できます。
リクエスト
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
code language-shell line-numbers data-start-1 data-line-offset-4 h-12 h-16 |
---|
|
応答
code language-json |
---|
|
リクエストが成功した場合は、新しく作成したソース接続の ID (id
)と etag
が返されます。 後でデータフローを作成する際に必要になるので、ソース接続 ID をメモしておきます。
また、次の点にも注意してください。
- この手順で作成したソース接続は、そのデータセットが宛先に対してアクティブ化されるように、データフローにリンクされている必要があります。 ソース接続をデータフローにリンクする方法については、 データフローの作成の節を参照してください。
- 作成後にソース接続のデータセット ID を変更することはできません。 ソース接続にデータセットを追加または削除する必要がある場合は、新しいソース接続を作成し、新しいソース接続の ID をデータフローにリンクする必要があります。
(ターゲット)ベース接続の作成 create-base-connection
ベース接続は、資格情報を宛先に安全に保存します。 宛先のタイプによって、その宛先に対して認証するために必要な資格情報は異なる場合があります。 これらの認証パラメーターを見つけるには、 接続仕様とフロー仕様の収集の節で説明されているように、最初に目的の宛先の connection spec を取得し、次に応答の authSpec
を確認します。 サポートされているすべての宛先の authSpec
プロパティについては、以下のタブを参照してください。
accordion | ||
---|---|---|
auth spec を表示している Amazon S3 - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | ||
---|---|---|
auth spec を表示している Azure Blob Storage - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | ||
---|---|---|
auth spec を表示している Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | |||||
---|---|---|---|---|---|
auth spec を表示している Data Landing Zone(DLZ) - Connection spec | |||||
|
accordion | ||
---|---|---|
auth spec を表示している Google Cloud Storage - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | |||||
---|---|---|---|---|---|
SFTP - auth spec を表示する Connection spec | |||||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
認証仕様で指定されたプロパティ(つまり、応答からの authSpec
)を使用して、以下の例に示すように、各宛先タイプに固有の必要な資格情報を含むベース接続を作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Amazon S3 ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Azure Blob Storage - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone(DLZ) - ベース接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
Data Landing Zone - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Google Cloud Storage - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
パスワードを使用した SFTP - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
SSH キーを使用した SFTP - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
SFTP - ベース接続応答 | ||
|
応答からの接続 ID をメモしておきます。 この ID は、次の手順でターゲット接続を作成する際に必要になります。
ターゲット接続の作成 create-target-connection
次に、データセットの書き出しパラメーターを保存するターゲット接続を作成する必要があります。 書き出しパラメーターには、場所、ファイル形式、圧縮、その他の詳細が含まれます。 各宛先タイプでサポートされているプロパティについて理解するには、宛先の接続仕様に記載されている targetSpec
のプロパティを参照します。 サポートされているすべての宛先の targetSpec
プロパティについては、以下のタブを参照してください。
accordion | ||
---|---|---|
Amazon S3 - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Azure Blob Storage - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Google Cloud Storage - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
SFTP - ターゲット接続パラメーターを表示する Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 以下の例では、データセット書き出し宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
上記の仕様を使用すると、以下のタブに示すように、目的のクラウドストレージの宛先に固有のターゲット接続リクエストを作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
SFTP - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
応答からのターゲット接続 ID をメモします。 この ID は、次の手順で、データセットを書き出すデータフローを作成する際に必要になります。
データフローの作成 create-dataflow
宛先設定の最後の手順は、データフローを設定することです。 データフローは、以前に作成したエンティティを結び付け、データセット書き出しスケジュールを設定するためのオプションも提供します。 データフローを作成するには、目的のクラウドストレージの宛先に応じて以下のペイロードを使用し、前の手順で取得したエンティティ ID を置き換えます。
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
宛先へのデータセットデータフロー Amazon S3 作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
宛先へのデータセットデータフロー Azure Blob Storage 作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
宛先へのデータセットデータフロー Azure Data Lake Gen 2(ADLS Gen2) 作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
宛先へのデータセットデータフロー Data Landing Zone 作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
宛先へのデータセットデータフロー Google Cloud Storage 作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SFTP 宛先へのデータセットデータフローの作成 – リクエスト | ||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
次の表では、
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
応答のデータフロー ID をメモします。 この ID は、データフロー実行を取得して正常なデータセット書き出しを検証する次の手順で必要になります。
データフローの実行の取得 get-dataflow-runs
データフローの実行を確認するには、Dataflow Runs API を使用します。
リクエスト
データフロー実行を取得するリクエストで、データフローの作成時に前の手順で取得したデータフロー ID をクエリパラメーターとして追加します。
code language-shell |
---|
|
応答
code language-json |
---|
|
データフロー実行 API によって返される様々なパラメーターに関する情報については、API リファレンスドキュメントを参照してください。
データセットの正常な書き出しの確認 verify
データセットを書き出す際、Experience Platform は、指定されたストレージの場所に .json
または .parquet
ファイルを保存します。 データフローの作成時に指定した書き出しスケジュールに従って、新しいファイルがストレージの場所に格納されます。
Experience Platform は、指定されたストレージの場所にフォルダー構造を作成し、書き出されたデータセットファイルを格納します。 書き出しのたびに、次のパターンに従って新しいフォルダーが作成されます。
folder-name-you-provided/datasetID/exportTime=YYYYMMDDHHMM
デフォルトのファイル名はランダムに生成され、書き出されたファイルの名前は必ず一意になります。
サンプルデータセットファイル sample-files
これらのファイルがストレージの場所に存在すれば、書き出しは成功しています。書き出されたファイルの構造を理解するには、サンプルの .parquet ファイルまたは .json ファイルをダウンロードできます。
圧縮されたデータセットファイル compressed-dataset-files
ターゲット接続の作成手順では、圧縮する書き出したデータセットファイルを選択できます。
2 つのファイルタイプを圧縮した場合、ファイル形式に違いがあることに注意してください。
- 圧縮された JSON ファイルを書き出す場合、書き出されるファイルの形式は
json.gz
です - 圧縮 Parquet ファイルをエクスポートする場合、エクスポートされるファイル形式は
gz.parquet
です - JSON ファイルは、圧縮モードでのみ書き出すことができます。
API エラー処理 api-error-handling
このチュートリアルの API エンドポイントは、一般的なExperience PlatformAPI エラーメッセージの原則に従っています。 エラー応答の解釈について詳しくは、Platform トラブルシューティングガイドの API ステータスコードおよび リクエストヘッダーエラーを参照してください。
よくある質問 faq
データセットの書き出しに関する よくある質問のリストを表示します。
次の手順 next-steps
このチュートリアルでは、目的のクラウドストレージのバッチ宛先の 1 つに Platform を正常に接続し、データセットを書き出す各宛先へのデータフローを設定しました。 次のページでは、Flow Service API を使用した既存のデータフローの編集方法などの詳細を確認します。