Create a workflow with custom parameters

POST

/amc/reporting/{instanceId}/workflows

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

责任人：未设置

Creates a new workflow. The request body is used as the definition for the new workflow. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.

请求参数

Path 参数

Header 参数

Body 参数application/json

示例

{
    "workflowId": "my-first-workflow-with-custom-parameters",
    "sqlQuery": "SELECT campaign, SUM(IMPRESSIONS) AS Impressions FROM sponsored_ads_traffic WHERE ARRAY_CONTAINS(CUSTOM_PARAMETER('sa_campaigns'), 'ALL') OR ARRAY_CONTAINS(CUSTOM_PARAMETER('sa_campaigns'), campaign) GROUP BY 1",
    "inputParameters": [
        {
            "name": "sa_campaigns",
            "dataType": {
                "elementDataType": "STRING",
                "type": "ARRAY"
                },
            "column_type": "DIMENSION",
            "description": "Enter description for parameter",
            "defaultValue": [
                "ALL"
                ]
        }
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://advertising-api.amazon.com/amc/reporting/{{instanceId}}/workflows' \
--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 '{
    "workflowId": "my-first-workflow-with-custom-parameters",
    "sqlQuery": "SELECT campaign, SUM(IMPRESSIONS) AS Impressions FROM sponsored_ads_traffic WHERE ARRAY_CONTAINS(CUSTOM_PARAMETER('\''sa_campaigns'\''), '\''ALL'\'') OR ARRAY_CONTAINS(CUSTOM_PARAMETER('\''sa_campaigns'\''), campaign) GROUP BY 1",
    "inputParameters": [
        {
            "name": "sa_campaigns",
            "dataType": {
                "elementDataType": "STRING",
                "type": "ARRAY"
                },
            "column_type": "DIMENSION",
            "description": "Enter description for parameter",
            "defaultValue": [
                "ALL"
                ]
        }
    ]
}'

返回响应

🟢200Create a new workflow

text/plain

Body

示例

{}

🟢200Create a workflow with custom parameters

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

Create a workflow

List all workflows in a specific instance