Create a new schedule

POST

/amc/reporting/{{instanceId}}/schedules

最后修改时间：2025-03-16 02:19:30

责任人：未设置

Creates a new schedule. Schedules are used to specify the periodic execution of a given workflow, on either a daily or weekly cadence.

请求参数

Header 参数

Amazon-Advertising-API-ClientId

string

必需

(Required) The identifier of a client associated with an Amazon Developer account.

示例值:

Amazon-Advertising-API-MarketplaceId

string

必需

(Required) The marketplace identifier for the marketplace in the request. Marketplaces are tied to the country.

示例值:

Amazon-Advertising-API-AdvertiserId

string

必需

(Required) The AMC account identifier. Your Amazon Ads account executive would have provided you this identifier when you onboarded AMC. Alternatively, access the AMC console with your user identifier and password, and grab the entity identifier value that is displayed in the URL. The alphanumeric code that is prefixed with ENTITY is your account identifier. An example of an entity identifier is: ENTITY1AA1AA11AAA1.

示例值:

Authorization

string

必需

示例值:

Bearer {{access_token}}

Body 参数application/json

scheduleId

string

必需

workflowId

string

必需

aggregationHourUtc

integer

必需

aggregationPeriod

string

必需

aggregationStartDay

string

必需

scheduleEnabled

boolean

必需

requireSyntheticData

boolean

必需

disableAggregationControls

boolean

必需

示例

{
    "scheduleId": "my-first-schedule",
    "workflowId": "my-first-workflow",
    "aggregationHourUtc": 14,
    "aggregationPeriod": "Weekly",
    "aggregationStartDay": "Monday",
    "scheduleEnabled": true,
    "requireSyntheticData": true,
    "disableAggregationControls": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://www.amazon.com/ap/oa/amc/reporting/{{instanceId}}/schedules' \
--header 'Amazon-Advertising-API-ClientId: {{client_id}}' \
--header 'Amazon-Advertising-API-MarketplaceId: {{marketplace_id}}' \
--header 'Amazon-Advertising-API-AdvertiserId: {{advertiser_id}}' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scheduleId": "my-first-schedule",
    "workflowId": "my-first-workflow",
    "aggregationHourUtc": 14,
    "aggregationPeriod": "Weekly",
    "aggregationStartDay": "Monday",
    "scheduleEnabled": true,
    "requireSyntheticData": true,
    "disableAggregationControls": true
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

修改于 2025-03-16 02:19:30

Delete the requested workflow

List all schedules