Policy Service API の概要

Policy Service API を使用すると、Adobe Experience Platform データガバナンスに関連する様々なリソースを作成および管理できます。このドキュメントでは、Policy Service API を呼び出す前に知っておく必要があるコア概念の概要を説明します。

前提条件

デベロッパーガイドを使用するには、データガバナンス機能の操作に関わる様々な Experience Platform サービスについて実際に理解しておく必要があります。Policy Service API の使用を開始する前に、次のサービスのドキュメントを確認してください。

  • データガバナンス:Experience Platform がデータ使用コンプライアンスを実施するためのフレームワーク。
  • Experience Data Model (XDM) System:顧客体験データを編成する際に Experience Platform に使用される標準化されたフレームワーク。
  • Real-time Customer Profile:複数のソースからの集計データに基づいて、統合されたリアルタイムの顧客プロファイルを提供します。
  • サンドボックス:Experience Platform は、単一の Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展を支援する仮想サンドボックスを提供します。

API 呼び出し例の読み取り

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

必須ヘッダー

また、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: application/json

コアリソースとカスタムリソース

Policy Service API 内では、ポリシーとマーケティングアクションはすべて、core リソースまたは custom リソースと呼ばれます。

core リソースとは、アドビが定義および保守するものです。 custom リソースとは、お客様の組織が作成および保守するものであり、お客様の IMS 組織のみに表示される一意のリソースです。このため、core リソースに対して許可される操作は、リストと参照の操作(GET)のみです。一方、custom リソースに対しては、リスト、参照、および更新の操作(POSTPUTPATCHDELETE)を使用できます。

次の手順

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

このページ