您可以通过向以下网站发出PATCH请求,来修改或更新容器中的投放位置: Offer Library API。
有关JSON补丁程序的更多信息(包括可用的操作),请参阅官方网站上的 JSON修补程序文档.
下表显示了包含 内容类型 和 接受 请求标头中的字段:
标头名称 | 值 |
---|---|
Accept | application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1 |
Content-Type | application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4" |
API格式
PATCH /{ENDPOINT_PATH}/{CONTAINER_ID}/instances/{INSTANCE_ID}
参数 | 描述 | 示例 |
---|---|---|
{ENDPOINT_PATH} |
存储库API的端点路径。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
投放位置所在的容器。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{INSTANCE_ID} |
要更新的投放位置的实例ID。 | 9aa58fd0-13d7-11eb-928b-576735ea4db8 |
请求
curl -X PATCH \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/9aa58fd0-13d7-11eb-928b-576735ea4db8' \
-H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
-H 'Content-Type: application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4"' \
-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 '[
{
"op": "replace",
"path": "/_instance/xdm:name",
"value": "Sales and Promotions Placement"
},
{
"op": "replace",
"path": "/_instance/xdm:description",
"value": "A test placement to contain offers of sales and discounts"
}
]'
参数 | 描述 |
---|---|
op |
用于定义更新连接所需的操作的操作调用。 操作包括: add , replace 、和 remove . |
path |
要更新的参数的路径。 |
value |
您希望使用更新参数的新值。 |
响应
成功的响应将返回投放位置的更新详细信息,包括其唯一的实例ID和投放位置 @id
.
{
"instanceId": "9aa58fd0-13d7-11eb-928b-576735ea4db8",
"@id": "xcore:offer-placement:124e0be5699743d3",
"repo:etag": 2,
"repo:createdDate": "2020-10-21T19:57:09.837456Z",
"repo:lastModifiedDate": "2020-10-21T19:59:10.700149Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}