このドキュメントでは、バッチ取得 API の使用に関する包括的な概要を説明します。
このドキュメントの付録では、CSV 例や JSON データファイル例など、取得に使用するデータの形式設定に関する情報を提供します。
データ取得では、RESTful API を使用して、サポートされるオブジェクトタイプに対して基本的な CRUD 操作を実行できます。
次の節では、バッチ取得 API を正しく呼び出すために知っておく必要がある、または手元に置く必要がある追加情報を示します。
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。これには、パス、必須ヘッダー、適切に書式設定されたリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform
Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Experience Platform内のすべてのリソースは、特定の仮想サンドボックスに分離されています。 Platform APIへのすべてのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。
x-sandbox-name: {SANDBOX_NAME}
Platformのサンドボックスについて詳しくは、サンドボックスの概要ドキュメントを参照してください。
ペイロード(POST、PUT、PATCH)を含むリクエストには、追加の Content-Type
ヘッダーが必要な場合があります。各呼び出しに固有の受け入れられた値は、呼び出しパラメーターで提供されます。
データを取り込む際には、Experience Data Model (XDM)スキーマの動作を理解することが重要です。 XDM のフィールドタイプを様々な形式にマップする方法について詳しくは、『スキーマレジストリ開発者ガイド』を参照してください。
データ取得には柔軟性があります。ターゲットスキーマ内のデータとタイプが一致しない場合、データは表現されたターゲットタイプに変換されます。 できない場合は、バッチが TypeCompatibilityException
で失敗します。
例えば、JSON も CSV も日付や時刻のタイプを持ちません。その結果、これらの値は ISO 8061 形式の文字列(「2018-07-10T15:05:59.000-08:00」)または Unix 時間形式のミリ秒(1531263959000)を使用して表され、取得時にターゲット XDM タイプに変換されます。
次の表に、データの取得時にサポートされる変換を示します。
受信(行)とターゲット(列) | String | Byte | Short | Integer | Long | Double | Date | Date-Time | Object | Map |
---|---|---|---|---|---|---|---|---|---|---|
文字列 | X | X | X | X | X | X | X | X | ||
バイト | X | X | X | X | X | X | ||||
Short | X | X | X | X | X | X | ||||
整数 | X | X | X | X | X | X | ||||
ロング | X | X | X | X | X | X | X | X | ||
重複 | X | X | X | X | X | X | ||||
日付 | X | |||||||||
日時 | X | |||||||||
オブジェクト | X | X | ||||||||
マップ | X | X |
ブール値と配列は他の型に変換できません。
バッチデータ取得には、いくつかの制約があります。
次の手順は、小さいファイル(256MB 以下)に適用されます。ゲートウェイのタイムアウトまたは陸エスト本文のサイズエラーが発生した場合は、大きなファイルのアップロードに切り替える必要があります。
まず、JSON を入力形式としてバッチを作成する必要があります。バッチを作成する場合は、データセット ID を指定する必要があります。また、バッチの一部としてアップロードされるすべてのファイルが、提供されたデータセットにリンクされた XDM スキーマに適合していることを確認する必要があります。
以下に、1 行の JSON の例を示します。複数行の JSON を取得するには、isMultiLineJson
フラグを設定する必要があります。詳しくは、『バッチ取得トラブルシューティングガイド』を参照してください。
API 形式
POST /batches
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"datasetId": "{DATASET_ID}",
"inputFormat": {
"format": "json"
}
}'
パラメーター | 説明 |
---|---|
{DATASET_ID} |
参照データセットの ID。 |
応答
{
"id": "{BATCH_ID}",
"imsOrg": "{IMS_ORG}",
"updated": 0,
"status": "loading",
"created": 0,
"relatedObjects": [
{
"type": "dataSet",
"id": "{DATASET_ID}"
}
],
"version": "1.0.0",
"tags": {},
"createdUser": "{USER_ID}",
"updatedUser": "{USER_ID}"
}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
これでバッチが作成され、前の batchId
を使用してファイルをバッチにアップロードできます。複数のファイルをバッチにアップロードできます。
付録の適切に書式設定された JSON データファイルの例についての節を参照してください。
API 形式
PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
アップロードするファイルの名前。このファイルパスは、Adobe側でファイルが保存される場所です。 |
リクエスト
API は、シングルパートのアップロードをサポートします。content-type が application/octet-stream であることを確認します。
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.json \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/octet-stream' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
--data-binary "@{FILE_PATH_AND_NAME}.json"
パラメーター | 説明 |
---|---|
{FILE_PATH_AND_NAME} |
アップロードしようとしているファイルのフルパスと名前。このファイルパスは、Users/sample-user/Downloads/sample.json などのローカルファイルパスです。 |
応答
200 OK
ファイルの様々な部分のアップロードが完了したら、データが完全にアップロードされ、バッチがプロモーションの準備ができたことを伝える必要があります。
API 形式
POST /batches/{BATCH_ID}?action=COMPLETE
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
リクエスト
curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
次の手順は、小さいファイル(256MB 以下)に適用されます。ゲートウェイのタイムアウトまたは陸エスト本文のサイズエラーが発生した場合は、大きなファイルのアップロードに切り替える必要があります。
まず、Parquet を入力形式としてバッチを作成する必要があります。バッチを作成する場合は、データセット ID を指定する必要があります。また、バッチの一部としてアップロードされるすべてのファイルが、提供されたデータセットにリンクされた XDM スキーマに適合していることを確認する必要があります。
リクエスト
curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "x-gw-ims-org-id: {IMS_ORG}" \
-H "x-api-key : {API_KEY}" \
-H "x-sandbox-name: {SANDBOX_NAME}"
-d '{
"datasetId": "{DATASET_ID}",
"inputFormat": {
"format": "parquet"
}
}'
パラメーター | 説明 |
---|---|
{DATASET_ID} |
参照データセットの ID。 |
応答
201 Created
{
"id": "{BATCH_ID}",
"imsOrg": "{IMS_ORG}",
"updated": 0,
"status": "loading",
"created": 0,
"relatedObjects": [
{
"type": "dataSet",
"id": "{DATASET_ID}"
}
],
"version": "1.0.0",
"tags": {},
"createdUser": "{USER_ID}",
"updatedUser": "{USER_ID}"
}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
{USER_ID} |
バッチを作成したユーザーの ID。 |
これでバッチが作成され、前の batchId
を使用してファイルをバッチにアップロードできます。複数のファイルをバッチにアップロードできます。
API 形式
PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
アップロードするファイルの名前。このファイルパスは、Adobe側でファイルが保存される場所です。 |
リクエスト
この API は、シングルパートのアップロードをサポートします。content-type が application/octet-stream であることを確認します。
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/octet-stream' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
--data-binary "@{FILE_PATH_AND_NAME}.parquet"
パラメーター | 説明 |
---|---|
{FILE_PATH_AND_NAME} |
アップロードしようとしているファイルのフルパスと名前。このファイルパスは、Users/sample-user/Downloads/sample.json などのローカルファイルパスです。 |
応答
200 OK
ファイルの様々な部分のアップロードが完了したら、データが完全にアップロードされ、バッチがプロモーションの準備ができたことを伝える必要があります。
API 形式
POST /batches/{BATCH_ID}?action=complete
パラメーター | 説明 |
---|---|
{BATCH_ID} |
シグナルを送信するバッチの ID は、完了の準備が整っています。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
この節では、256MB を超えるファイルをアップロードする方法について説明します。大きなファイルはチャンク単位でアップロードされ、API 信号を介して繋ぎ合わされます。
まず、Parquet を入力形式としてバッチを作成する必要があります。バッチを作成する場合は、データセット ID を指定する必要があります。また、バッチの一部としてアップロードされるすべてのファイルが、提供されたデータセットにリンクされた XDM スキーマに適合していることを確認する必要があります。
API 形式
POST /batches
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"datasetId": "{DATASET_ID}",
"inputFormat": {
"format": "parquet"
}
}'
パラメーター | 説明 |
---|---|
{DATASET_ID} |
参照データセットの ID。 |
応答
201 Created
{
"id": "{BATCH_ID}",
"imsOrg": "{IMS_ORG}",
"updated": 0,
"status": "loading",
"created": 0,
"relatedObjects": [
{
"type": "dataSet",
"id": "{DATASET_ID}"
}
],
"version": "1.0.0",
"tags": {},
"createdUser": "{USER_ID}",
"updatedUser": "{USER_ID}"
}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
{USER_ID} |
バッチを作成したユーザーの ID。 |
バッチを作成した後、大きなファイルを初期化してから、バッチにチャンクをアップロードする必要があります。
API 形式
POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
{FILE_NAME} |
初期化されるファイルの名前。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet?action=INITIALIZE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
201 Created
ファイルが作成されたので、以降のすべてのチャンクは、ファイルの各セクションに対して 1 つずつ、繰り返し PATCH リクエストを実行することでアップロードできます。
API 形式
PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
アップロードするファイルの名前。このファイルパスは、Adobe側でファイルが保存される場所です。 |
リクエスト
この API は、シングルパートのアップロードをサポートします。content-type が application/octet-stream であることを確認します。
curl -X PATCH https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/octet-stream' \
-H 'Content-Range: bytes {CONTENT_RANGE}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
--data-binary "@{FILE_PATH_AND_NAME}.parquet"
パラメーター | 説明 |
---|---|
{CONTENT_RANGE} |
指定した範囲の開始と終了を整数で指定します。 |
{FILE_PATH_AND_NAME} |
アップロードしようとしているファイルのフルパスと名前。このファイルパスは、Users/sample-user/Downloads/sample.json などのローカルファイルパスです。 |
応答
200 OK
これでバッチが作成され、前の batchId
を使用してファイルをバッチにアップロードできます。複数のファイルをバッチにアップロードできます。
API 形式
POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
完了を伝えるバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
完了を伝えるファイルの名前。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet?action=COMPLETE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
201 Created
ファイルの様々な部分のアップロードが完了したら、データが完全にアップロードされ、バッチがプロモーションの準備ができたことを伝える必要があります。
API 形式
POST /batches/{BATCH_ID}?action=COMPLETE
パラメーター | 説明 |
---|---|
{BATCH_ID} |
シグナルを送信するバッチの ID が完了しました。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
CSV ファイルを取得するには、CSV をサポートするクラス、スキーマ、データセットを作成する必要があります。必要なクラスとスキーマの作成方法について詳しくは、『アドホックスキーマの作成チュートリアル』の手順に従ってください。
次の手順は、小さいファイル(256MB 以下)に適用されます。ゲートウェイのタイムアウトまたは陸エスト本文のサイズエラーが発生した場合は、大きなファイルのアップロードに切り替える必要があります。
上記の手順に従って必要なクラスとスキーマを作成した後、CSV サポートするデータセットを作成する必要があります。
API 形式
POST /catalog/dataSets
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/catalog/dataSets \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "{DATASET_NAME}",
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
"contentType": "application/vnd.adobe.xed+json;version=1"
},
"fileDescription": {
"format": "parquet",
"delimiters": [","],
"quotes": ["\""],
"escapes": ["\\"],
"header": true,
"charset": "UTF-8"
}
}'
パラメーター | 説明 |
---|---|
{TENANT_ID} |
この ID を使用すると、作成したリソースの名前空間が適切に付けられ、IMS 組織内に含まれるようになります |
{SCHEMA_ID} |
作成したスキーマの ID。 |
JSON 本文の「fileDescription」セクションの異なる部分の説明を以下に示します。
{
"fileDescription": {
"format": "parquet",
"delimiters": [","],
"quotes": ["\""],
"escapes": ["\\"],
"header": true,
"charset": "UTF-8"
}
}
パラメーター | 説明 |
---|---|
format |
入力ファイルの形式ではなく、マスターファイルの形式です。 |
delimiters |
区切り文字として使用する文字。 |
quotes |
引用符に使用する文字。 |
escapes |
エスケープ文字として使用する文字。 |
header |
アップロードするファイルにはヘッダーが含まれている必要があります。スキーマの検証が行われるので、この値を true に設定する必要があります。また、ヘッダーにスペースを含めることはできません。ヘッダーにスペースが含まれている場合は、アンダースコアで置き換えてください。 |
charset |
オプションのフィールド。その他のサポートされている文字セットには、「US-ASCII」と「ISO-8869-1」があります。空のままにすると、デフォルトで UTF-8 が使用されます。 |
参照するデータセットには、上記のファイル記述ブロックが含まれ、レジストリ内の有効なスキーマを指す必要があります。そうしないと、ファイルはParketにマスターされません。
次に、CSV を入力形式としてバッチを作成する必要があります。バッチを作成する場合は、データセット ID を指定する必要があります。また、バッチの一部としてアップロードされるすべてのファイルが、提供されたデータセットにリンクされたスキーマに適合していることを確認する必要があります。
API 形式
POST /batches
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"datasetId": "{DATASET_ID}",
"inputFormat": {
"format": "csv"
}
}'
パラメーター | 説明 |
---|---|
{DATASET_ID} |
参照データセットの ID。 |
応答
201 Created
{
"id": "{BATCH_ID}",
"imsOrg": "{IMS_ORG}",
"updated": 0,
"status": "loading",
"created": 0,
"relatedObjects": [
{
"type": "dataSet",
"id": "{DATASET_ID}"
}
],
"version": "1.0.0",
"tags": {},
"createdUser": "{USER_ID}",
"updatedUser": "{USER_ID}"
}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
{USER_ID} |
バッチを作成したユーザーの ID。 |
これでバッチが作成され、前の batchId
を使用してファイルをバッチにアップロードできます。複数のファイルをバッチにアップロードできます。
付録の適切に書式設定された CSV データファイルの例についての節を参照してください。
API 形式
PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
アップロードするファイルの名前。このファイルパスは、Adobe側でファイルが保存される場所です。 |
リクエスト
この API は、シングルパートのアップロードをサポートします。content-type が application/octet-stream であることを確認します。
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.csv \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/octet-stream' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
--data-binary "@{FILE_PATH_AND_NAME}.csv"
パラメーター | 説明 |
---|---|
{FILE_PATH_AND_NAME} |
アップロードしようとしているファイルのフルパスと名前。このファイルパスは、Users/sample-user/Downloads/sample.json などのローカルファイルパスです。 |
応答
200 OK
ファイルの様々な部分のアップロードが完了したら、データが完全にアップロードされ、バッチがプロモーションの準備ができたことを伝える必要があります。
API 形式
POST /batches/{BATCH_ID}?action=COMPLETE
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
バッチの処理中は、キャンセルすることができます。ただし、バッチが確定されると(成功または失敗の状態など)、バッチはキャンセルできません。
API 形式
POST /batches/{BATCH_ID}?action=ABORT
パラメーター | 説明 |
---|---|
{BATCH_ID} |
キャンセルするバッチの ID。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=ABORT \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
action=REVERT
クエリパラメーターを使用して、削除するバッチの ID に対して次の POST リクエストを実行すると、バッチを削除できます。バッチは「非アクティブ」と指定され、ガベージコレクションの対象となります。バッチは非同期で収集され、その時点で「削除済み」と指定されます。
API 形式
POST /batches/{BATCH_ID}?action=REVERT
パラメーター | 説明 |
---|---|
{BATCH_ID} |
削除するバッチの ID。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=REVERT \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
既に取得したバッチを置き換える場合は、「バッチ再生」を使用できます。この操作は、古いバッチを削除し、代わりに新しいバッチを取得する操作と同じです。
まず、JSON を入力形式としてバッチを作成する必要があります。バッチを作成する場合は、データセット ID を指定する必要があります。また、バッチの一部としてアップロードされるすべてのファイルが、提供されたデータセットにリンクされた XDM スキーマに適合していることを確認する必要があります。また、再生セクションで参照として古いバッチを指定する必要があります。次の例では、batchIdA
ID と batchIdB
ID を使用してバッチを再生します 。
API 形式
POST /batches
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"datasetId": "{DATASET_ID}",
"inputFormat": {
"format": "json"
},
"replay": {
"predecessors": ["${batchIdA}","${batchIdB}"],
"reason": "replace"
}
}'
パラメーター | 説明 |
---|---|
{DATASET_ID} |
参照データセットの ID。 |
応答
201 Created
{
"id": "{BATCH_ID}",
"imsOrg": "{IMS_ORG}",
"updated": 0,
"status": "loading",
"created": 0,
"relatedObjects": [
{
"type": "dataSet",
"id": "{DATASET_ID}"
}
],
"replay": {
"predecessors": [
"batchIdA", "batchIdB"
],
"reason": "replace"
},
"version": "1.0.0",
"tags": {},
"createdUser": "{USER_ID}",
"updatedUser": "{USER_ID}"
}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
新しく作成されたバッチの ID。 |
{DATASET_ID} |
参照先のデータセットの ID。 |
{USER_ID} |
バッチを作成したユーザーの ID。 |
これでバッチが作成され、前の batchId
を使用してファイルをバッチにアップロードできます。複数のファイルをバッチにアップロードできます。
API 形式
PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
パラメーター | 説明 |
---|---|
{BATCH_ID} |
アップロード先のバッチの ID。 |
{DATASET_ID} |
バッチの参照データセットの ID。 |
{FILE_NAME} |
アップロードするファイルの名前。このファイルパスは、Adobe側でファイルが保存される場所です。 |
リクエスト
この API は、シングルパートのアップロードをサポートします。content-type が application/octet-stream であることを確認します。API と互換性のないマルチパートリクエストがデフォルトで設定されるので、curl -F オプションは使用しないでください。
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.json \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/octet-stream' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
--data-binary "@{FILE_PATH_AND_NAME}.json"
パラメーター | 説明 |
---|---|
{FILE_PATH_AND_NAME} |
アップロードしようとしているファイルのフルパスと名前。このファイルパスは、Users/sample-user/Downloads/sample.json などのローカルファイルパスです。 |
応答
200 OK
ファイルの様々な部分のアップロードが完了したら、データが完全にアップロードされ、バッチがプロモーションの準備ができたことを伝える必要があります。
API 形式
POST /batches/{BATCH_ID}?action=COMPLETE
パラメーター | 説明 |
---|---|
{BATCH_ID} |
完了するバッチの ID。 |
リクエスト
curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key : {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
200 OK
データファイルをExperience Platformに取り込むためには、ファイルの階層構造が、アップロード先のデータセットに関連付けられたエクスペリエンスデータモデル(XDM)スキーマに準拠している必要があります。
XDM スキーマに準拠する CSV ファイルのマッピング方法に関する情報は、サンプル変換ドキュメントに記載されている情報と、適切に書式設定された JSON データファイルの例を参照してください。このドキュメントのサンプルファイルは、次の場所にあります。