Creates a new workflow execution

Creates a new, ad-hoc execution of an existing workflow. Workflow executions are asyncronous and will typically take at least 15 minutes to execute. Ad-hoc executions can be used for testing, development, or one-off reporting use-cases; periodic executions can be achieved by creating a schedule for a given workflow.

The output from the execution will be placed in your S3 bucket in a similar location to normal scheduled executions, and the location can be found by looking at the OutputS3URI property of a workflow execution. At this time, adhoc workflow executions may be run up to 30 times per day, per AMC instance. This limit applies across all Workflow IDs.

请求参数

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

workflowId

string

必需

timeWindowStart

string

必需

timeWindowEnd

string

必需

timeWindowType

string

必需

timeWindowTimeZone

string

必需

示例

{
    "workflowId":"my-first-workflow",
    "timeWindowStart": "2024-01-20T00:00:00",
    "timeWindowEnd": "2024-01-25T00:00:00",
    "timeWindowType": "EXPLICIT",
    "timeWindowTimeZone": "America/New_York"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Creates a new workflow execution

application/json

Body

createTime

string

必需

dataGaps

array

必需

disableAggregationControls

boolean

必需

executionCategory

string

必需

expireTime

string

必需

ignoreDataGaps

boolean

必需

lastUpdatedTime

string

必需

parameterValues

object

必需

status

string

必需

timeWindowEnd

string

必需

timeWindowEndOriginal

string

必需

timeWindowStart

string

必需

timeWindowStartOriginal

string

必需

timeWindowTimeZoneOriginal

string

必需

waitUntil

string

必需

workflowExecutionId

string

必需

workflowExecutionTimeoutSeconds

integer

必需

workflowId

string

必需

示例

{
    "createTime": "2024-09-25T03:11:52Z",
    "dataGaps": [],
    "disableAggregationControls": false,
    "executionCategory": "AD_HOC",
    "expireTime": "2024-09-26T03:11:52Z",
    "ignoreDataGaps": false,
    "lastUpdatedTime": "2024-09-25T03:11:52Z",
    "parameterValues": {},
    "status": "PENDING",
    "timeWindowEnd": "2024-01-25T05:00:00Z",
    "timeWindowEndOriginal": "2024-01-25T00:00:00",
    "timeWindowStart": "2024-01-20T05:00:00Z",
    "timeWindowStartOriginal": "2024-01-20T00:00:00",
    "timeWindowTimeZoneOriginal": "America/New_York",
    "waitUntil": "2024-09-25T02:11:52Z",
    "workflowExecutionId": "b3a77999-7c8e-4289-9bf9-5da8f178536c",
    "workflowExecutionTimeoutSeconds": 21600,
    "workflowId": "my-first-workflow"
}