Adobe Experience Platform APIの基本を学ぶ

Adobe Experience Platformは、「API ファースト」の理念の下に開発されました。 Experience Platform APIを使用すると、計算属性の設定、データ/エンティティへのアクセス、データの書き出し、不要なデータやバッチの削除など、データに対する基本的なCRUD (作成、読み取り、更新、削除)操作をプログラムで実行できます。

各Experience Platform サービスのAPIは、すべて同じ認証ヘッダーのセットを共有し、CRUD操作に同様の構文を使用します。 次のガイドでは、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 ヘッダーが含まれている必要があります。 使用できる値は、各API エンドポイントに固有です。 エンドポイントに特定のContent-Type値が必要な場合、その値は、個々のExperience Platform サービス 🔗に対するAPI ガイドで提供されるAPI リクエストの例に表示されます。

Experience Platform APIの基本

Adobe Experience Platform APIには、Experience Platform リソースを効果的に管理するために理解すべき重要な基盤テクノロジーと構文がいくつか用意されています。

JSON スキーマオブジェクトの例など、Experience Platformで使用される基盤となるAPI テクノロジーについて詳しくは、Experience Platform APIの基本 ガイドを参照してください。

Experience Platform API用Postman コレクション

Postmanは、事前設定された変数を使用した環境の設定、API コレクションの共有、CRUD リクエストの合理化などを可能にするAPI開発向けのコラボレーションプラットフォームです。 ほとんどのExperience Platform API サービスには、API呼び出しの実行を支援するために使用できるPostman コレクションがあります。

環境の設定方法、使用可能なコレクションのリスト、コレクションのインポート方法など、Postmanについて詳しくは、Experience Platform Postman ドキュメント ​を参照してください。

API 呼び出し例の読み取り sample-api

リクエスト形式は、使用されているExperience Platform APIによって異なります。 API呼び出しの構成方法を学ぶには、使用している特定のExperience Platform サービスのドキュメントに記載されている例に従うことが最適です。

Experience Platformのドキュメントには、2つの異なる方法でのAPI呼び出しの例が示されています。 まず、呼び出しは API 形式​で表されます。これは、操作(GET、POST、PUT、PATCH、DELETE など)と使用中のエンドポイント(例えば、/global/classes)のみを示すテンプレート表現です。 また、テンプレートには、GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} などの呼び出しの作成方法を示すために、変数の位置を示すものもあります。

その後、呼び出しは、リクエスト​内の cURL コマンドとして表示されます。これには、API とのやり取りに必要なヘッダーと完全な「ベースパス」が含まれます。 ベースパスは、すべてのエンドポイントの前に追加する必要があります。 例えば、前述の /global/classes エンドポイントは https://platform.adobe.io/data/foundation/schemaregistry/global/classes になります。 ドキュメント全体にAPI フォーマット / リクエストパターンが表示され、Experience Platform APIを独自に呼び出す際には、サンプルのリクエストに示す完全なパスを使用することが期待されます。

API リクエストの例

以下は、ドキュメントで使用される形式を示す API リクエストの例です。

API 形式

API 形式は、操作(GET)と使用されているエンドポイントを示します。 変数は中括弧で示されます(この場合は {CONTAINER_ID})。

GET /{CONTAINER_ID}/classes

リクエスト

この例のリクエストでは、API 形式の変数には、リクエストパス内の実際の値が与えられます。 さらに、必要なすべてのヘッダーは、サンプルヘッダー値または機密情報(セキュリティトークンやアクセス IDなど)を含める変数として表示されます。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

この応答は、送信されたリクエストに基づいて、API の呼び出しが成功した後に何を受け取るかを示します。 場合によっては、応答がスペースを節約するために切り捨てられいるため、サンプルに表示されている情報に加えて他の情報が表示されることがあります。

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

エラーメッセージ

Experience Platform トラブルシューティング ガイド ​には、任意のExperience Platform サービスを使用する際に発生する可能性のあるエラーの一覧が記載されています。

個々のExperience Platform サービスのトラブルシューティングガイドについては、​ サービストラブルシューティングディレクトリ ​を参照してください。

必須ヘッダーやリクエスト本文など、Experience Platform APIの特定のエンドポイントについて詳しくは、Experience Platform API ガイド ​を参照してください。

Experience Platform API ガイド api-guides

API ガイド
説明
Access Control API ガイド ​
Access Control API エンドポイントは、指定されたサンドボックス内の特定のリソースに対するユーザーに対して有効な現在のポリシーを取得できます。 その他すべてのアクセス制御機能は、Adobe Admin Consoleを通じて提供されます。
​ バッチ取り込みAPI ガイド ​
Adobe Experience Platform Data Ingestion APIでは、データをExperience Platformにバッチファイルとして取り込むことができます。 取り込むデータは、CRM システムのフラットファイル(Parquet ファイルなど)からのプロファイルデータ、またはSchema Registry (XDM)の既知のスキーマに準拠するデータです。
Catalog Service API ガイド ​
Catalog Service APIを使用すると、開発者はAdobe Experience Platformでデータセットのメタデータを管理できます。 これには、データの場所、処理段階、処理中に発生したエラー、データレポートが含まれます。
Data Access API ガイド ​
Data Access APIを使用すると、開発者はExperience Platform内で取り込まれたデータセットに関する情報を取得できます。 これには、データセットファイルへのアクセスとダウンロード、ヘッダー情報の取得、失敗したバッチと成功したバッチのリスト、プレビューCSV / Parquet ファイルのダウンロードが含まれます。
Dataset Service API ガイド ​
Dataset Service API を使用すると、データセットの使用ラベルを適用および編集できます。 これは Adobe Experience Platform のデータカタログ機能の一部ですが、データセットメタデータを管理する Catalog Service API とは別のものです。
Data Hygiene API guide
Data Hygiene APIを使用すると、Adobe Experience Platformに保存されている顧客の個人データをプログラムで修正または削除したり、データセットの有効期限をスケジュールしたりできます。
Edge Network API ガイド ​
Edge Network APIは、データ収集、パーソナライゼーション、広告、マーケティングのさまざまなユースケースに使用できます。 Edge Network APIは、サーバー、IoT デバイス、セットトップボックス、その他の様々なデバイスで使用できます。
Identity Service API ガイド ​
Identity Service APIを使用すると、開発者はAdobe Experience PlatformのID グラフを使用して、クロスデバイス、クロスチャネル、およびほぼリアルタイムの顧客IDを管理できます。
MTLS Service API guide
MTLS Service APIを使用すると、Adobeが発行した組織の公開証明書を安全に取得できます。
Observability Insights API ガイド ​
Observability Insightsは、開発者がAdobe Experience Platformで主要なオブザーバビリティ指標を公開できるようにするRESTful APIです。 これらの指標は、Experience Platformの使用状況に関する統計情報、Experience Platform サービスのヘルスチェック、過去の傾向、様々なExperience Platform機能のパフォーマンス指標に関するインサイトを提供します。
Policy Service API ガイド ​
(データガバナンス)
Policy Service APIを使用すると、データ使用ラベルとポリシーを作成および管理して、特定のデータ使用ラベルを含むデータに対してどのようなマーケティングアクションを実行できるかを決定できます。 データセットとフィールドにラベルを適用するには、Dataset Service API ガイドを参照してください
Privacy Service API ガイド ​
Privacy Service APIを使用すると、開発者は、法的なプライバシー規制に準拠して、Experience Cloud アプリケーション全体で個人データにアクセスまたは削除するための顧客リクエストを作成および管理できます。
Query Service API ガイド ​
Query Service APIを使用すると、開発者は標準のSQLを使用してAdobe Experience Platform データをクエリできます。
Real-Time Customer Profile API ガイド ​
Real-Time Customer Profile APIを使用すると、開発者は、プロファイルの表示、結合ポリシーの作成と更新、プロファイルデータの書き出しとサンプリング、不要になったプロファイルデータやエラーで追加されたプロファイルデータの削除など、プロファイルデータを検索して作業できます。
​ サンドボックス API ガイド ​
サンドボックス APIを使用すると、Adobe Experience Platform内の分離されたバーチャルサンドボックス環境をプログラムで管理できます。
Schema Registry API ガイド ​
(XDM)
Schema Registry APIを使用すると、開発者はAdobe Experience Platform内のすべてのスキーマと関連するExperience Data Model (XDM) リソースをプログラムで管理できます。
Segmentation Service API ガイド ​
Segmentation Service APIを使用すると、開発者はAdobe Experience Platformでセグメント化操作をプログラムで管理できます。 これには、セグメントの構築や、リアルタイム顧客プロファイルデータからのオーディエンスの生成が含まれます。
Adobe AI Machine Learning API ガイド ​
(Data Science Workspace)
Adobe AI Machine Learning APIは、アルゴリズムのオンボーディング、実験、サービスのデプロイメントに至るまで、データサイエンティストがマシンラーニング (ML) サービスを整理および管理するためのメカニズムを提供します。

各サービスで使用できる特定のエンドポイントと操作について詳しくは、Adobe I/OのAPI リファレンスドキュメント ​を参照してください。

次の手順

このドキュメントでは、必要なヘッダー、使用可能なガイド、API呼び出しの例を紹介しました。 Adobe Experience PlatformでAPI呼び出しを行うために必要なヘッダー値が得られたので、Experience Platform API ガイド テーブル ​から探索するAPI エンドポイントを選択します。

よくある質問に対する回答については、Experience Platformのトラブルシューティングガイド ​を参照してください。

Postman環境を設定し、使用可能なPostman コレクションを調べるには、Experience Platform Postman ガイド ​を参照してください。

recommendation-more-help
experience-platform-help-landing