Catalog Service API ガイド

Catalog Service は、Adobe Experience Platform 内のデータの場所と系列の記録システムです。Catalog は、内のデータに関する情報を検索できるメタデータストアまたは「カタログ」として機能します。 Experience Platform（データ自体にアクセスする必要はありません）。 詳しくは、Catalog 概要を参照してください。

このデベロッパーガイドでは、Catalog API を使い始めるのに役立つ手順を説明します。次に、 Catalog.

前提条件

Catalog では、様々な種類のリソースおよび操作のメタデータを内でトラッキングします。 Experience Platform. この開発者ガイドでは、 Experience Platform 以下のリソースの作成と管理に関わるサービス：

  • Experience Data Model (XDM)：Platform が、カスタマーエクスペリエンスデータを整理する際に使用する、標準化されたフレームワーク。
  • バッチ取得 Experience Platform： が CSV や Parket などのデータファイルからデータを取得して保存する方法。
  • ストリーミング取り込み:方法 Experience Platform クライアントサイドおよびサーバーサイドのデバイスからデータをリアルタイムで取得し、保存します。

以下の節では、 Catalog Service API

API 呼び出し例の読み取り

ここでは、リクエストの形式を説明するために 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： {ORG_ID}

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name：{SANDBOX_NAME}
メモ

Platform のサンドボックスについて詳しくは、サンドボックスの概要に関するドキュメントを参照してください。

ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、次のような追加ヘッダーが必要です。

  • Content-Type：application/json

のベストプラクティス Catalog API 呼び出し

に対してGETリクエストを実行する際 Catalog API のベストプラクティスは、必要なオブジェクトとプロパティのみを返すために、リクエストにクエリパラメーターを含めることです。 フィルターを適用しないリクエストの応答ペイロードのサイズは 3 GB に達っすることがあり、全体的なパフォーマンスが低下する可能性があります。

特定のオブジェクトを表示するには、リクエストパスに ID を含めるか、または properties や limit などのクエリーパラメーターを使用して応答をフィルターします。フィルターは、ヘッダーおよびクエリーパラメーターとして渡すことができ、クエリーパラメーターとして渡されたフィルターが優先されます。詳しくは、カタログデータのフィルターに関するドキュメントを参照してください。

一部のクエリが API に大きな負荷をかける可能性があるので、グローバル制限が Catalog のクエリを参照して、ベストプラクティスをさらにサポートします。

次の手順

このドキュメントでは、 Catalog API これで、この開発者ガイドに記載されているサンプル呼び出しに進んで、その手順に従うことができます。

このガイドの例のほとんどでは、 /dataSets エンドポイントに適用されますが、原則は、 Catalog ( /batches および /accounts) をクリックします。 各エンドポイントで使用できるすべての呼び出しと操作の完全なリストについては、『カタログサービス API リファレンス』を参照してください。

を Catalog API はデータ取得に関わっています。詳しくは、 データセットの作成.

このページ