Identity Service API ガイド

Adobe Experience Platform Identity Service は、Adobe Experience Platform内の ID グラフと呼ばれる、クロスデバイス、クロスチャネル、およびほぼリアルタイムでの顧客の識別を管理します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

Identity Service:顧客プロファイルデータの断片化によって生じる基本的な課題を解決します。これは、顧客がブランドと対話するデバイスやシステム間で ID を橋渡しするすることで実現します。
Real-Time Customer Profile:複数のソースからの集計データに基づいて、統合された消費者プロファイルをリアルタイムで提供します。
Experience Data Model (XDM)：Platform が、カスタマーエクスペリエンスデータを整理する際に使用する、標準化されたフレームワーク。

以下の節では、 Identity Service API

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

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

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

x-sandbox-name：{SANDBOX_NAME}

メモ

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

ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、次のような追加ヘッダーが必要です。

Content-Type: application/json

地域ベースのルーティング

この Identity Service API は、 {REGION} をリクエストパスの一部として追加します。 IMS 組織のプロビジョニング中に、地域が決定され、IMS Org プロファイル内に保存されます。各エンドポイントで正しい地域を使用すると、 Identity Service API は適切な地域にルーティングされます。

現在、 Identity Service API:VA7 と NLD2。

次の表に、地域を使用したパスの例を示します。

サービス	地域：VA7	地域：NLD2
Identity Service API	https://platform-va7.adobe.io/data/core/identity/	https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API	https://platform-va7.adobe.io/data/core/idnamespace/	https://platform-nld2.adobe.io/data/core/idnamespace

メモ

地域を指定しないでリクエストをおこなうと、誤った地域に対する呼び出しルーティングが発生したり、呼び出しが予期せず失敗したりする場合があります。

IMS Org プロファイル内で地域が見つからない場合は、システム管理者に問い合わせてください。

の使用 Identity Service API

これらのサービスで使用される ID パラメーターは、次の 2 つの方法、複合または XID のいずれかで表現できます。

複合 ID は、ID 値と名前空間の両方を含む構成です。複合 ID を使用する場合、名前空間は名前（namespace.code）または ID（namespace.id）で指定できます。

ID が永続化されると、 Identity Service はネイティブ ID(XID) と呼ばれる ID を生成し、その ID に割り当てます。クラスター API とマッピング API のすべてのバリエーションは、リクエストと応答で複合 ID と XID の両方をサポートしています。これらのAPIを使用するには、次のパラメーターのいずれかが必要です。xid、[nsまたはnsid]およびidの組み合わせ。

応答のペイロードを制限するため、API は、使用される ID 構文のタイプに応じて、それらの応答を調整します。つまり、XID を渡すと応答に XID が含まれ、複合 ID を渡すと、応答はリクエストで使用される構造に従います。

このドキュメントの例では、 Identity Service API 完全な API については、「Swagger API リファレンス」を参照してください。

メモ

リクエストでネイティブ XID が使用される場合、返される ID はすべてネイティブ XID 形式になります。ID／名前空間フォームの使用詳しくは、「ID の XID の取得」に関する節を参照してください。

次の手順

必要な資格情報を収集したので、開発者ガイドの残りをお読みください。各節では、エンドポイントに関する重要な情報を提供し、CRUD 操作を実行するための API 呼び出しの例を示します。各呼び出しには、一般的な API 形式、必要なヘッダーと適切な形式のペイロードを示すサンプルリクエスト、および正常な呼び出しのサンプル応答が含まれます。