Show Menu
トピック×

バッチインジェスト開発者ガイド

このドキュメントの付録では、サンプルのCSVデータファイルやJSONデータファイルなど 、取り込みに使用するデータの 形式設定について説明します。

はじめに

データ取り込みにはRESTful APIが用意されており、サポートされるオブジェクトタイプに対して基本的なCRUD操作を実行できます。
以下の節では、バッチインジェストAPIの呼び出しを正常に行うために知っておく必要がある、または手元に置く必要がある追加情報について説明します。
このガイドでは、Adobe Experience Platformの次のコンポーネントについて、十分に理解している必要があります。
  • バッチインジェスト : データをバッチファイルとしてAdobe Experience Platformに取り込むことができます。
  • Experience Data Model(XDM)System : エクスペリエンスプラットフォームが顧客エクスペリエンスデータを編成する際に使用する標準化されたフレームワークです。
  • サンドボックス : Experience Platformは、1つのプラットフォームインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

サンプルAPI呼び出しの読み取り

このガイドは、リクエストをフォーマットする方法を示すAPI呼び出しの例を提供します。 例えば、パス、必須のヘッダー、適切にフォーマットされた要求ペイロードなどです。 API応答で返されるサンプルJSONも提供されます。 サンプルAPI呼び出しのドキュメントで使用される表記について詳しくは、Experience PlatformトラブルシューティングガイドのAPI呼び出し例の読み 方に関する節を参照してください

必要なヘッダーの値の収集

プラットフォームAPIを呼び出すには、まず 認証チュートリアルを完了する必要があります 。 次に示すように、認証チュートリアルで、すべてのExperience Platform API呼び出しに必要な各ヘッダーの値を指定します。
  • 認証: 無記名 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
エクスペリエンスプラットフォームのすべてのリソースは、特定の仮想サンドボックスに分離されています。 プラットフォームAPIへのすべてのリクエストには、操作が実行されるサンドボックスの名前を指定するヘッダーが必要です。
  • x-sandbox-name: {SANDBOX_NAME}
プラットフォームのサンドボックスについて詳しくは、「 サンドボックスの概要に関するドキュメント 」を参照してください。
ペイロード(POST、PUT、PATCH)を含む要求には、追加の Content-Type ヘッダーが必要な場合があります。 各呼び出しに固有の受け入れられた値は、呼び出しパラメーターに提供されます。 このガイドでは、次のコンテンツタイプを使用します。
  • Content-Type: application/json
  • Content-Type: application/octet-stream

タイプ

データを取り込む場合、Experience Data Model(XDM)スキーマの動作を理解することが重要です。 XDMフィールドの型を異なる形式にマップする方法について詳しくは、『 スキーマレジストリ開発者ガイド 』を参照してください。
データを取り込む際には、柔軟性があります。ターゲットスキーマ内のデータと一致しない場合、データは表示されるターゲットタイプに変換されます。 できない場合は、バッチはaで失敗し TypeCompatibilityException ます。
例えば、JSONもCSVも日付や日時のタイプを持ちません。 その結果、これらの値は、 ISO 8061形式の文字列 ("2018-07-10T15:05:59.000-08:00")またはUNIX時間(153126395)を使用して表されます。9000)に変換され、取り込み時にターゲットXDMタイプに変換されます。
次の表に、データを取り込む際にサポートされる変換を示します。
受信(行)とターゲット(列)
文字列
バイト
Short
整数
ロング
重複
日付
日時
オブジェクト
マップ
文字列
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
ブール値と配列は、他の型に変換できません。

取り込みの制約

バッチデータ取り込みには、いくつかの制約があります。
  • バッチあたりの最大ファイル数: 1500
  • 最大バッチサイズ: 100 GB
  • 1行あたりのプロパティまたはフィールドの最大数: 10000
  • 1ユーザーあたりの1分あたりの最大バッチ数: 138

取り込みJSONファイル

以下の手順は、小さいファイル(256 MB以下)に適用されます。 ゲートウェイのタイムアウトまたは要求本文のサイズのエラーが発生した場合は、大きいファイルのアップロードに切り替える必要があります。

バッチの作成

まず、入力形式として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}
アップロードするファイルの名前。
リクエスト
このAPIは、シングルパートのアップロードをサポートしています。 コンテンツタイプが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}
アップロードしようとしているファイルのフルパスと名前。
応答
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

インジェストパーケファイル

以下の手順は、小さいファイル(256 MB以下)に適用されます。 ゲートウェイのタイムアウトまたは要求本文のサイズのエラーが発生した場合は、大きなファイルのアップロードに切り替える必要があります。

バッチの作成

まず、Parketを入力形式としてバッチを作成する必要があります。 バッチを作成する場合は、データセット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}
アップロードするファイルの名前。
リクエスト
このAPIは、シングルパートのアップロードをサポートしています。 コンテンツタイプが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}
アップロードしようとしているファイルのフルパスと名前。
応答
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

大きなパーケファイルを取り込む

この節では、256 MBを超えるファイルをアップロードする方法について説明します。 大きなファイルはチャンクでアップロードされ、API信号を介して繋ぎ合わされます。

バッチの作成

まず、Parketを入力形式としてバッチを作成する必要があります。 バッチを作成する場合は、データセット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}
アップロードするファイルの名前。
リクエスト
このAPIは、シングルパートのアップロードをサポートしています。 コンテンツタイプが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}
アップロードしようとしているファイルのフルパスと名前。
応答
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ファイルを取り込むには、CSVをサポートするクラス、スキーマ、データセットを作成する必要があります。 必要なクラスとスキーマを作成する方法について詳しくは、「 ad hocスキーマの作成」チュートリアルに記載されている手順に従ってください
以下の手順は、小さいファイル(256 MB以下)に適用されます。 ゲートウェイのタイムアウトまたは要求本文のサイズのエラーが発生した場合は、大きなファイルのアップロードに切り替える必要があります。

データセットの作成

上記の手順に従って必要なクラスとスキーマを作成した後、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が使用されます。
参照するデータセットには、上記のファイル記述ブロックが含まれ、レジストリ内の有効なスキーマを指す必要があります。 そうしないと、ファイルはパーケーにマスターされません。

バッチの作成

次に、入力形式として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}
アップロードするファイルの名前。
リクエスト
このAPIは、シングルパートのアップロードをサポートしています。 コンテンツタイプが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}
アップロードしようとしているファイルのフルパスと名前。
応答
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

バッチの削除

バッチは、削除するバッチのIDに対する action=REVERT クエリパラメーターを指定して、次の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スキーマに準拠していることを確認する必要もあります。 また、リプレイ・セクションで参照する古いバッチを指定する必要があります。 次の例では、IDとを持つバッチを再生し batchIdA てい batchIdB ます。
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}
アップロードするファイルの名前。
リクエスト
このAPIは、シングルパートのアップロードをサポートしています。 コンテンツタイプが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}
アップロードしようとしているファイルのフルパスと名前。
応答
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に取り込むには、ファイルの階層構造が、アップロード先のデータセットに関連付けられている Experience Data Model(XDM) スキーマに準拠している必要があります。
XDMスキーマに準拠するためのCSVファイルのマッピング方法に関する情報は、 サンプルのtransformations ドキュメントに記載されています。また、適切にフォーマットされたJSONデータファイルの例も含まれています。 ドキュメントーに用意されているサンプルファイルは次の場所にあります。