Query Service API ガイド

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

はじめに

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

  • Query Service:データセットに対してクエリを実行し、結果のクエリをで新しいデータセットとして取り込む機能を提供しま Experience Platformす。
  • Experience Data Model (XDM) System:顧客体験データを編成する際に Experience Platform に使用される標準化されたフレームワーク。
  • Sandboxes: Experience Platform は、単一のインスタンスを別々の仮想環境に分 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 リファレンスガイドを参照してください。

このページ