List all workflows in a specific instance

Returns a list of workflows. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.

请求参数

Query 参数

nextToken

string

必需

Optional. Token to retrieve subsequent page of results.

limit

string

必需

Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200List all workflows in a specific instance

application/json

Body

workflows

array [object {5}]

必需

inputParameters

array [object {4}]

必需

sqlQuery

string

必需

workflowId

string

必需

outputColumns

array [object {3}]

必需

query

object

必需

示例

{
    "workflows": [
        {
            "inputParameters": [
                {
                    "dataType": {
                        "type": "ARRAY",
                        "elementDataType": "STRING",
                        "elementNullable": false
                    },
                    "defaultValue": [
                        "ALL"
                    ],
                    "description": "Enter description for parameter",
                    "name": "sa_campaigns"
                }
            ],
            "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",
            "workflowId": "my-first-workflow-with-custom-parameters"
        },
        {
            "inputParameters": [
                {
                    "dataType": {
                        "type": "ARRAY",
                        "elementDataType": "STRING",
                        "elementNullable": false
                    },
                    "defaultValue": [
                        "ALL"
                    ],
                    "description": "Enter description for parameter",
                    "name": "sa_campaigns"
                }
            ],
            "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",
            "workflowId": "AAAAA"
        },
        {
            "outputColumns": [
                {
                    "columnType": "DIMENSION",
                    "dataType": "LONG",
                    "name": "advertiser_id"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "STRING",
                    "name": "advertiser"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "LONG",
                    "name": "campaign_id"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "STRING",
                    "name": "campaign"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "TIMESTAMP",
                    "name": "campaign_start_date"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "TIMESTAMP",
                    "name": "campaign_end_date"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "DATE",
                    "name": "date"
                },
                {
                    "columnType": "DIMENSION",
                    "dataType": "DOUBLE",
                    "name": "frequency"
                }
            ],
            "query": {
                "operations": [
                    {
                        "type": "Select",
                        "columns": [
                            "impression_date",
                            "advertiser_id",
                            "advertiser",
                            "campaign_id",
                            "campaign",
                            "campaign_start_date",
                            "campaign_end_date",
                            "impressions",
                            "user_id"
                        ],
                        "inputData": "dsp_impressions",
                        "maxTimeAfterWindow": "PT0S",
                        "maxTimeBeforeWindow": "PT0S",
                        "name": "select_impressions"
                    },
                    {
                        "type": "RenameColumns",
                        "inputColumns": [
                            "impression_date"
                        ],
                        "name": "Rename",
                        "outputColumns": [
                            "date"
                        ]
                    },
                    {
                        "type": "Aggregate",
                        "aggregationType": "SUM",
                        "columnAggregationTypes": {
                            "user_id": "COUNT_DISTINCT"
                        },
                        "name": "SumMetrics"
                    },
                    {
                        "type": "Column",
                        "expression": {
                            "type": "Divide",
                            "firstValue": {
                                "type": "Cast",
                                "dataType": "DOUBLE",
                                "value": {
                                    "type": "Column",
                                    "column": "impressions"