パーソナライズされたオファーは、実施要件ルールおよび制約に基づいてカスタマイズできるマーケティングメッセージです。
コンテナ ID を提供しながら Offer Library API に対して POST リクエストを実行することで、パーソナライズされたオファーを作成できます。
次の表に、リクエストヘッダーの Content-Type フィールドと Accept フィールドを構成する有効な値を示します。
ヘッダー名 | 値 |
---|---|
Accept | application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1 |
Content-Type | application/schema-instance+json; version=1; schema="https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5" |
API 形式
POST /{ENDPOINT_PATH}/{CONTAINER_ID}/instances
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
リポジトリ API のエンドポイントパス。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
パーソナライズされたオファーが配置されているコンテナ。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
リクエスト
curl -X POST \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances' \
-H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
-H 'Content-Type: application/schema-instance+json; version=1; schema="https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"' \
-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}' \
-d '{
"xdm:name": "Sale offer",
"xdm:status": "draft",
"xdm:representations": [
{
"xdm:components": [
{
"dc:language": [
"en"
],
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
"dc:format": "text/html"
}
],
"xdm:placement": "xcore:offer-placement:124e0be5699743d3"
}
],
"xdm:selectionConstraint": {
"xdm:startDate": "2020-10-01T16:00:00Z",
"xdm:endDate": "2021-12-13T16:00:00Z",
"xdm:eligibilityRule": "xcore:eligibility-rule:124e0faf5b8ee89b"
},
"xdm:rank": {
"xdm:priority": 1
},
"xdm:cappingConstraint": {
"xdm:globalCap": 150
},
"xdm:tags": [
"xcore:tag:124e147572cd7866"
]
}'
応答
正常な応答では、新たに作成されたパーソナライズされたオファーに関する情報(一意のインスタンス ID とプレースメント @id
を含む)が返されます。後の手順で、このインスタンス ID を使用してパーソナライズされたオファーを更新または削除できます。
{
"instanceId": "0f4bc230-13df-11eb-bc55-c11be7252432",
"@id": "xcore:personalized-offer:124e181c8b0d7878",
"repo:etag": 1,
"repo:createdDate": "2020-10-21T20:50:32.018624Z",
"repo:lastModifiedDate": "2020-10-21T20:50:32.018624Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}
Capping
など、オファー表示域および一部のオファー制約は現在、モバイル Experience Edge ワークフローではサポートされていません。Capping
フィールド値は、1 つのオファーをすべてのユーザーに対して提示できる回数を指定します。詳しくは、オファーの実施要件ルールと制約に関するドキュメントを参照してください。