Offer Library API に対して PATCH リクエストを実行することで、プレースメントを変更または更新できます。
使用可能な操作など、JSON パッチの詳細については、JSON パッチの公式ドキュメントを参照してください。
次の表に、リクエストヘッダーの「Content-Type」フィールドを構成する有効な値を示します。
ヘッダー名 | 値 |
---|---|
Content-Type | application/json |
API 形式
PATCH /{ENDPOINT_PATH}/placements/{ID}
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
永続性 API のエンドポイントパス。 | https://platform.adobe.io/data/core/dps/ |
{ID} |
更新するエンティティの ID。 | offerPlacement1234 |
リクエスト
curl -X PATCH 'https://platform.adobe.io/data/core/dps/placements/offerPlacement1234' \
-H 'Content-Type: application/json' \
-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": "/name",
"value": "Updated placement"
},
{
"op": "replace",
"path": "/description",
"value": "Updated placement description"
}
]'
パラメーター | 説明 |
---|---|
op |
接続の更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add 、replace 、remove 、copy および test があります。 |
path |
更新するパラメーターのパス。 |
value |
パラメーターの更新に使用する新しい値。 |
応答
正常な応答の場合は、一意のプレースメントid
など、プレースメントの最新の詳細が返されます。
{
"etag": 2,
"createdBy": "{CREATED_BY}",
"lastModifiedBy": "{MODIFIED_BY}",
"id": "{ID}",
"sandboxId": "{SANDBOX_ID}",
"createdDate": "2023-05-31T15:09:11.771Z",
"lastModifiedDate": "2023-05-31T15:09:11.771Z",
"createdByClientId": "{CREATED_CLIENT_ID}",
"lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}