Real-Time Customer Profile API の概要 getting-started

Real-Time Customer Profile 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):Experience Platform が顧客体験データを整理するための標準的なフレームワーク。
  • Sandboxes:Experience Platform には、単一の Experience Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

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

API 呼び出し例の読み取り

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

必須ヘッダー

また、API ドキュメントでは、 エンドポイントを正しく呼び出すために、認証に関するチュートリアルを完了している必要があります。Experience Platform 次に示すように、Experience Platform API 呼び出しにおける各必須ヘッダーの値は認証チュートリアルで説明されています。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

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

  • x-sandbox-name: {SANDBOX_NAME}

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

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

次の手順

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

recommendation-more-help
experience-platform-help-profile