Show Menu
トピック×

Catalog Service 開発ガイド

Catalog Service は、Adobe Experience Platform内のデータの位置と系統に関する記録システムです。 Catalog は、データ自体にアクセスすることなく、データに関する情報を検索できるメタデータストア(「カタログ」) Experience Platformとして機能します。 See the Catalog overview for more information.
This developer guide provides steps to help you start using the Catalog API. The guide then provides sample API calls for performing key operations using Catalog.

前提条件

Catalog では、様々な種類のリソースおよび操作のメタデータを追跡 Experience Platformします。 This developer guide requires a working understanding of the various Experience Platform services involved with creating and managing these resources:
  • Experience Data Model (XDM) :顧客体験データを Platform 整理する際に使用される標準化されたフレームワーク。
  • バッチ取得 Experience Platform: が CSV や Parket などのデータファイルからデータを取得して保存する方法。
  • ストリーミング取得 Experience Platform: がクライアントサイドおよびサーバーサイドのデバイスからデータをリアルタイムで取得し、保存する方法。
The following sections provide additional information that you will need to know or have on-hand in order to successfully make calls to the Catalog Service API.

API 呼び出し例の読み取り

ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。これには、パス、必須ヘッダー、適切に書式設定されたリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドの API 呼び出し例の読み方 に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:
  • x-sandbox-name: {SANDBOX_NAME}
For more information on sandboxes in Platform, see the sandbox overview documentation .
ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、以下のような追加ヘッダーが必要です。
  • Content-Type: application/json

Best practices for Catalog API calls

When performing GET requests to the Catalog API, best practice is to include query parameters in your requests in order to return only the objects and properties that you need. フィルターを適用しないリクエストの応答ペイロードのサイズは 3 GB に達っすることがあり、全体的なパフォーマンスが低下する可能性があります。
特定のオブジェクトを表示するには、リクエストパスに ID を含めるか、または properties limit などのクエリーパラメーターを使用して応答をフィルターします。フィルターは、ヘッダーおよびクエリーパラメーターとして渡すことができ、クエリーパラメーターとして渡されたフィルターが優先されます。詳しくは、 カタログデータのフィルター に関するドキュメントを参照してください。
Since some queries can put a heavy load on the API, global limits have been implemented on Catalog queries to further support best practices.

次の手順

This document covered the prerequisite knowledge required to make calls to the Catalog API. 次に、この開発者ガイドに記載されているサンプル呼び出しに進み、その手順に従うことができます。
Most of the examples in this guide use the /dataSets endpoint, but the principles can be applied to other endpoints within Catalog (such as /batches and /accounts ). 各エンドポイントで使用できるすべての呼び出しと操作の完全なリストについては、『 カタログサービス API リファレンス 』を参照してください。
For a step-by-step workflow that demonstrates how the Catalog API is involved with data ingestion, see the tutorial on creating a dataset .