Show Menu
トピック×

クエリサービス開発ガイド

この開発者ガイドは、Adobe Experience PlatformクエリサービスAPIの様々な操作を実行する手順を提供します。

はじめに

このガイドでは、クエリサービスの使用に関連する様々なAdobe Experience Platformサービスについて、十分に理解している必要があります。
  • クエリサービス : Experience Platformの新しいデータセットとしてデータセットをクエリし、結果のクエリを取得する機能を提供します。
  • Experience Data Model(XDM)System : エクスペリエンスプラットフォームが顧客エクスペリエンスデータを編成する際に使用する標準化されたフレームワークです。
  • サンドボックス : Experience Platformは、1つのプラットフォームインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。
以下の節では、APIを使用してクエリサービスを正しく使用するために知っておく必要がある追加情報について説明します。

サンプルAPI呼び出しの読み取り

このガイドは、リクエストをフォーマットする方法を示すAPI呼び出しの例を提供します。 例えば、パス、必須のヘッダー、適切にフォーマットされた要求ペイロードなどです。 API応答で返されるサンプルJSONも提供されます。 このドキュメントでサンプルAPI呼び出しに使用される表記について詳しくは、Experience PlatformトラブルシューティングガイドのAPI呼び出し例を読む 方法に関する節を参照してください

必要なヘッダーの値の収集

Experience Platform APIを呼び出すには、まず 認証チュートリアルを完了する必要があります 。 次に示すように、認証チュートリアルで、すべてのプラットフォームAPI呼び出しに必要な各ヘッダーの値を指定する。
  • 認証: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
エクスペリエンスプラットフォームのすべてのリソースは、特定の仮想サンドボックスに分離されています。 プラットフォームAPIへのすべてのリクエストには、操作が実行されるサンドボックスの名前を指定するヘッダーが必要です。
  • x-sandbox-name: {SANDBOX_NAME}
エクスペリエンスプラットフォームでのサンドボックスの操作について詳しくは、サンドボックスの概要ドキュメントを参照して ください

サンプルAPI呼び出し

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

次の手順

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