Flow Service APIを使用したデータセットのエクスポート
- この機能は、Real-Time CDP PrimeおよびUltimate パッケージ、Adobe Journey Optimizer、またはCustomer Journey Analyticsを購入したお客様が利用できます。 詳しくは、アドビ担当者にお問い合わせください。
endTimeAdobeでは、2024年9月リリース より前に作成されたすべてのデータセット書き出しデータフローについて、2025年9月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
現在、スクリーンショットで強調表示され、以下に示すクラウドストレージの宛先にデータセットを書き出すことができます。
前提条件 prerequisites
データセットを書き出すには、次の前提条件に注意してください。
- データセットをクラウドストレージ宛先に書き出すには、正常に宛先に接続されている必要があります。まだ接続していない場合は、宛先カタログに移動し、サポートされている宛先を参照し、使用する宛先を設定します。
- リアルタイム顧客プロファイルで使用するには、プロファイルデータセットを有効にする必要があります。 このオプションを有効にする方法について詳細を読む。
はじめに get-started
このガイドでは、Adobe Experience Platformの次のコンポーネントについて実際に理解する必要があります。
- Experience Platform datasets: Adobe Experience Platformに正常に取り込まれたすべてのデータは、データセットとしてData Lake内に保持されます。 データセットは、スキーマ(列)とフィールド(行)で構成されるデータコレクション(通常はテーブル)を格納し管理するための構造です。データセットには、保存するデータの様々な側面を記述したメタデータも含まれます。
- Sandboxes:Experience Platform には、単一の Experience Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
次の節では、Experience Platformでデータセットをクラウドストレージの宛先に書き出すために知っておく必要がある追加情報を提供します。
必要な権限 permissions
データセットをエクスポートするには、View Destinations、View DatasetsおよびManage and Activate Dataset Destinations アクセス制御権限が必要です。 必要な権限を取得するには、アクセス制御の概要を参照するか、製品管理者に問い合わせてください。
データセットの書き出しに必要な権限があることと、宛先でデータセットの書き出しがサポートされていることを確認するには、宛先カタログを参照します。 宛先に Activate またはExport datasets コントロールがある場合は、適切な権限を持っています。
API 呼び出し例の読み取り reading-sample-api-calls
このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーおよびオプションヘッダーの値の収集 gather-values-headers
Experience 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 のリソースは、特定の仮想サンドボックスに分離できます。Experience 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-e597338a21ee269ba276-16fc-47db-92b0-c1049a3c131f6d6b59bf-fb58-4107-9064-4d246c0e5bb295bd8965-fc8a-4119-b9c3-944c2c2df6d2be2c3209-53bc-47e7-ab25-145db8b873e117be2013-2549-41ce-96e7-a70363bec29310440537-2a7b-4583-ac39-ed38d4b848e8cd2fc47e-e838-4f38-a581-8fff2f99b63ac5d93acb-ea8b-4b14-8f53-02138444ae99585c15c4-6cbf-4126-8f87-e26bff78b65736965a81-b1c6-401b-99f8-22508f1e6a26354d6aad-4754-46e4-a576-1b384561c440様々なFlow Service エンティティを構築するには、これらのIDが必要です。 Connection SpecからConnection Specを取得できるように、特定のエンティティを設定するためにFlow Service APIs自体の一部を参照する必要もあります。 以下の例では、テーブル内のすべての宛先の接続仕様を取得しています。
リクエスト
| accordion | ||
|---|---|---|
| connection specのAmazon S3を取得 | ||
|
応答
| accordion | ||
|---|---|---|
| Amazon S3 – 接続仕様 | ||
|
リクエスト
| accordion | ||
|---|---|---|
| connection specのAzure Blob Storageを取得 | ||
|
応答
| accordion | ||
|---|---|---|
| Azure Blob Storage - Connection spec | ||
|
リクエスト
| accordion | ||
|---|---|---|
| connection specのAzure Data Lake Gen 2(ADLS Gen2を取得) | ||
|
応答
| accordion | ||
|---|---|---|
| Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
|
リクエスト
| accordion | ||
|---|---|---|
| connection specのData Landing Zone(DLZ)を取得 | ||
|
応答
| accordion | ||
|---|---|---|
| Data Landing Zone(DLZ) - Connection spec | ||
|
リクエスト
| accordion | ||
|---|---|---|
| connection specのGoogle Cloud Storageを取得 | ||
|
応答
| accordion | ||
|---|---|---|
| Google Cloud Storage - Connection spec | ||
|
リクエスト
| accordion | ||
|---|---|---|
| SFTP用にconnection specを取得 | ||
|
応答
| accordion | ||
|---|---|---|
| SFTP - Connection spec | ||
|
クラウドストレージ宛先へのデータセットデータフローを設定するには、次の手順に従います。 一部の手順では、様々なクラウドストレージの宛先間でリクエストと応答が異なります。 そのような場合は、ページ上のタブを使用して、データセットを接続して書き出す宛先に固有のリクエストと応答を取得します。 設定する宛先に対して、正しいconnection specとflow specを使用してください。
データセットのリストの取得 retrieve-list-of-available-datasets
データセットの書き出しワークフローの手順1を示す
アクティベーションの対象となるデータセットのリストを取得するには、まず、以下のエンドポイントにAPI呼び出しを行います。
リクエスト
| code language-shell |
|---|
|
適格なデータセットを取得するには、リクエスト URLで使用されるconnection spec IDがデータレイクソース接続仕様ID、23598e46-f560-407b-88d5-ea6207e49db0である必要があり、2つのクエリパラメーターoutputField=datasetsとoutputType=activationDatasetsを指定する必要があります。 その他のすべてのクエリパラメーターは、 カタログサービス APIでサポートされている標準のクエリパラメーターです。
応答
| code language-json |
|---|
|
応答が成功すると、アクティベーションの対象となるデータセットのリストが含まれます。 これらのデータセットは、次の手順でソース接続を構築する際に使用できます。
返される各データセットの様々な応答パラメーターについて詳しくは、 データセット API開発者ドキュメント を参照してください。
ソース接続の作成 create-source-connection
データセットの書き出しワークフローの手順2を示す
書き出すデータセットのリストを取得した後、これらのデータセット 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
データセットの書き出しワークフローの手順3を示す
ベース接続は、資格情報を宛先に安全に保存します。 宛先のタイプに応じて、その宛先に対して認証するために必要な資格情報は異なる場合があります。 これらの認証パラメーターを見つけるには、connection spec接続仕様とフロー仕様の節で説明されているように、まず目的の宛先のを取得し、応答のauthSpecを確認します。 サポートされているすべての宛先のauthSpec プロパティについては、以下のタブを参照してください。
| accordion | ||
|---|---|---|
| Amazon S3 - Connection specにauth specが表示されています | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。この行は、connection specの認証パラメーターの検索場所に関する追加情報を提供します。
|
| accordion | ||
|---|---|---|
| Azure Blob Storage - Connection specにauth specが表示されています | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。この行は、connection specの認証パラメーターの検索場所に関する追加情報を提供します。
|
| accordion | ||
|---|---|---|
| Azure Data Lake Gen 2(ADLS Gen2) - Connection specにauth specが表示されています | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。この行は、connection specの認証パラメーターの検索場所に関する追加情報を提供します。
|
| accordion | |||||
|---|---|---|---|---|---|
| Data Landing Zone(DLZ) - Connection specにauth specが表示されています | |||||
|
| accordion | ||
|---|---|---|
| Google Cloud Storage - Connection specにauth specが表示されています | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。この行は、connection specの認証パラメーターの検索場所に関する追加情報を提供します。
|
| accordion | |||||
|---|---|---|---|---|---|
| SFTP - Connection spec (auth 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
データセットの書き出しワークフローの手順4を示す
次に、データセットの書き出しパラメーターを格納するターゲット接続を作成する必要があります。 エクスポートパラメーターには、場所、ファイル形式、圧縮などの詳細が含まれます。 宛先の接続仕様で提供されているtargetSpec プロパティを参照して、各宛先タイプでサポートされているプロパティを確認してください。 サポートされているすべての宛先のtargetSpec プロパティについては、以下のタブを参照してください。
| accordion | ||
|---|---|---|
| ターゲット接続パラメーターを示すAmazon S3 ~ Connection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
| accordion | ||
|---|---|---|
| ターゲット接続パラメーターを示すAzure Blob Storage ~ Connection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
| accordion | ||
|---|---|---|
| ターゲット接続パラメーターを示すAzure Data Lake Gen 2(ADLS Gen2) ~ Connection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
| accordion | ||
|---|---|---|
| ターゲット接続パラメーターを示すData Landing Zone(DLZ) ~ Connection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
| accordion | ||
|---|---|---|
| ターゲット接続パラメーターを示すGoogle Cloud Storage ~ Connection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
| accordion | ||
|---|---|---|
| SFTP - ターゲット接続パラメーターを示すConnection spec | ||
|
以下のconnection spec例のインラインコメントを含む強調表示された行に注意してください。これにより、接続仕様のtarget spec パラメーターの検索場所に関する追加情報が提供されます。 以下の例では、データセットの書き出し先に適用できるターゲットパラメーターが not であることも確認できます。
|
上記の仕様を使用すると、以下のタブに示すように、目的のクラウドストレージ宛先に固有のターゲット接続リクエストを作成できます。
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| Amazon S3 - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| ターゲット接続 – 応答 | ||
|
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| Azure Blob Storage - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| ターゲット接続 – 応答 | ||
|
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| Azure Blob Storage - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| ターゲット接続 – 応答 | ||
|
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| Data Landing Zone - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| ターゲット接続 – 応答 | ||
|
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| Google Cloud Storage - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| ターゲット接続 – 応答 | ||
|
リクエスト
| accordion | |||||
|---|---|---|---|---|---|
| SFTP - Target接続リクエスト | |||||
リクエストサンプルのインラインコメントを含むハイライト表示された行に注意してください。これにより、追加情報が提供されます。 リクエストを任意の端末にコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
| accordion | ||
|---|---|---|
| Target接続 – 応答 | ||
|
応答のTarget接続IDをメモします。 このIDは、データセットを書き出すデータフローを作成する際に、次の手順で必要になります。
データフローの作成 create-dataflow
データセットの書き出しワークフローの手順5を示す
宛先設定の最後の手順は、データフローを設定することです。 データフローは、以前に作成したエンティティを結びつけ、データセット書き出しスケジュールを設定するためのオプションも提供します。 データフローを作成するには、目的のクラウドストレージの宛先に応じて、以下のペイロードを使用し、以前の手順で作成したエンティティ 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
データセットの書き出しワークフローの手順6を示す
データフローの実行を確認するには、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 Platform API エラーメッセージの原則に従っています。 エラー応答の解釈について詳しくは、Experience Platform トラブルシューティングガイドのAPI ステータスコード および リクエストヘッダーエラーを参照してください。
既知の制限事項 known-limitations
データセットの書き出しに関する既知の制限事項を表示します。
よくある質問 faq
データセットの書き出しに関するよくある質問のリストを表示します。
次の手順 next-steps
Experience Platformを任意のバッチクラウドストレージの宛先に正常に接続し、データセットを書き出すために各宛先にデータフローを設定しました。 次のページでは、Flow Service API を使用した既存のデータフローの編集方法などの詳細を確認します。