Query Service 開発ガイド

This developer guide provides steps for performing various operations in the Adobe Experience Platform Query Service API.

はじめに

This guide requires a working understanding of the various Adobe Experience Platform services involved with using Query Service.

  • Query Service:データセットをクエリし、結果のクエリをの新しいデータセットとして取り込む機能を提供 Experience Platformします。
  • Experience Data Model (XDM) System:顧客体験データを Experience Platform 整理する際に使用される標準化されたフレームワーク。
  • Sandboxes: Experience Platform は、1つの Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

The following sections provide additional information that you will need to know in order to successfully use Query Service using the API.

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

In order to make calls to Experience Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all 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 in which the operation will take place:

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

For more information on working with sandboxes in Experience Platform, see the sandboxes overview documentation.

サンプル API 呼び出し

Now that you understand what headers to use, you are ready to begin making calls to the Query Service API. The following documents walk through the various API calls you can make using the Query Service API. 各サンプル呼び出しには、一般的な API 形式、必要なヘッダーを示すサンプルリクエスト、サンプルの応答が含まれています。

次の手順

Now that you have learned how to make calls using the Query Service API, you can create your own non-interactive queries. クエリの作成方法について詳しくは、SQL リファレンスガイドを参照してください。

このページ