ドキュメントExperience Platformデータアクセスガイド

データアクセス API ガイド

Last update: Thu Sep 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

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

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

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

API 仕様リファレンス

OpenAPI リファレンスドキュメントは、 こちらを参照してください。

用語 terminology

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

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

バッチ内のファイルのリストの取得 retrieve-list-of-files-in-a-batch

特定のバッチに属するファイルのリストを取得するには、データアクセス 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。

バッチ内のファイルへのアクセスとダウンロード

ファイルの特定の詳細にアクセスするには、Data Access API でファイル識別子（{FILE_ID}）を使用します（名前、バイト単位のサイズ、ダウンロードするリンクなど）。

応答にはデータ配列が含まれています。 ID で指すファイルが個々のファイルかディレクトリかに応じて、返されるデータ配列には、1 つのエントリか、そのディレクトリに属するファイルのリストが含まれます。各ファイル要素には、ファイルの詳細が含まれます。

API 形式

GET /files/{FILE_ID}
プロパティ
説明
{FILE_ID}
アクセスするファイルの ID です（"dataSetFileId" に等しい）。

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -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": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}
プロパティ
説明
data.name
ファイルの名前（例：profiles.csv）。
data.length
ファイルのサイズ（バイト単位）。
data._links.self.href
ファイルをダウンロードするための URL です。

ディレクトリ応答

{
  "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": 2
  }
}

ディレクトリが返される場合、そのディレクトリ内のすべてのファイルの配列が含まれています。

プロパティ
説明
data.name
ファイルの名前（例：profiles.csv）。
data._links.self.href
ファイルをダウンロードするための URL です。

ファイルのコンテンツへのアクセス access-file-contents

Data Access API を使用してファイルのコンテンツにアクセスすることもできます。 その後、コンテンツを外部ソースにダウンロードできます。

API 形式

GET /files/{dataSetFileId}?path={FILE_NAME}
プロパティ
説明
{FILE_NAME}
アクセスしようとしているファイルの名前です。

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -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}'
プロパティ
説明
{FILE_ID}
データセット内のファイルの ID です。
{FILE_NAME}
ファイルのフルネーム （例：profiles.csv）。

応答

Contents of the file

その他のコードサンプル

その他の例については、 データアクセスのチュートリアルを参照してください。

データ取得イベントへのサブスクライブ subscribe-to-data-ingestion-events

Adobe Developer Console を通じて、特定の価値の高いイベントを購読できます。 例えば、データ取り込みイベントに登録して、遅延や障害の可能性についての通知を受け取ることができます。詳しくは、Adobeイベント通知の登録のチュートリアルを参照してください。

recommendation-more-help
d71356da-cd87-452c-8a00-68926401758f