Query Service API ガイド

最終更新日: 2023-01-07
  • トピック:
  • Queries
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

この開発者ガイドでは、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: {ORG_ID}

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

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

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

サンプル API 呼び出し

使用するヘッダーを理解できたので、Query Service API への呼び出しを開始できます。次のドキュメントでは、Query Service API を使用して作成できる様々な API 呼び出しについて説明します。各呼び出し例では一般的な API 形式、必須ヘッダーを示すサンプルリクエストおよびサンプルレスポンスが示されています。

次の手順

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

このページ