Real-time Customer Profile APIの使い始めに

リアルタイム顧客プロファイルAPIエンドポイントを使用すると、計算済み属性の設定、エンティティへのアクセス、プロファイルデータの書き出し、不要なデータセットやバッチの削除など、プロファイルデータに対する基本的なCRUD操作を実行できます。

開発者ガイドを使用するには、Profileデータの操作に関与する様々なAdobe Experience Platformサービスに関する作業的な理解が必要です。 Real-time Customer Profile APIの使用を開始する前に、次のサービスのドキュメントを確認してください。

  • Real-time Customer Profile:複数のソースからの集計データに基づいて、リアルタイムで統合された顧客プロファイルを提供します。
  • Adobe Experience Platform Identity Service:デバイスとシステム間でIDをブリッジ化することで、顧客と行動をより良く表示できます。
  • Adobe Experience Platform Segmentation Service:リアルタイム顧客プロファイルデータからオーディエンスセグメントを作成できます。
  • Experience Data Model (XDM):プラットフォームが顧客体験データを編成する際に使用する標準化されたフレームワーク。
  • Sandboxes: Experience Platform は、1つの Platform インスタンスを個別の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

以下の節では、Profile APIエンドポイントの呼び出しを正常に行うために知っておく必要がある追加情報について説明します。

API 呼び出し例の読み取り

Real-time Customer Profile APIドキュメントには、リクエストを正しくフォーマットする方法を示すAPI呼び出しの例が記載されています。 この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。サンプル API 呼び出しのドキュメントで使用されている規則については、Experience Platform トラブルシューテングガイドのサンプル API 呼び出しの読み方に関する節を参照してください。

必須ヘッダー

また、API ドキュメントでは、 エンドポイントを正しく呼び出すために、認証に関するチュートリアルを完了している必要があります。Platform次に示すように、認証チュートリアルで、Experience 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}

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

リクエスト本文にペイロードを持つすべてのリクエスト(POST、PUT、PATCH 呼び出しなど)には、Content-Type ヘッダーが含まれている必要があります。各呼び出しに固有の受け入れられた値は、呼び出しパラメーターに指定されます。

次の手順

Real-time Customer Profile APIを使用した呼び出しを開始するには、使用可能なエンドポイントガイドの1つを選択します。

このページ