List all schedules - Amazon Ads API

请求参数

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}}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET '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}}'

返回响应

🟢200Returns a list of schedules

application/json

Body

schedules

array [object {8}]

必需

aggregationHourUtc

integer

必需

aggregationPeriod

string

必需

aggregationStartDay

string

必需

disableAggregationControls

boolean

必需

requireSyntheticData

boolean

必需

scheduleEnabled

boolean

必需

scheduleId

string

必需

workflowId

string

必需

示例

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