Query Service API ガイド

この開発者ガイドは、Adobe Experience PlatformQuery Service APIの様々な操作を実行する手順を提供します。

はじめに

このガイドでは、Query Serviceの使用に関わる様々なAdobe Experience Platformサービスについて、十分に理解しておく必要があります。

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

以下の節では、APIを使用してQuery Serviceを正しく使用するために知っておく必要のある追加情報について説明します。

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

Experience Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

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

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

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

サンプル API 呼び出し

これで、使用するヘッダーがわかったので、Query Service APIを呼び出す準備が整いました。 以下のドキュメントでは、Query Service APIを使用して実行できる様々なAPI呼び出しについて説明します。 各サンプル呼び出しには、一般的な API 形式、必要なヘッダーを示すサンプルリクエスト、サンプルの応答が含まれています。

次の手順

これで、Query Service APIを使用した呼び出し方法を学んだので、独自の非インタラクティブクエリを作成できます。 クエリの作成方法について詳しくは、SQL リファレンスガイドを参照してください。

このページ