データアクセス API ガイド

最終更新日： 2025年3月6日

作成対象：

  • 開発者
IMPORTANT
Data Access API が 非推奨 になりました。 Adobe Experience Platformからのデータの書き出しに Destinations を使用することをお勧めします。 詳しくは、 データセット書き出し宛先のドキュメントを参照してください。

Data Access API は、Experience Platform 内に取り込んだデータセットの検出可能性とアクセシビリティに重点を置いた RESTful インターフェイスをユーザーに提供することで、Adobe Experience Platformをサポートします。

Data Access により、Experience Platform内に取り込んだデータセットの検出性とアクセス性がどのように促進されるかを示す図。

API 仕様リファレンス

統合、テスト、探索を容易にする標準化された機械読み取り可能な形式を表示するには、 データアクセス OpenAPI リファレンスドキュメントを参照してください。

用語

次の表は、このドキュメント全体で一般的に使用される用語の説明です。

用語説明
データセットスキーマとフィールドを含むデータのコレクション。
バッチ一定期間に収集され、1 つの単位として処理される一連のデータ。

バッチ内のファイルのリストの取得

特定のバッチに属するファイルのリストを取得するには、データアクセス API でバッチ識別子（batchID）を使用します。

API 形式

GET /batches/{BATCH_ID}/files
プロパティ説明
{BATCH_ID}指定したバッチのID。

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

"data" 配列には、指定したバッチ内のすべてのファイルのリストが含まれています。返されるファイルごとに、"dataSetFileId" フィールド内に固有の ID（{FILE_ID}）が含まれています。この一意の ID を使用して、ファイルにアクセスしたり、ファイルをダウンロードしたりできます。

プロパティ説明
data.dataSetFileId指定したバッチ内の各ファイルのファイル ID。
data._links.self.hrefファイルにアクセスするための URL。