このデベロッパーガイドでは、Offer Library API を使い始めるのに役立つ手順を説明します。次に、このガイドでは、意思決定エンジンを使用して主要な操作を実行するための API 呼び出しのサンプルを提供します。
➡️ 意思決定管理のコンポーネントについて詳しくは、このビデオを参照してください
このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。
ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
を呼び出すために Adobe Experience Platform API の場合、最初に 認証チュートリアル. 次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
ペイロード(POST、PUT、PATCH)を含んだすべてのリクエストには、以下の追加ヘッダーが必要です。
Content-Type: application/json
コンテナとは、異なる関心事を切り分けるための分離メカニズムです。コンテナ ID は、すべてのリポジトリ API の最初のパス要素です。すべての決定オブジェクトはコンテナ内に存在します。
管理者は、類似したプリンシパル、リソースおよびアクセス権限をプロファイルにグループ化できます。これにより、管理上の負担が軽減され、Adobe Admin Console でサポートされます。プロファイルを作成し、ユーザーを割り当てるには、組織内の Adobe Experience Platform の製品管理者である必要があります。1 回限りの手順で特定の権限に一致する製品プロファイルを作成し、その後、それらのユーザーにプロファイルを追加するだけで十分です。プロファイルは、権限が付与されたグループとして機能し、そのグループ内のすべての実際のユーザーまたは技術ユーザーは、権限を継承します。
管理者権限を付与された場合は、 Adobe Admin Console. For more information, see the Access control overview.
API 形式
GET /{ENDPOINT_PATH}?product={PRODUCT_CONTEXT}&property={PROPERTY}==decisioning
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
リポジトリ API のエンドポイントパス。 | https://platform.adobe.io/data/core/xcore/ |
{PRODUCT_CONTEXT} |
コンテナのリストを、製品コンテキストとの関連付けによってフィルターします。 | acp |
{PROPERTY} |
返されるコンテナの種類をフィルターします。 | _instance.containerType==decisioning |
リクエスト
curl -X GET \
'https://platform.adobe.io/data/core/xcore/?product=acp&property=_instance.containerType==decisioning' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
正常な応答では、意思決定管理コンテナに関する情報が返されます。これには instanceId
属性が含まれ、値がコンテナ ID になります。
{
"_embedded": {
"https://ns.adobe.com/experience/xcore/container": [
{
"instanceId": "{INSTANCE_ID}",
"schemas": [
"https://ns.adobe.com/experience/xcore/container;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2020-09-16T07:54:28.319959Z",
"repo:lastModifiedDate": "2020-09-16T07:54:32.098139Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"containerType": "decisioning",
"repo:name": "{REPO_NAME}",
"dataCenter": "{DATA_CENTER}",
"parentName": "{PARENT_NAME}",
"parentId": "{PARENT_ID}"
},
"_links": {
"self": {
"href": "/containers/{INSTANCE_ID}"
}
}
}
]
},
"_links": {
"self": {
"href": "/?product=acp&property=_instance.containerType==decisioning",
"@type": "https://ns.adobe.com/experience/xcore/hal/home"
}
}
}
このドキュメントでは、コンテナ ID の取得など、Offer Library API を呼び出すために必要な前提条件に関する知識を説明しました。これで、この開発者ガイドに記載されているサンプル呼び出しに進んで、その手順に従うことができます。
次のビデオは、「意思決定管理」のコンポーネントの理解をサポートするためのものです。