Query Service API ガイド

この開発者ガイドでは、Adobe Experience Platformで様々な操作を実行する手順を説明します Query Service API

はじめに

このガイドでは、の使用に関連する様々なAdobe Experience Platformサービスに関する十分な知識が必要です Query Service.

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

以下の節では、を正しく使用するために知っておく必要がある追加情報を示します Query Service API を使用している場合にのみ表示されます。

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: {ORG_ID}

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

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

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

サンプル API 呼び出し

これで、使用するヘッダーを理解できたので、 Query Service API 以下のドキュメントでは、 Query Service API 各呼び出し例では一般的な API 形式、必須ヘッダーを示すサンプルリクエストおよびサンプルレスポンスが示されています。

次の手順

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

このページ