{ "openapi": "3.0.0", "info": { "title": "campaign_management", "description": "MCP tools related to campaign_management", "version": "v1" }, "paths": { "/mcp/delete_ad_association": { "post": { "operationId": "delete_ad_association", "description": "Delete Amazon Ads Ad Associations. Remove associations between ads and ad groups.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_ad_associationInputSchema" } } } }, "tags": [ "Ad Association" ] } }, "/mcp/query_ad": { "post": { "operationId": "query_ad", "description": "Query Amazon Ads with advanced filtering capabilities. Search and filter individual ads across all Amazon advertising products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_adInputSchema" } } } }, "tags": [ "Ad" ] } }, "/mcp/create_ad_association": { "post": { "operationId": "create_ad_association", "description": "Create Amazon Ads Ad Associations. Associate ads with ad groups across Amazon advertising products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ad_associationInputSchema" } } } }, "tags": [ "Ad Association" ] } }, "/mcp/query_ad_association": { "post": { "operationId": "query_ad_association", "description": "Query Amazon Ads Ad Associations with advanced filtering capabilities. Search for associations between ads and ad groups.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_ad_associationInputSchema" } } } }, "tags": [ "Ad Association" ] } }, "/mcp/create_target": { "post": { "operationId": "create_target", "description": "Create Amazon Ads Targets. Create targeting criteria including keywords, products, categories, and audiences.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_targetInputSchema" } } } }, "tags": [ "Target" ] } }, "/mcp/create_ad": { "post": { "operationId": "create_ad", "description": "Create Amazon Ads. Create individual ads within ad groups across all Amazon advertising products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_adInputSchema" } } } }, "tags": [ "Ad" ] } }, "/mcp/update_target": { "post": { "operationId": "update_target", "description": "Update Amazon Ads Targets. Modify targeting criteria including bids, state, and targeting parameters.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_targetInputSchema" } } } }, "tags": [ "Target" ] } }, "/mcp/check_product_eligibility": { "post": { "operationId": "check_product_eligibility", "description": "Checks whether products are eligible for a specific ad product type. Returns eligibility status per product with detail reasons and help URLs for resolving issues.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_product_eligibilityInputSchema" } } } }, "tags": [ "Eligibility" ] } }, "/mcp/update_campaign_state": { "post": { "operationId": "update_campaign_state", "description": "Update Campaign State.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_campaign_stateInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/query_portfolio": { "post": { "operationId": "query_portfolio", "description": "Query an Amazon Ads Portfolios.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_portfolioInputSchema" } } } }, "tags": [ "Portfolio" ] } }, "/mcp/update_ad": { "post": { "operationId": "update_ad", "description": "Update Amazon Ads. Modify individual ad settings including name and state.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_adInputSchema" } } } }, "tags": [ "Ad" ] } }, "/mcp/create_singleshot_portfolio": { "post": { "operationId": "create_singleshot_portfolio", "description": "Creates an Amazon Ads Portfolio and associates it with a campaign in a single operation.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_singleshot_portfolioInputSchema" } } } }, "tags": [ "Portfolio" ] } }, "/mcp/update_portfolio": { "post": { "operationId": "update_portfolio", "description": "Update an Amazon Ads Portfolios.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_portfolioInputSchema" } } } }, "tags": [ "Portfolio" ] } }, "/mcp/create_singleshot_sp_campaign": { "post": { "operationId": "create_singleshot_sp_campaign", "description": "Creates a complete Sponsored Products campaign (campaign + ad group + ads) across multiple marketplaces in a single operation. Supports both AUTO targeting (default) and MANUAL targeting with explicit targets. Use autoCreateTargets=false with a target field to create a MANUAL campaign. Creates ONE global campaign with country-specific budgets and ASINs, not separate campaigns per country.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_singleshot_sp_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/update_target_bid": { "post": { "operationId": "update_target_bid", "description": "Update Target Bid.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_target_bidInputSchema" } } } }, "tags": [ "Target" ] } }, "/mcp/create_portfolio": { "post": { "operationId": "create_portfolio", "description": "Create an Amazon Ads Portfolios.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_portfolioInputSchema" } } } }, "tags": [ "Portfolio" ] } }, "/mcp/update_campaign_budget": { "post": { "operationId": "update_campaign_budget", "description": "Update Campaign Budget.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_campaign_budgetInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/delete_ad": { "post": { "operationId": "delete_ad", "description": "Delete Amazon Ads. Remove individual ads from ad groups.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_adInputSchema" } } } }, "tags": [ "Ad" ] } }, "/mcp/delete_target": { "post": { "operationId": "delete_target", "description": "Delete Amazon Ads Targets. Remove targeting criteria from ad groups.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_targetInputSchema" } } } }, "tags": [ "Target" ] } }, "/mcp/update_ad_group": { "post": { "operationId": "update_ad_group", "description": "Update Amazon Ads Ad Groups. Modify ad group settings including name, state, and default bid.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ad_groupInputSchema" } } } }, "tags": [ "Ad Group" ] } }, "/mcp/delete_campaign": { "post": { "operationId": "delete_campaign", "description": "Delete Amazon Ads Campaigns. Remove campaigns and all associated ad groups, ads, and targets.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/update_ad_association": { "post": { "operationId": "update_ad_association", "description": "Update Amazon Ads Ad Associations. Modify associations between ads and ad groups.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ad_associationInputSchema" } } } }, "tags": [ "Ad Association" ] } }, "/mcp/query_ad_group": { "post": { "operationId": "query_ad_group", "description": "Query Amazon Ads Ad Groups with advanced filtering capabilities. Search and filter ad groups across all Amazon advertising products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_ad_groupInputSchema" } } } }, "tags": [ "Ad Group" ] } }, "/mcp/delete_ad_group": { "post": { "operationId": "delete_ad_group", "description": "Delete Amazon Ads Ad Groups. Remove ad groups and their associated ads from campaigns.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_ad_groupInputSchema" } } } }, "tags": [ "Ad Group" ] } }, "/mcp/create_ad_group": { "post": { "operationId": "create_ad_group", "description": "Create Amazon Ads Ad Groups. Create ad groups for organizing ads within campaigns across all Amazon advertising products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ad_groupInputSchema" } } } }, "tags": [ "Ad Group" ] } }, "/mcp/dsp_create_conversion_tracking_products": { "post": { "operationId": "dsp_create_conversion_tracking_products", "description": "Adds products to a DSP campaign to enable product-related conversion metrics. Newly added products will be appended to an existing list. Products may be added in batches of 2,000 and a campaign can track a maximum of 500,000 products.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dsp_create_conversion_tracking_productsInputSchema" } } } }, "tags": [ "Conversion" ] } }, "/mcp/query_target": { "post": { "operationId": "query_target", "description": "Query Amazon Ads Targets with advanced filtering capabilities. Search for keywords, products, categories, audiences, and other targeting options.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_targetInputSchema" } } } }, "tags": [ "Target" ] } }, "/mcp/update_campaign": { "post": { "operationId": "update_campaign", "description": "Update Amazon Ads Campaigns. Modify campaign settings including name, state, budget, and targeting options.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/create_campaign": { "post": { "operationId": "create_campaign", "description": "Create an Amazon Ads Campaign. This tools supports Sponsored Products, Sponsored Brands and ADSP.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/create_bid_adjustment_rule": { "post": { "operationId": "create_bid_adjustment_rule", "description": "Creates a bid adjustment rule and associates it with a DSP ad group. A bid adjustment rule contains dimension-based expressions with conditions and actions that define how bids are adjusted based on targeting dimensions such as device type, browser, geography, and more.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_bid_adjustment_ruleInputSchema" } } } }, "tags": [ "Bid Adjustment" ] } }, "/mcp/add_country_campaign": { "post": { "operationId": "add_country_campaign", "description": "Add countries to existing Amazon Ads Sponsored Products Manual campaigns with country-specific budget caps. Enables advertisers to expand campaign reach to new geographical markets while maintaining granular budget control per country. Only supports SPONSORED_PRODUCTS Manual campaigns. Only the first maximum 10 unique ASINs/SKUs under the campaign will be considered for ad creation under the given country code.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/add_country_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } }, "/mcp/query_campaign": { "post": { "operationId": "query_campaign", "description": "Query Amazon Ads Campaigns with advanced filtering capabilities. Supports Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored Television, and Amazon DSP campaigns.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_campaignInputSchema" } } } }, "tags": [ "Campaign" ] } } }, "components": { "schemas": { "delete_ad_associationInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] } ] }, "adAssociationIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accessRequestedAccount" ] } } }, "query_adInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroupIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adProductFilter": { "type": "object", "properties": { "include": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "description": "Only one ad product can be queried at a time." } }, "required": [ "include" ] }, "campaignIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "marketplaceScopeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] } } }, "required": [ "include" ] }, "maxResults": { "type": "integer" }, "nameFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "queryTermMatchType": { "type": "string", "enum": [ "BROAD_MATCH", "EXACT_MATCH" ] } }, "required": [ "include", "queryTermMatchType" ] }, "nextToken": { "type": "string" }, "stateFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] } } }, "required": [ "include" ] } }, "required": [ "accessRequestedAccount", "adProductFilter" ] } }, "required": [ "body" ] }, "create_ad_associationInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] } ] }, "adAssociations": { "type": "array", "items": { "type": "object", "properties": { "adGroupId": { "type": "string", "description": "The ad group associated with the ad." }, "adId": { "type": "string", "description": "The ad Id associated with the ad." }, "endDateTime": { "type": "string", "description": "The end date time for the ad association." }, "startDateTime": { "type": "string", "description": "The start date time for the ad association." }, "state": { "type": "string", "enum": [ "ENABLED", "PAUSED" ] }, "weight": { "type": "integer", "description": "The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group." } }, "required": [ "adGroupId", "adId", "state" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "query_ad_associationInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] } ] }, "adAssociationIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adGroupIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "maxResults": { "type": "integer" }, "nextToken": { "type": "string" } }, "required": [ "accessRequestedAccount" ] } } }, "create_targetInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "adGroupId": { "type": "string", "description": "A unique identifier for the ad group associated with the target. Only used for ad-group level targets." }, "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "bid": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "marketplaceSettings": { "type": "array", "description": "The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "currencyCode": { "type": "string", "enum": [ "AED", "AUD", "BRL", "CAD", "CHF", "CNY", "DKK", "EGP", "EUR", "GBP", "INR", "JPY", "MXN", "MXP", "NGN", "NOK", "NZD", "PLN", "SAR", "SEK", "SGD", "TRY", "USD", "ZAR" ] }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } } } } }, "campaignId": { "type": "string", "description": "A unique identifier for the campaign associated with the target. Only used for campaign-level targets." }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the target", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetDetails": { "oneOf": [ { "type": "object", "properties": { "keywordTarget": { "type": "object", "description": "Targets a specific customer search term.", "properties": { "keyword": { "type": "string", "description": "The customer search term or text to target" }, "matchType": { "type": "string", "description": "| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE. |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |", "enum": [ "BROAD", "EXACT", "MULTISIGNAL_BROAD", "PHRASE" ] }, "nativeLanguageKeyword": { "type": "string", "description": "The unlocalized keyword text in the preferred locale of the advertiser." }, "nativeLanguageLocale": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } } }, "required": [ "keywordTarget" ] }, { "type": "object", "properties": { "themeTarget": { "type": "object", "description": "Theme targets let advertisers select high-performing targets based on a common theme.", "properties": { "matchType": { "type": "string", "description": "| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |", "enum": [ "INTERESTED_AUDIENCE", "KEYWORDS_CLOSE_MATCH", "KEYWORDS_LOOSE_MATCH", "KEYWORDS_RELATED_TO_GIFTS", "KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY", "KEYWORDS_RELATED_TO_PRIME_DAY", "KEYWORDS_RELATED_TO_YOUR_BRAND", "KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES", "KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY", "PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS", "PRODUCT_COMPLEMENTS", "PRODUCT_SUBSTITUTES" ] } } } }, "required": [ "themeTarget" ] }, { "type": "object", "properties": { "inventorySourceTarget": { "type": "object", "description": "Target based on the source of the inventory.", "properties": { "inventorySourceId": { "type": "object", "properties": { "defaultValue": { "type": "string", "description": "The default value. Either the default value or the marketplace settings should always be specified" } } }, "inventorySourceType": { "type": "string", "description": "| InventorySourceType | Description |\n| --- | --- |\n| `AMAZON` | |\n| `APD` | |\n| `DEAL` | |\n| `INVENTORY_GROUP` | |\n| `THIRD_PARTY_EXCHANGE` | |", "enum": [ "AMAZON", "APD", "DEAL", "INVENTORY_GROUP", "THIRD_PARTY_EXCHANGE" ] } }, "required": [ "inventorySourceId", "inventorySourceType" ] } }, "required": [ "inventorySourceTarget" ] } ] } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "negative": { "type": "boolean", "description": "Indicates whether the target is negative or not." }, "state": { "type": "string", "description": "The user defined state for the resource. DRAFT applies to Amazon DSP targets only; every other ad product accepts ENABLED and PAUSED. Amazon DSP has no update-targets operation, so a draft target cannot be moved to another state afterwards - it can only be deleted.", "enum": [ "DRAFT", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the target", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetDetails": { "oneOf": [ { "type": "object", "properties": { "keywordTarget": { "type": "object", "description": "Targets a specific customer search term.", "properties": { "keyword": { "type": "string", "description": "The customer search term or text to target" }, "matchType": { "type": "string", "description": "| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE. |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |", "enum": [ "BROAD", "EXACT", "MULTISIGNAL_BROAD", "PHRASE" ] }, "nativeLanguageKeyword": { "type": "string", "description": "The unlocalized keyword text in the preferred locale of the advertiser." }, "nativeLanguageLocale": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } } }, "required": [ "keywordTarget" ] }, { "type": "object", "properties": { "productTarget": { "type": "object", "description": "Targets a specific product.", "properties": { "matchType": { "type": "string", "description": "| ProductMatchType | Description |\n| --- | --- |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |", "enum": [ "PRODUCT_EXACT", "PRODUCT_SIMILAR" ] }, "product": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The product id applicable at the specified marketplace." } } } }, "productId": { "type": "string", "description": "The product identifier. Either the product id or the marketplace settings should always be specified" } } }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } } } }, "required": [ "productTarget" ] }, { "type": "object", "properties": { "productCategoryTarget": { "type": "object", "description": "Targets a specific customer search term.", "properties": { "productCategoryRefinement": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productCategoryRefinement": { "type": "object", "properties": { "productAgeRangeId": { "type": "string", "description": "The age range ID to target." }, "productAgeRangeIdResolved": { "type": "string", "description": "The resolved age range to target." }, "productBrandId": { "type": "string", "description": "The brand ID to target." }, "productBrandIdResolved": { "type": "string", "description": "The resolved name of the brand." }, "productCategoryId": { "type": "string", "description": "The product category ID to target." }, "productCategoryIdResolved": { "type": "string", "description": "The resolved product category." }, "productGenreId": { "type": "string", "description": "The product genre ID to target." }, "productPriceGreaterThan": { "type": "number", "description": "Refinement to target products with a price greater than the value within the product category." }, "productPriceLessThan": { "type": "number", "description": "Refinement to target products with a price less than the value within the product category." }, "productPrimeShippingEligible": { "type": "boolean", "description": "Target based on if a product is Prime-shipping eligible." }, "productRatingGreaterThan": { "type": "number", "description": "Refinement to target products with a rating greater than the value within the product category." }, "productRatingLessThan": { "type": "number", "description": "Refinement to target products with a rating less than the value within the product category." } } } } } }, "productCategoryRefinement": { "type": "object", "properties": { "productAgeRangeId": { "type": "string", "description": "The age range ID to target." }, "productAgeRangeIdResolved": { "type": "string", "description": "The resolved age range to target." }, "productBrandId": { "type": "string", "description": "The brand ID to target." }, "productBrandIdResolved": { "type": "string", "description": "The resolved name of the brand." }, "productCategoryId": { "type": "string", "description": "The product category ID to target." }, "productCategoryIdResolved": { "type": "string", "description": "The resolved product category." }, "productGenreId": { "type": "string", "description": "The product genre ID to target." }, "productPriceGreaterThan": { "type": "number", "description": "Refinement to target products with a price greater than the value within the product category." }, "productPriceLessThan": { "type": "number", "description": "Refinement to target products with a price less than the value within the product category." }, "productPrimeShippingEligible": { "type": "boolean", "description": "Target based on if a product is Prime-shipping eligible." }, "productRatingGreaterThan": { "type": "number", "description": "Refinement to target products with a rating greater than the value within the product category." }, "productRatingLessThan": { "type": "number", "description": "Refinement to target products with a rating less than the value within the product category." } } } } }, "productGenreRefinement": { "type": "object", "properties": { "productGenreId": { "type": "string", "description": "The product genre ID to target." } } } } } }, "required": [ "productCategoryTarget" ] }, { "type": "object", "properties": { "productAudienceTarget": { "type": "object", "description": "Target customers who have viewed or purchased a certain product within a specified lookback window.", "properties": { "asin": { "type": "object", "properties": { "defaultValue": { "type": "string", "description": "The default value. Either the default value or the marketplace settings should always be specified" }, "marketplaceSettings": { "type": "array", "description": "The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "value": { "type": "string", "description": "The value applicable at the specified marketplace." } } } } } }, "event": { "type": "string", "enum": [ "PURCHASE", "VIEW" ] }, "lookback": { "type": "string", "enum": [ "DAYS_14", "DAYS_180", "DAYS_30", "DAYS_365", "DAYS_60", "DAYS_7", "DAYS_90" ] }, "matchType": { "type": "string", "enum": [ "PRODUCT_EXACT", "PRODUCT_SIMILAR" ] } } } }, "required": [ "productAudienceTarget" ] }, { "type": "object", "properties": { "audienceTarget": { "type": "object", "description": "Target based on a specified audience ID.", "properties": { "acrossGroupOperator": { "type": "string", "enum": [ "ALL", "ANY" ] }, "audienceId": { "type": "object", "properties": { "defaultValue": { "type": "string", "description": "The default value. Either the default value or the marketplace settings should always be specified" }, "marketplaceSettings": { "type": "array", "description": "The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "value": { "type": "string", "description": "The value applicable at the specified marketplace." } } } } } }, "groupId": { "type": "string", "description": "The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. '1'). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group." }, "inGroupOperator": { "type": "string", "enum": [ "ALL", "ANY" ] } } } }, "required": [ "audienceTarget" ] }, { "type": "object", "properties": { "locationTarget": { "type": "object", "description": "Target based on geographic location.", "properties": { "locationId": { "type": "string", "description": "The ID of the geographic location to target." }, "locationIdResolved": { "type": "string", "description": "A human-readable location text. It's a read-only field." } } } }, "required": [ "locationTarget" ] }, { "type": "object", "properties": { "domainTarget": { "type": "object", "description": "Target based on a specified domain.", "properties": { "domainTargetDetails": { "oneOf": [ { "type": "object", "properties": { "domainListTarget": { "type": "object", "description": "Targets domains based on an existing domain list.", "properties": { "domainListId": { "type": "string", "description": "The ID of the domain list to target." } } } }, "required": [ "domainListTarget" ] }, { "type": "object", "properties": { "domainNameTarget": { "type": "object", "description": "Targets domains based on URL.", "properties": { "domainName": { "type": "string", "description": "The URL of the domain to target." } } } }, "required": [ "domainNameTarget" ] }, { "type": "object", "properties": { "domainFileTarget": { "type": "object", "description": "Targets domains based on list provided via file upload.", "properties": { "domainFileKey": { "type": "string", "description": "The URL of the domain to target." }, "domainFileName": { "type": "string", "description": "The name of the file." } } } }, "required": [ "domainFileTarget" ] }, { "type": "object", "properties": { "advertiserDomainList": { "type": "object", "description": "Targets domains based on list inherited from the advertiser.", "properties": { "inheritFromAdvertiser": { "type": "boolean", "description": "Set to TRUE to inherit domain list from advertiser." } } } }, "required": [ "advertiserDomainList" ] } ] }, "domainTargetType": { "type": "string", "enum": [ "ADVERTISER_DOMAIN_LIST", "DOMAIN_FILE", "DOMAIN_LIST", "DOMAIN_NAME" ] } } } }, "required": [ "domainTarget" ] }, { "type": "object", "properties": { "appTarget": { "type": "object", "description": "Target based on user application.", "properties": { "appId": { "type": "string", "description": "The app identifier being targeted." }, "appType": { "type": "string", "enum": [ "MOBILE", "STREAMING_TV" ] } } } }, "required": [ "appTarget" ] }, { "type": "object", "properties": { "deviceTarget": { "type": "object", "description": "Target based on user device.", "properties": { "deviceOrientation": { "type": "string", "enum": [ "LANDSCAPE", "PORTRAIT" ] }, "deviceType": { "type": "string", "description": "| DeviceType | Description |\n| --- | --- |\n| `DESKTOP` | |\n| `MOBILE` | |\n| `CONNECTED_TV` | |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |", "enum": [ "CONNECTED_DEVICE", "CONNECTED_TV", "DESKTOP", "MOBILE" ] }, "mobileDevice": { "type": "string", "enum": [ "ANDROID", "IPAD", "IPHONE", "KINDLE_FIRE", "KINDLE_FIRE_HD" ] }, "mobileEnvironment": { "type": "string", "enum": [ "APP", "WEB" ] }, "mobileOs": { "type": "string", "enum": [ "ANDROID", "IOS" ] } } } }, "required": [ "deviceTarget" ] }, { "type": "object", "properties": { "dayPartTarget": { "type": "object", "description": "Target based on time of day.", "properties": { "dayOfWeek": { "type": "string", "enum": [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ] }, "timeOfDay": { "type": "object", "properties": { "endTime": { "type": "string", "description": "Selected end time" }, "startTime": { "type": "string", "description": "Selected start time" } } } } } }, "required": [ "dayPartTarget" ] }, { "type": "object", "properties": { "contentCategoryTarget": { "type": "object", "description": "Target based on the category of content being viewed.", "properties": { "contentCategoryId": { "type": "string", "description": "The content category ID being targeted." } } } }, "required": [ "contentCategoryTarget" ] }, { "type": "object", "properties": { "contentGenreTarget": { "type": "object", "description": "Target based on the genre of content being viewed.", "properties": { "contentGenre": { "type": "string", "enum": [ "ACTION", "ADVENTURE", "ALTERNATIVE_ROCK", "ANIMATION", "ARTS", "BIOGRAPHY", "BLUES", "BUSINESS", "CHILDRENS_MUSIC", "CHRISTIAN_GOSPEL", "CHRISTMAS_HOLIDAY", "CLASSICAL", "CLASSIC_ROCK", "COLLEGE_RADIO", "COMEDY", "COUNTRY", "CRIME", "DANCE_DJ", "DOCUMENTARY", "DRAMA", "EASY_LISTENING", "EDUCATION", "EUROPEAN_POP_FOLK", "FAMILY", "FANTASY", "FICTION", "FILM_NOIR", "FOLK", "FRENCH_VARIETY", "GAME_SHOW", "GENRE_NOT_AVAILABLE", "GERMAN_ROCK_POP", "GOVERNMENT", "HARD_ROCK_METAL", "HEALTH_AND_FITNESS", "HISTORY", "HORROR", "INTERNATIONAL", "JAPANESE", "JAZZ", "KIDS_AND_FAMILY", "LATIN_MUSIC", "LEISURE", "MISCELLANEOUS", "MUSIC", "MUSICAL", "MUSICALS_CABARET", "MYSTERY", "NEWS", "NEW_AGE", "OLDIES_ADULT_STANDARDS", "POP", "RAP_HIP_HOP", "RB", "REALITY_TV", "REGGAE_ISLAND", "RELIGION_AND_SPIRITUALITY", "ROCK", "ROMANCE", "SCIENCE", "SCIENCE_FICTION", "SHORT", "SOCIETY_AND_CULTURE", "SOUNDTRACKS", "SPORT", "SUPER_HERO", "TALK_SHOW", "TECHNOLOGY", "THRILLER", "TRUE_CRIME", "TV_AND_FILM", "WAR", "WESTERN" ] } } } }, "required": [ "contentGenreTarget" ] }, { "type": "object", "properties": { "contentRatingTarget": { "type": "object", "description": "Target based on the rating of content being viewed.", "properties": { "contentRatingType": { "type": "string", "enum": [ "DSP_CONTENT_RATING", "TWITCH_CONTENT_RATING" ] }, "contentRatingTypeDetails": { "oneOf": [ { "type": "object", "properties": { "dspContentRating": { "type": "object", "properties": { "dspContentRating": { "type": "string", "description": "| DspContentRatingEnum | Description |\n| --- | --- |\n| `SUITABLE_FOR_ALL_AUDIENCES` | Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). |\n| `SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE` | Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). |\n| `SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES` | Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). |\n| `SUITABLE_FOR_MATURE_AUDIENCES` | Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). |\n| `SUITABLE_FOR_ADULTS` | Ages 18+. Equivalent to content that is rated NC-17 (film). |\n| `RATING_NOT_AVAILABLE` | Content where rating isn't available from the publisher. |", "enum": [ "RATING_NOT_AVAILABLE", "SUITABLE_FOR_ADULTS", "SUITABLE_FOR_ALL_AUDIENCES", "SUITABLE_FOR_MATURE_AUDIENCES", "SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE", "SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES" ] } } } }, "required": [ "dspContentRating" ] }, { "type": "object", "properties": { "twitchContentRating": { "type": "object", "properties": { "twitchContentRating": { "type": "string", "description": "| TwitchContentRatingEnum | Description |\n| --- | --- |\n| `TWITCH_MODERATE` | Twitch Content with moderate content exclusions based on content classification labels received from Twitch. |\n| `TWITCH_RESTRICTIVE` | Twitch Content with restrictive content exlcusions based on content classification labels received from Twitch. |", "enum": [ "TWITCH_MODERATE", "TWITCH_RESTRICTIVE" ] } } } }, "required": [ "twitchContentRating" ] } ] } } } }, "required": [ "contentRatingTarget" ] }, { "type": "object", "properties": { "brandSafetyTierTarget": { "type": "object", "description": "Target based on the brand suitability risk levels of content being viewed.", "properties": { "brandSafetyTier": { "type": "string", "description": "| BrandSafetyTier | Description |\n| --- | --- |\n| `EXPANDED` | Tier that maximizes reach across all ad-eligible inventory. This tier is suitable for brands with a greater risk tolerance for advertising alongside a wide variety of content. |\n| `STANDARD` | Tier that offers broad reach and is the default for all campaigns. This tier is suitable for brands with a moderate risk tolerance for advertising alongside a wide variety of content. |\n| `RESTRICTIVE` | Tier that prioritizes brand suitability over reach. This tier is suitable for brands with the lowest risk tolerance for advertising alongside a wide variety of content. |", "enum": [ "EXPANDED", "RESTRICTIVE", "STANDARD" ] } } } }, "required": [ "brandSafetyTierTarget" ] }, { "type": "object", "properties": { "inventorySourceTarget": { "type": "object", "description": "Target based on the source of the inventory.", "properties": { "inventorySourceId": { "type": "object", "properties": { "defaultValue": { "type": "string", "description": "The default value. Either the default value or the marketplace settings should always be specified" }, "marketplaceSettings": { "type": "array", "description": "The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "value": { "type": "string", "description": "The value applicable at the specified marketplace." } } } } } }, "inventorySourceType": { "type": "string", "enum": [ "AMAZON", "APD", "DEAL", "INVENTORY_GROUP", "THIRD_PARTY_EXCHANGE" ] } } } }, "required": [ "inventorySourceTarget" ] }, { "type": "object", "properties": { "adInitiationTarget": { "type": "object", "description": "Target based on how the video ad will be started.", "properties": { "videoInitiationType": { "type": "string", "enum": [ "AUTOPLAY", "UNKNOWN", "USER_INITIATED" ] } } } }, "required": [ "adInitiationTarget" ] }, { "type": "object", "properties": { "adPlayerSizeTarget": { "type": "object", "description": "Target based on the size of the ad player.", "properties": { "adPlayerSize": { "type": "string", "enum": [ "LARGE", "MEDIUM", "SMALL", "UNKNOWN" ] } } } }, "required": [ "adPlayerSizeTarget" ] }, { "type": "object", "properties": { "videoAdFormatTarget": { "type": "object", "description": "Target based on the video ad format.", "properties": { "videoAdFormat": { "type": "string", "enum": [ "FULL_EPISODE_PLAYER", "INSTREAM", "OUTSTREAM" ] } } } }, "required": [ "videoAdFormatTarget" ] }, { "type": "object", "properties": { "thirdPartyTarget": { "type": "object", "properties": { "thirdPartyTargetDetails": { "oneOf": [ { "type": "object", "properties": { "doubleVerifyFraudInvalidTraffic": { "type": "object", "properties": { "blockAppAndSites": { "type": "boolean", "description": "Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen." }, "excludeAppsAndSites": { "type": "string", "enum": [ "ALLOW_ALL", "FRAUD_TRAFFIC_LEVEL_GTE_02", "FRAUD_TRAFFIC_LEVEL_GTE_04", "FRAUD_TRAFFIC_LEVEL_GTE_06", "FRAUD_TRAFFIC_LEVEL_GTE_08", "FRAUD_TRAFFIC_LEVEL_GTE_10", "FRAUD_TRAFFIC_LEVEL_GTE_100", "FRAUD_TRAFFIC_LEVEL_GTE_25", "FRAUD_TRAFFIC_LEVEL_GTE_50" ] }, "excludeImpressions": { "type": "boolean", "description": "Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid." } } } }, "required": [ "doubleVerifyFraudInvalidTraffic" ] }, { "type": "object", "properties": { "doubleVerifyStandardDisplayBrandSafety": { "type": "object", "properties": { "contentCategories": { "type": "array", "description": "A list of content categories to exclude from targeting.", "items": { "type": "string", "enum": [ "AD_SERVER", "CELEBRITY_GOSSIP", "CULTS_SURVIVALISM", "EXTREME_GRAPHIC", "GAMBLING", "INCENTIVIZED_MALWARE_CLUTTER", "INFLAMMATORY_POLITICS_NEWS", "NEGATIVE_NEWS_FINANCIAL", "NEGATIVE_NEWS_PHARMACEUTICAL", "NON_STANDARD_CONTENT_NON_ENGLISH", "NON_STANDARD_CONTENT_PARKING_PAGE", "OCCULT", "PIRACY_COPYRIGHT_INFRINGEMENT", "UNMODERATED_UGC_FORUMS_IMAGES_VIDEO" ] } }, "contentCategoriesWithRisk": { "type": "array", "items": { "type": "object", "description": "A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].", "properties": { "key": { "type": "string", "description": "Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC]." }, "value": { "type": "string", "description": "The Double Verify brand suitability risk level.\n| BrandSuitabilityRiskLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` | |\n| `HIGH` | |\n| `HIGH_MEDIUM` | |\n| `HIGH_MEDIUM_LOW` | |", "enum": [ "ALLOW_ALL", "HIGH", "HIGH_MEDIUM", "HIGH_MEDIUM_LOW" ] } } } }, "unknownContent": { "type": "boolean", "description": "Set to true to exclude unknown content." } } } }, "required": [ "doubleVerifyStandardDisplayBrandSafety" ] }, { "type": "object", "properties": { "doubleVerifyBrandSafety": { "type": "object", "properties": { "appAgeRating": { "type": "array", "description": "A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.", "items": { "type": "string", "enum": [ "ADULTS_ONLY_18_PLUS", "EVERYONE_4_PLUS", "MATURE_17_PLUS", "TEENS_12_PLUS", "TWEENS_9_PLUS", "UNKNOWN" ] } }, "appStarRating": { "type": "string", "description": "App star rating to be used for excluding apps.\n| DVBrandSafetyAppStarRatingType | Description |\n| --- | --- |\n| `ALLOW_ALL` | |\n| `APP_STAR_RATING_LT_1_POINT_5_STARS` | |\n| `APP_STAR_RATING_LT_2_STARS` | |\n| `APP_STAR_RATING_LT_2_POINT_5_STARS` | |\n| `APP_STAR_RATING_LT_3_STARS` | |\n| `APP_STAR_RATING_LT_3_POINT_5_STARS` | |\n| `APP_STAR_RATING_LT_4_STARS` | |\n| `APP_STAR_RATING_LT_4_POINT_5_STARS` | |", "enum": [ "ALLOW_ALL", "APP_STAR_RATING_LT_1_POINT_5_STARS", "APP_STAR_RATING_LT_2_POINT_5_STARS", "APP_STAR_RATING_LT_2_STARS", "APP_STAR_RATING_LT_3_POINT_5_STARS", "APP_STAR_RATING_LT_3_STARS", "APP_STAR_RATING_LT_4_POINT_5_STARS", "APP_STAR_RATING_LT_4_STARS" ] }, "contentCategories": { "type": "array", "description": "A list of content categories to exclude from targeting.", "items": { "type": "string", "enum": [ "AD_SERVER", "CELEBRITY_GOSSIP", "CULTS_SURVIVALISM", "EXTREME_GRAPHIC", "GAMBLING", "INCENTIVIZED_MALWARE_CLUTTER", "INFLAMMATORY_POLITICS_NEWS", "NEGATIVE_NEWS_FINANCIAL", "NEGATIVE_NEWS_PHARMACEUTICAL", "NON_STANDARD_CONTENT_NON_ENGLISH", "NON_STANDARD_CONTENT_PARKING_PAGE", "OCCULT", "PIRACY_COPYRIGHT_INFRINGEMENT", "UNMODERATED_UGC_FORUMS_IMAGES_VIDEO" ] } }, "contentCategoriesWithRisk": { "type": "array", "items": { "type": "object", "description": "A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].", "properties": { "key": { "type": "string", "description": "Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC]." }, "value": { "type": "string", "description": "The Double Verify brand suitability risk level.\n| BrandSuitabilityRiskLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` | |\n| `HIGH` | |\n| `HIGH_MEDIUM` | |\n| `HIGH_MEDIUM_LOW` | |", "enum": [ "ALLOW_ALL", "HIGH", "HIGH_MEDIUM", "HIGH_MEDIUM_LOW" ] } } } }, "excludeAppsWithInsufficientRating": { "type": "boolean", "description": "Set to true to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)." }, "unknownContent": { "type": "boolean", "description": "Set to true to exclude unknown content." } } } }, "required": [ "doubleVerifyBrandSafety" ] }, { "type": "object", "properties": { "doubleVerifyViewability": { "type": "object", "properties": { "averageCompletionAndFullyViewableRateTargeting": { "type": "string", "description": "The type of average completion and fully viewable rate targeting.", "enum": [ "ALLOW_ALL", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_10", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_20", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_25", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_30", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_35", "AVG_COMPLETION_FULLY_VIEWABLE_GTE_40" ] }, "brandExposureViewabilityTargeting": { "type": "string", "description": "The type of brand exposure viewability targeting.", "enum": [ "ALLOW_ALL", "BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION", "BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION", "BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION" ] }, "includeUnmeasurableImpressions": { "type": "boolean", "description": "Set to true to include impressions where impressions can't be measured." }, "mrcViewabilityTargeting": { "type": "string", "description": "The type of MRC viewability targeting.", "enum": [ "ALLOW_ALL", "MRC_VIEWABILITY_GTE_30", "MRC_VIEWABILITY_GTE_40", "MRC_VIEWABILITY_GTE_50", "MRC_VIEWABILITY_GTE_55", "MRC_VIEWABILITY_GTE_60", "MRC_VIEWABILITY_GTE_65", "MRC_VIEWABILITY_GTE_70", "MRC_VIEWABILITY_GTE_75", "MRC_VIEWABILITY_GTE_80" ] } } } }, "required": [ "doubleVerifyViewability" ] }, { "type": "object", "properties": { "doubleVerifyAuthenticBrandSafety": { "type": "object", "properties": { "doubleVerifySegmentId": { "type": "string" } } } }, "required": [ "doubleVerifyAuthenticBrandSafety" ] }, { "type": "object", "properties": { "doubleVerifyCustomContextualSegmentId": { "type": "object", "properties": { "doubleVerifySegmentId": { "type": "string" } } } }, "required": [ "doubleVerifyCustomContextualSegmentId" ] }, { "type": "object", "properties": { "doubleVerifyAuthenticAttention": { "type": "object", "properties": { "universalAttention": { "type": "boolean", "description": "One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains." } } } }, "required": [ "doubleVerifyAuthenticAttention" ] }, { "type": "object", "properties": { "integralAdScienceFraudInvalidTraffic": { "type": "object", "properties": { "targetSetting": { "type": "string", "description": "The type of fraud invalid traffic.", "enum": [ "ALLOW_ALL", "FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK", "FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK" ] } } } }, "required": [ "integralAdScienceFraudInvalidTraffic" ] }, { "type": "object", "properties": { "integralAdScienceBrandSafety": { "type": "object", "properties": { "excludeContent": { "type": "boolean", "description": "Set to true to exclude content that Integral Ad Science is not able to rate." }, "iasBrandSafetyAdult": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyAlcohol": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyGambling": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyHateSpeech": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyIllegalDownloads": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyIllegalDrugs": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyOffensiveLanguage": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] }, "iasBrandSafetyViolence": { "type": "string", "description": "The IAS brand safety risk level.", "enum": [ "ALLOW_ALL", "BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK", "BRAND_SAFETY_EXCLUDE_HIGH_RISK" ] } } } }, "required": [ "integralAdScienceBrandSafety" ] }, { "type": "object", "properties": { "integralAdScienceViewability": { "type": "object", "description": "The IAS viewability standard.", "properties": { "standard": { "type": "string", "enum": [ "GROUPM", "MRC", "NONE", "PUBLICIS" ] }, "viewabilityTargeting": { "type": "string", "description": "The type of viewability tier.", "enum": [ "ALLOW_ALL", "VIEWABILITY_TIER_GT_40", "VIEWABILITY_TIER_GT_50", "VIEWABILITY_TIER_GT_60", "VIEWABILITY_TIER_GT_70", "VIEWABILITY_TIER_LT_40" ] } } } }, "required": [ "integralAdScienceViewability" ] }, { "type": "object", "properties": { "integralAdScienceContextualTargeting": { "type": "object", "properties": { "topicalSegments": { "type": "array", "description": "The unique identifier of the IAS contextual topical targeting segment", "items": { "type": "string" } }, "verticalSegments": { "type": "array", "description": "The unique identifier of the IAS contextual vertical targeting segment", "items": { "type": "string" } } } } }, "required": [ "integralAdScienceContextualTargeting" ] }, { "type": "object", "properties": { "integralAdScienceContextualAvoidance": { "type": "object", "properties": { "avoidanceSegments": { "type": "array", "description": "The unique identifier of the IAS contextual avoidance segment", "items": { "type": "string" } } } } }, "required": [ "integralAdScienceContextualAvoidance" ] }, { "type": "object", "properties": { "pixalateFraudInvalidTraffic": { "type": "object", "properties": { "excludeAppsAndDomains": { "type": "boolean", "description": "Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid." }, "excludeIpAddressAndUserAgents": { "type": "boolean", "description": "Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid." }, "excludeOttAndMobileDevices": { "type": "boolean", "description": "Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid." }, "excludeRemovedAppsFromAppStores": { "type": "boolean", "description": "Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months." } } } }, "required": [ "pixalateFraudInvalidTraffic" ] }, { "type": "object", "properties": { "integralAdScienceQualitySync": { "type": "object", "properties": { "segmentId": { "type": "string" } } } }, "required": [ "integralAdScienceQualitySync" ] }, { "type": "object", "properties": { "newsGuardBrandGuardTrustedNewsTargeting": { "type": "object", "description": "Only applicable for Web supply.", "properties": { "targetingList": { "type": "array", "description": "The unique identifiers of trusted news targets", "items": { "type": "string", "enum": [ "BASIC_INCLUDE", "BUSINESS_INCLUDE", "COMMUNITY_INCLUDE", "HEALTH_INCLUDE", "HIGH_INCLUDE", "LIFESTYLE_INCLUDE", "LOCAL_INCLUDE", "MAX_INCLUDE", "POLITICS_INCLUDE", "TECH_INCLUDE" ] } } } } }, "required": [ "newsGuardBrandGuardTrustedNewsTargeting" ] }, { "type": "object", "properties": { "newsGuardBrandGuardMisinformationSafety": { "type": "object", "properties": { "avoidanceList": { "type": "array", "description": "The unique identifiers of misinformation targets", "items": { "type": "string", "enum": [ "AI_GENERATED_MFA", "BASIC_EXCLUDE", "CLIMATE_MISINFORMATION", "COVID_MISINFORMATION", "ELECTION_MISINFORMATION", "HEALTH_MISINFORMATION", "HIGH_EXCLUDE", "ISRAEL_HAMAS_MISINFORMATION", "MAX_EXCLUDE", "MISINFORMATION_SITES", "OPINIONATED_NEWS", "QANON_MISINFORMATION", "UKRAINE_MISINFORMATION", "VACCINE_MISINFORMATION" ] } } } } }, "required": [ "newsGuardBrandGuardMisinformationSafety" ] } ] }, "thirdPartyTargetType": { "type": "string", "enum": [ "DOUBLE_VERIFY_AUTHENTIC_ATTENTION", "DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY", "DOUBLE_VERIFY_BRAND_SAFETY", "DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID", "DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC", "DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY", "DOUBLE_VERIFY_VIEWABILITY", "INTEGRAL_AD_SCIENCE_BRAND_SAFETY", "INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE", "INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING", "INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC", "INTEGRAL_AD_SCIENCE_QUALITY_SYNC", "INTEGRAL_AD_SCIENCE_VIEWABILITY", "NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY", "NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING", "PIXALATE_FRAUD_INVALID_TRAFFIC" ] } } } }, "required": [ "thirdPartyTarget" ] }, { "type": "object", "properties": { "themeTarget": { "type": "object", "description": "Theme targets let advertisers select high-performing targets based on a common theme.", "properties": { "matchType": { "type": "string", "description": "| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |", "enum": [ "INTERESTED_AUDIENCE", "KEYWORDS_CLOSE_MATCH", "KEYWORDS_LOOSE_MATCH", "KEYWORDS_RELATED_TO_GIFTS", "KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY", "KEYWORDS_RELATED_TO_PRIME_DAY", "KEYWORDS_RELATED_TO_YOUR_BRAND", "KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES", "KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY", "PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS", "PRODUCT_COMPLEMENTS", "PRODUCT_SUBSTITUTES" ] } } } }, "required": [ "themeTarget" ] }, { "type": "object", "properties": { "contentInstreamPositionTarget": { "type": "object", "description": "Targets ads in the specified content instream position", "properties": { "instreamPosition": { "type": "string", "description": "| ContentInstreamPosition | Description |\n| --- | --- |\n| `PRE_ROLL` | |\n| `MID_ROLL` | |\n| `POST_ROLL` | |\n| `UNKNOWN` | |", "enum": [ "MID_ROLL", "POST_ROLL", "PRE_ROLL", "UNKNOWN" ] } } } }, "required": [ "contentInstreamPositionTarget" ] }, { "type": "object", "properties": { "contentOutstreamPositionTarget": { "type": "object", "description": "Targets ads in the specified content outstream position", "properties": { "outstreamPosition": { "type": "string", "description": "| ContentOutstreamPosition | Description |\n| --- | --- |\n| `STANDALONE` | |\n| `ACCOMPANYING_CONTENT` | |\n| `INTERSTITIAL` | |\n| `UNKNOWN` | |", "enum": [ "ACCOMPANYING_CONTENT", "INTERSTITIAL", "STANDALONE", "UNKNOWN" ] } } } }, "required": [ "contentOutstreamPositionTarget" ] }, { "type": "object", "properties": { "videoContentDurationTarget": { "type": "object", "description": "Targets ads to a specific video content duration", "properties": { "duration": { "type": "string", "description": "| VideoContentDuration | Description |\n| --- | --- |\n| `SHORT` | Video content duration of 0 to 10 minutes |\n| `MEDIUM` | Video content duration of 10 to 30 minutes |\n| `LONG` | Video content duration of 30 to 60 minutes |\n| `EXTENDED` | Video content duration of 60+ minutes |\n| `UNKNOWN` | Unknown video content duration |", "enum": [ "EXTENDED", "LONG", "MEDIUM", "SHORT", "UNKNOWN" ] } } } }, "required": [ "videoContentDurationTarget" ] }, { "type": "object", "properties": { "foldPositionTarget": { "type": "object", "description": "Targets ads in the specified fold position", "properties": { "foldPosition": { "type": "string", "enum": [ "ABOVE_THE_FOLD", "BELOW_THE_FOLD", "UNKNOWN" ] } } } }, "required": [ "foldPositionTarget" ] }, { "type": "object", "properties": { "nativeContentPositionTarget": { "type": "object", "description": "Targets ads to a specific native content position", "properties": { "nativePosition": { "type": "string", "description": "| NativeContentPosition | Description |\n| --- | --- |\n| `IN_ARTICLE` | Positioned in the atomic unit of the content (e.g., in the article page or single image page). |\n| `IN_FEED` | Positioned in the feed of content (e.g., as an item inside the organic feed, grid, listing, carousel, etc.). |\n| `PERIPHERAL` | Positioned utside the core content (e.g., in the ads section on the right rail, as a banner-style placement near the content, etc.). |\n| `RECOMMENDATION` | Positioned in recommendation widget; most commonly presented below article content. |\n| `UNKNOWN` | Unknown position. |", "enum": [ "IN_ARTICLE", "IN_FEED", "PERIPHERAL", "RECOMMENDATION", "UNKNOWN" ] } } } }, "required": [ "nativeContentPositionTarget" ] } ] }, "targetType": { "type": "string", "enum": [ "AD_INITIATION", "AD_PLAYER_SIZE", "APP", "AUDIENCE", "BRAND_SAFETY_TIER", "CONTENT_CATEGORY", "CONTENT_GENRE", "CONTENT_INSTREAM_POSITION", "CONTENT_OUTSTREAM_POSITION", "CONTENT_RATING", "DAYPART", "DEVICE", "DOMAIN", "FOLD_POSITION", "INVENTORY_SOURCE", "KEYWORD", "LOCATION", "NATIVE_CONTENT_POSITION", "PRODUCT", "PRODUCT_AUDIENCE", "PRODUCT_CATEGORY", "THEME", "THIRD_PARTY", "VIDEO_AD_FORMAT", "VIDEO_CONTENT_DURATION" ] } }, "required": [ "adProduct", "negative", "state", "targetDetails", "targetType" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "create_adInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "ads": { "type": "array", "items": { "type": "object", "properties": { "adGroupId": { "type": "string", "description": "The ad group associated with the ad." }, "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "adType": { "type": "string", "description": "| AdType | Description |\n| --- | --- |\n| `DISPLAY` | A creative that features one or more custom images. |\n| `VIDEO` | A creative that features one or more videos. |\n| `AUDIO` | A creative that features one or more audio assets. |\n| `THIRD_PARTY` | A creative that is served from a third party ad server. |\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n| `PRODUCT_AD` | A creative built based on a specified product. |", "enum": [ "AUDIO", "COMPONENT", "DISPLAY", "PRODUCT_AD", "THIRD_PARTY", "VIDEO" ] }, "creative": { "oneOf": [ { "type": "object", "properties": { "audioCreative": { "type": "object", "properties": { "standardAudioSettings": { "type": "object", "properties": { "audio": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the audio asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the audio asset." } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "array", "description": "The product(s) being advertised.", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] } } } } } } }, "required": [ "audioCreative" ] }, { "type": "object", "properties": { "displayCreative": { "type": "object", "properties": { "standardDisplaySettings": { "type": "object", "properties": { "adChoicesPosition": { "type": "string", "enum": [ "BOTTOM_LEFT", "BOTTOM_RIGHT", "TOP_LEFT", "TOP_RIGHT" ] }, "callToAction": { "oneOf": [ { "type": "object", "properties": { "clickToUrlDisplayCallToActionSettings": { "type": "object", "description": "A CTA that directs a customer to a provided url.", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The application url that customers are directed to." } } } }, "required": [ "clickToUrlDisplayCallToActionSettings" ] }, { "type": "object", "properties": { "clickToAppDisplayCallToActionSettings": { "type": "object", "description": "A CTA that directs a customer to a provided url.", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The app that customers are directed to." } } } }, "required": [ "clickToAppDisplayCallToActionSettings" ] } ] }, "clickTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an click is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "creativeSizes": { "type": "array", "description": "The list of placement sizes this creative should serve on.", "items": { "type": "object", "properties": { "height": { "type": "integer", "description": "The height of the creative placement." }, "width": { "type": "integer", "description": "The width of the creative placement." } } } }, "customImages": { "type": "array", "description": "The custom images to use for the standard display experience.", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the image asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the image asset." }, "formatProperties": { "type": "array", "description": "The cropping and positioning properties associated with the asset.", "items": { "type": "object", "properties": { "applyBorder": { "type": "boolean", "description": "Apply a boarder to the image to fit rules for some supplies." }, "height": { "type": "integer", "description": "The height (in pixels) of the cropped image." }, "left": { "type": "integer", "description": "The number of pixels from the left of the image where the crop should begin." }, "top": { "type": "integer", "description": "The number of pixels from the top of the image where the crop should begin." }, "width": { "type": "integer", "description": "The width (in pixels) of the cropped image." } } } } } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } } } } }, "required": [ "displayCreative" ] }, { "type": "object", "properties": { "videoCreative": { "type": "object", "properties": { "onlineVideoSettings": { "type": "object", "properties": { "callToActions": { "type": "array", "description": "The call to actions for this video.", "items": { "oneOf": [ { "type": "object", "properties": { "learnMoreVideoCallToActionSettings": { "type": "object", "properties": { "url": { "type": "string", "description": "The url to drive users to learn more via the video CallToAction." } } } }, "required": [ "learnMoreVideoCallToActionSettings" ] }, { "type": "object", "properties": { "clickToUrlVideoCallToActionSettings": { "type": "object", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The url to redirect the user via the video CallToAction." } } } }, "required": [ "clickToUrlVideoCallToActionSettings" ] } ] } }, "clickTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an click is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] }, "videos": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the video asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the video asset." } } } } }, "streamingTvSettings": { "type": "object", "properties": { "callToActions": { "type": "array", "description": "The call to actions for this video.", "items": { "oneOf": [ { "type": "object", "properties": { "learnMoreVideoCallToActionSettings": { "type": "object", "properties": { "url": { "type": "string", "description": "The url to drive users to learn more via the video CallToAction." } } } }, "required": [ "learnMoreVideoCallToActionSettings" ] }, { "type": "object", "properties": { "clickToUrlVideoCallToActionSettings": { "type": "object", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The url to redirect the user via the video CallToAction." } } } }, "required": [ "clickToUrlVideoCallToActionSettings" ] } ] } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "landingPage": { "type": "object", "properties": { "landingPageType": { "type": "string", "enum": [ "DETAIL_PAGE", "MOMENT", "OFF_AMAZON_LINK", "STORE" ] }, "landingPageUrl": { "type": "string", "description": "The URL of landing page where the ad directs." } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "array", "description": "The product advertised on this video creative.", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] } }, "videos": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the video asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the video asset." } } } } } } } }, "required": [ "videoCreative" ] }, { "type": "object", "properties": { "productCreative": { "type": "object", "properties": { "productCreativeSettings": { "type": "object", "description": "An ad with a creative built based on the product being advertised.", "properties": { "advertisedProduct": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] }, "headline": { "type": "string", "description": "The headline/custom text associated with the ad creative." } } } } } }, "required": [ "productCreative" ] }, { "type": "object", "properties": { "componentCreative": { "type": "object", "properties": { "responsiveEcommerceSettings": { "type": "object", "properties": { "language": { "description": "ISO-639 + ISO-3166 locale code, e.g. en_US", "type": "string" }, "inventoryTypes": { "description": "Inventory types this creative serves on", "type": "array", "items": { "enum": [ "DISPLAY", "NATIVE" ], "type": "string" } }, "products": { "description": "The products advertised for the Responsive eCommerce experience.", "type": "array", "items": { "type": "object", "properties": { "productId": { "description": "The identifier of the advertised product.", "type": "string" }, "productIdType": { "enum": [ "ASIN" ], "type": "string" } }, "required": [ "productIdType" ] } }, "creativePropertiesToOptimize": { "description": "The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.", "type": "array", "items": { "enum": [ "HEADLINE" ], "type": "string" } }, "optimizationGoalKpi": { "enum": [ "PURCHASE_RATE", "CLICK_THROUGH_RATE", "DETAIL_PAGE_VIEW_RATE" ], "type": "string" }, "responsiveSizingBehavior": { "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "supportedThirdPartySellers": { "enum": [ "NONE", "ALL" ], "type": "string" }, "headlines": { "description": "The headline to use for the Responsive eCommerce experience.", "type": "string" }, "disclaimers": { "description": "The disclaimer to use for the Responsive eCommerce experience.", "type": "string" }, "images": { "description": "The image(s) to use.", "type": "array", "items": { "type": "object", "properties": { "assetId": { "description": "The asset library ID associated with the image asset.", "type": "string" }, "assetVersion": { "description": "The asset library version associated with the image asset.", "type": "string" } }, "required": [ "assetId", "assetVersion" ] } }, "logos": { "type": "object", "properties": { "assetId": { "description": "The asset library ID associated with the image asset.", "type": "string" }, "assetVersion": { "description": "The asset library version associated with the image asset.", "type": "string" } }, "required": [ "assetId", "assetVersion" ] }, "landingPage": { "type": "object", "properties": { "landingPageType": { "type": "string" }, "landingPageUrl": { "description": "The URL of landing page where the ad directs.", "type": "string" } }, "required": [ "landingPageType", "landingPageUrl" ] }, "creativeSizes": { "description": "The placement sizes this creative should serve on.", "type": "array", "items": { "type": "object", "properties": { "height": { "description": "The height of the creative placement.", "type": "integer" }, "width": { "description": "The width of the creative placement.", "type": "integer" } }, "required": [ "height", "width" ] } }, "recAdVariations": { "description": "The rendering variations selected for the Responsive eCommerce experience.", "type": "array", "items": { "enum": [ "ADD_TO_CART", "COUPON", "CUSTOMER_REVIEWS", "SHOP_NOW" ], "type": "string" } }, "clickTrackingUrls": { "description": "The third party urls to trigger when a click is recorded.", "type": "array", "items": { "type": "object", "properties": { "url": { "description": "A url to be triggered for tracking events.", "type": "string" } }, "required": [ "url" ] } }, "impressionTrackingUrls": { "description": "The third party urls to trigger when an impression is recorded.", "type": "array", "items": { "type": "object", "properties": { "url": { "description": "A url to be triggered for tracking events.", "type": "string" } }, "required": [ "url" ] } } } } } } }, "required": [ "componentCreative" ] } ] }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the ad." }, "state": { "type": "string", "enum": [ "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } }, "required": [ "adProduct", "adType", "creative", "state" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "update_targetInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "bid": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "marketplaceSettings": { "type": "array", "description": "The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "currencyCode": { "type": "string", "enum": [ "AED", "AUD", "BRL", "CAD", "CHF", "CNY", "DKK", "EGP", "EUR", "GBP", "INR", "JPY", "MXN", "MXP", "NGN", "NOK", "NZD", "PLN", "SAR", "SEK", "SGD", "TRY", "USD", "ZAR" ] }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } } } } }, "campaignId": { "type": "string", "description": "A unique identifier for the campaign associated with the target. Only used for campaign-level targets." }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the target", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetDetails": { "oneOf": [ { "type": "object", "properties": { "keywordTarget": { "type": "object", "description": "Targets a specific customer search term.", "properties": { "keyword": { "type": "string", "description": "The customer search term or text to target" }, "matchType": { "type": "string", "description": "| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE. |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |", "enum": [ "BROAD", "EXACT", "MULTISIGNAL_BROAD", "PHRASE" ] }, "nativeLanguageKeyword": { "type": "string", "description": "The unlocalized keyword text in the preferred locale of the advertiser." }, "nativeLanguageLocale": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } } }, "required": [ "keywordTarget" ] }, { "type": "object", "properties": { "themeTarget": { "type": "object", "description": "Theme targets let advertisers select high-performing targets based on a common theme.", "properties": { "matchType": { "type": "string", "description": "| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |", "enum": [ "INTERESTED_AUDIENCE", "KEYWORDS_CLOSE_MATCH", "KEYWORDS_LOOSE_MATCH", "KEYWORDS_RELATED_TO_GIFTS", "KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY", "KEYWORDS_RELATED_TO_PRIME_DAY", "KEYWORDS_RELATED_TO_YOUR_BRAND", "KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES", "KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY", "PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS", "PRODUCT_COMPLEMENTS", "PRODUCT_SUBSTITUTES" ] } } } }, "required": [ "themeTarget" ] } ] } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| UpdateState | Description |\n| --- | --- |\n| `ENABLED` | |\n| `PAUSED` | |", "enum": [ "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the target", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetId": { "type": "string", "description": "A unique identifier for the target." } }, "required": [ "targetId" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "check_product_eligibilityInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header. Using this for Eligibility will only get you responses for the individual country associated with the profileId." } }, "required": [ "profileId" ] } ] }, "adProduct": { "type": "string", "description": "The advertising product type to check eligibility for. Only SPONSORED_PRODUCTS is supported for global advertiser.", "enum": [ "SPONSORED_PRODUCTS", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "AMAZON_DSP" ] }, "language": { "type": "string", "description": "The language for eligibility messages. Defaults to en_US if not provided.", "enum": [ "ar_AE", "de_DE", "en_AU", "en_CA", "en_GB", "en_IN", "en_US", "es_ES", "es_MX", "fr_CA", "fr_FR", "it_IT", "ja_JP", "ko_KR", "nl_NL", "pt_BR", "tr_TR", "zh_CN" ] }, "products": { "type": "array", "description": "List of products to check eligibility for.", "minItems": 1, "maxItems": 30, "items": { "type": "object", "properties": { "productId": { "type": "string", "description": "The identifier of the product (e.g., ASIN or SKU value)." }, "productIdType": { "type": "string", "description": "The type of product identifier. Only ASIN is supported for global advertiser.", "enum": [ "ASIN", "SKU" ] }, "marketplace": { "type": "string", "description": "The marketplace country code for this product.", "enum": [ "AE", "AU", "BE", "BR", "CA", "CL", "CO", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NG", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "globalStoreSetting": { "type": "object", "description": "Optional global store setting to scope eligibility evaluation.", "properties": { "catalogSourceCountryCode": { "type": "string", "description": "Country code of source marketplace where seller has listed the product. Possible source country codes include US, UK, DE, JP, and AE.", "minLength": 2, "maxLength": 2 } } } }, "required": [ "productId", "productIdType", "marketplace" ] } } }, "required": [ "accessRequestedAccount", "adProduct", "products" ] } } }, "update_campaign_stateInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "campaignId": { "type": "string", "description": "A unique identifier for a campaign." } }, "required": [ "campaignId", "state" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "query_portfolioInputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "marketplaceScopeFilter": { "type": "object", "properties": { "include": { "type": "array", "description": "| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` | |\n| `SINGLE_MARKETPLACE` | |", "maxItems": 1, "minItems": 1, "items": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] } } }, "required": [ "include" ] }, "nameFilter": { "type": "object", "properties": { "queryTermMatchType": { "type": "string", "enum": [ "EXACT_MATCH", "BROAD_MATCH" ] }, "include": { "type": "array", "maxItems": 100, "minItems": 1, "items": { "type": "string" } } }, "required": [ "include", "queryTermMatchType" ] }, "portfolioIdFilter": { "type": "object", "properties": { "include": { "type": "array", "maxItems": 1000, "minItems": 1, "items": { "type": "string" } } }, "required": [ "include" ] }, "stateFilter": { "type": "object", "properties": { "include": { "type": "array", "description": "| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |", "maxItems": 1, "minItems": 1, "items": { "type": "string", "enum": [ "ENABLED", "PAUSED", "ARCHIVED" ] } } }, "required": [ "include" ] }, "nextToken": { "type": "string" }, "maxResults": { "type": "integer", "default": 5000, "maximum": 5000, "minimum": 0 }, "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] } }, "required": [ "accessRequestedAccount" ] } } }, "update_adInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "ads": { "type": "array", "items": { "type": "object", "properties": { "adId": { "type": "string", "description": "The identifier of the ad." }, "creative": { "oneOf": [ { "type": "object", "properties": { "audioCreative": { "type": "object", "properties": { "standardAudioSettings": { "type": "object", "properties": { "audio": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the audio asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the audio asset." } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "array", "description": "The product(s) being advertised.", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] } } } } } } }, "required": [ "audioCreative" ] }, { "type": "object", "properties": { "displayCreative": { "type": "object", "properties": { "standardDisplaySettings": { "type": "object", "properties": { "adChoicesPosition": { "type": "string", "enum": [ "BOTTOM_LEFT", "BOTTOM_RIGHT", "TOP_LEFT", "TOP_RIGHT" ] }, "callToAction": { "oneOf": [ { "type": "object", "properties": { "clickToUrlDisplayCallToActionSettings": { "type": "object", "description": "A CTA that directs a customer to a provided url.", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The application url that customers are directed to." } } } }, "required": [ "clickToUrlDisplayCallToActionSettings" ] }, { "type": "object", "properties": { "clickToAppDisplayCallToActionSettings": { "type": "object", "description": "A CTA that directs a customer to a provided url.", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The app that customers are directed to." } } } }, "required": [ "clickToAppDisplayCallToActionSettings" ] } ] }, "clickTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an click is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "creativeSizes": { "type": "array", "description": "The list of placement sizes this creative should serve on.", "items": { "type": "object", "properties": { "height": { "type": "integer", "description": "The height of the creative placement." }, "width": { "type": "integer", "description": "The width of the creative placement." } } } }, "customImages": { "type": "array", "description": "The custom images to use for the standard display experience.", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the image asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the image asset." }, "formatProperties": { "type": "array", "description": "The cropping and positioning properties associated with the asset.", "items": { "type": "object", "properties": { "applyBorder": { "type": "boolean", "description": "Apply a boarder to the image to fit rules for some supplies." }, "height": { "type": "integer", "description": "The height (in pixels) of the cropped image." }, "left": { "type": "integer", "description": "The number of pixels from the left of the image where the crop should begin." }, "top": { "type": "integer", "description": "The number of pixels from the top of the image where the crop should begin." }, "width": { "type": "integer", "description": "The width (in pixels) of the cropped image." } } } } } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } } } } }, "required": [ "displayCreative" ] }, { "type": "object", "properties": { "videoCreative": { "type": "object", "properties": { "onlineVideoSettings": { "type": "object", "properties": { "callToActions": { "type": "array", "description": "The call to actions for this video.", "items": { "oneOf": [ { "type": "object", "properties": { "learnMoreVideoCallToActionSettings": { "type": "object", "properties": { "url": { "type": "string", "description": "The url to drive users to learn more via the video CallToAction." } } } }, "required": [ "learnMoreVideoCallToActionSettings" ] }, { "type": "object", "properties": { "clickToUrlVideoCallToActionSettings": { "type": "object", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The url to redirect the user via the video CallToAction." } } } }, "required": [ "clickToUrlVideoCallToActionSettings" ] } ] } }, "clickTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an click is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } } }, "videos": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the video asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the video asset." } } } } }, "streamingTvSettings": { "type": "object", "properties": { "callToActions": { "type": "array", "description": "The call to actions for this video.", "items": { "oneOf": [ { "type": "object", "properties": { "learnMoreVideoCallToActionSettings": { "type": "object", "properties": { "url": { "type": "string", "description": "The url to drive users to learn more via the video CallToAction." } } } }, "required": [ "learnMoreVideoCallToActionSettings" ] }, { "type": "object", "properties": { "clickToUrlVideoCallToActionSettings": { "type": "object", "properties": { "deepLinkingBehavior": { "type": "string", "enum": [ "DISABLED", "ENABLED" ] }, "url": { "type": "string", "description": "The url to redirect the user via the video CallToAction." } } } }, "required": [ "clickToUrlVideoCallToActionSettings" ] } ] } }, "impressionTrackingUrls": { "type": "array", "description": "The third party urls to trigger when an impression is recorded.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "A url to be triggered for tracking events." } } } }, "language": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] }, "products": { "type": "array", "description": "The product advertised on this video creative.", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } }, "required": [ "productIdType" ] } }, "videos": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The asset library ID associated with the video asset." }, "assetVersion": { "type": "string", "description": "The asset library version associated with the video asset." } } } } } } } }, "required": [ "videoCreative" ] }, { "type": "object", "properties": { "productCreative": { "type": "object", "properties": { "productCreativeSettings": { "type": "object", "description": "An ad with a creative built based on the product being advertised.", "properties": { "advertisedProduct": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplaceSettings": { "type": "array", "description": "List of advertised product selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "globalStoreSetting": { "type": "object", "properties": { "catalogSourceMarketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "The identifier of the product advertised." } } } }, "productId": { "type": "string", "description": "The identifier of the advertised product." }, "productIdType": { "type": "string", "enum": [ "ASIN", "SKU" ] } } } } } } } }, "required": [ "productCreative" ] } ] }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the ad." }, "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery", "enum": [ "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } }, "required": [ "adId" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "create_singleshot_portfolioInputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "portfolios": { "type": "array", "description": "List of portfolio requests. Each creates a new portfolio or associates an existing portfolio with a campaign.", "maxItems": 5, "minItems": 1, "items": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "The campaign ID to associate the portfolio with." }, "portfolioId": { "type": "string", "description": "The portfolio ID to use. When provided, portfolio creation is skipped and the existing portfolio is associated with the campaign directly." }, "name": { "type": "string", "description": "The name of the portfolio." }, "marketplaceScope": { "type": "string", "description": "| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` | |\n| `SINGLE_MARKETPLACE` | |", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "The list of country codes representing amazon marketplaces in which the portfolio is applicable.", "maxItems": 30, "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "budget": { "type": "object", "properties": { "recurrenceTimePeriod": { "type": "string", "description": "| Recurrence | Description |\n| --- | --- |\n| `DAILY` | |\n| `MONTHLY` | |\n| `LIFETIME` | |", "enum": [ "DAILY", "MONTHLY", "LIFETIME" ] }, "budgetType": { "type": "string", "description": "| BudgetType | Description |\n| --- | --- |\n| `MONETARY` | |", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] }, "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level.", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } }, "required": [ "marketplace", "monetaryBudget" ] } } } } }, "required": [ "monetaryBudgetValue" ] } ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] }, "startDateTime": { "type": "string", "description": "The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME." }, "endDateTime": { "type": "string", "description": "The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME." }, "state": { "type": "string", "description": "| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |", "enum": [ "ENABLED", "PAUSED" ] }, "budgetControls": { "type": "object", "properties": { "campaignBudgetSharing": { "type": "object", "properties": { "shareUnspentCampaignBudget": { "type": "string", "description": "| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "shareUnspentCampaignBudget" ] } }, "required": [ "campaignBudgetSharing" ] }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "description": "| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |", "enum": [ "ENABLED", "PAUSED", "ARCHIVED" ] }, "startDateTime": { "type": "string", "description": "The start date time for the Portfolio." }, "endDateTime": { "type": "string", "description": "The end date time for the Portfolio." } } } }, "required": [ "marketplace", "overrides" ] } } }, "required": [ "campaignId" ] } }, "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] } }, "required": [ "accessRequestedAccount" ] } } }, "update_portfolioInputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "portfolios": { "type": "array", "maxItems": 1000, "minItems": 1, "items": { "type": "object", "properties": { "portfolioId": { "type": "string", "description": "A unique identifier for a portfolio" }, "name": { "type": "string", "description": "The name of the portfolio" }, "marketplaces": { "type": "array", "description": "The list of country codes representing amazon marketplaces in which the portfolio is applicable", "maxItems": 30, "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "budget": { "type": "object", "properties": { "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "MONTHLY", "LIFETIME" ] }, "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } } }, "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } }, "required": [ "marketplace", "monetaryBudget" ] } } } } }, "required": [ "monetaryBudgetValue" ] } ] } } }, "startDateTime": { "type": "string", "description": "The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME" }, "endDateTime": { "type": "string", "description": "The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME" }, "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery", "enum": [ "ENABLED", "PAUSED" ] }, "budgetControls": { "type": "object", "properties": { "campaignBudgetSharing": { "type": "object", "properties": { "shareUnspentCampaignBudget": { "type": "string", "description": "| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |", "enum": [ "ENABLED", "DISABLED" ] } } } } }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |", "enum": [ "ENABLED", "PAUSED", "ARCHIVED" ] }, "startDateTime": { "type": "string", "description": "The start date time for the Portfolio" }, "endDateTime": { "type": "string", "description": "The end date time for the Portfolio" }, "budgetControls": { "type": "object", "properties": { "campaignBudgetSharing": { "type": "object", "properties": { "shareUnspentCampaignBudget": { "type": "string", "description": "| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "shareUnspentCampaignBudget" ] } }, "required": [ "campaignBudgetSharing" ] } } } }, "required": [ "marketplace", "overrides" ] } } }, "required": [ "portfolioId" ] } }, "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] } }, "required": [ "accessRequestedAccount" ] } } }, "create_singleshot_sp_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "oneshotCampaigns": { "type": "array", "description": "List of oneshot campaign requests. Each creates campaign + ad group + ads.", "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "marketplaces": { "type": "array", "description": "List of marketplaces where the campaign will run.", "items": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "campaignName": { "type": "string", "description": "Name for the campaign. Default: SP|Auto|Campaign [timestamp]" }, "startDateTime": { "type": "string", "description": "Campaign start date and time in ISO 8601 format. Default: current timestamp" }, "budgets": { "type": "object", "description": "Budget configuration for the campaign.", "properties": { "budgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "Budget settings per marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "Marketplace code.", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "Daily budget amount." } }, "required": [ "value" ] } }, "required": [ "marketplace", "monetaryBudget" ] } } } } }, "required": [ "budgetValue" ] }, "portfolioId": { "type": "string", "description": "Portfolio ID to organize the campaign." }, "adGroupName": { "type": "string", "description": "Name for the ad group. Default: SP|Auto|AdGroup [timestamp]" }, "bid": { "type": "object", "description": "Bid configuration for the ad group.", "properties": { "marketplaceSettings": { "type": "array", "description": "Bid settings per marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "Marketplace code.", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "defaultBid": { "type": "number", "description": "The default maximum bid for ads and targets in the ad group." } }, "required": [ "marketplace", "defaultBid" ] } } } }, "creative": { "type": "object", "description": "Creative configuration for product ads.", "properties": { "productCreativeSettings": { "type": "object", "properties": { "advertisedProduct": { "type": "object", "properties": { "productIdType": { "type": "string", "description": "Type of product identifier.", "enum": [ "ASIN" ], "default": "ASIN" }, "marketplaceSettings": { "type": "array", "description": "Product settings per marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "Marketplace code.", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "productId": { "type": "string", "description": "Product identifier (ASIN) to advertise." } }, "required": [ "marketplace", "productId" ] } } }, "required": [ "productIdType" ] } }, "required": [ "advertisedProduct" ] } }, "required": [ "productCreativeSettings" ] }, "autoCreateTargets": { "type": "boolean", "description": "When true, creates an auto campaign where Amazon automatically targets. When false, creates a manual campaign requiring explicit targets. Defaults to true." }, "target": { "type": "object", "description": "Target to create. Required when autoCreateTargets is false.", "properties": { "targetType": { "type": "string", "description": "The type of target.", "enum": [ "KEYWORD", "PRODUCT", "PRODUCT_CATEGORY", "THEME", "LOCATION" ] }, "negative": { "type": "boolean", "description": "Indicates whether the target is negative or not." }, "targetDetails": { "type": "object", "description": "The details associated with the target, based on the target type.", "properties": { "keywordTarget": { "type": "object", "description": "Targets a specific customer search term.", "properties": { "keyword": { "type": "string", "description": "The customer search term or text to target." }, "matchType": { "type": "string", "description": "The match type associated to the target.", "enum": [ "BROAD", "PHRASE", "EXACT" ] } }, "required": [ "keyword", "matchType" ] }, "productTarget": { "type": "object", "description": "Targets a specific product.", "properties": { "productIdType": { "type": "string", "description": "The type of product and associated identifier.", "enum": [ "ASIN", "SKU" ] }, "matchType": { "type": "string", "description": "The match type associated to the target.", "enum": [ "PRODUCT_EXACT", "PRODUCT_SIMILAR" ] }, "product": { "type": "object", "description": "The product identifier associated to the product target.", "properties": { "marketplaceSettings": { "type": "array", "description": "The product ids at specific marketplace level.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A country code representing an Amazon marketplace." }, "productId": { "type": "string", "description": "The product id applicable at the specified marketplace. Product id depends on the used productIdType. For sellers in Sponsored Products, SKU is used instead of ASIN." } }, "required": [ "marketplace", "productId" ] } } }, "required": [ "marketplaceSettings" ] } }, "required": [ "productIdType", "matchType", "product" ] }, "productCategoryTarget": { "type": "object", "properties": { "productCategoryRefinement": { "type": "object", "description": "The product category to target.", "properties": { "marketplaceSettings": { "type": "array", "description": "Marketplace specific product category refinements.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A country code representing an Amazon marketplace." }, "productCategoryRefinement": { "type": "object", "description": "Refinements within the product category.", "properties": { "productAgeRangeId": { "type": "string", "description": "The age range ID to target. This information is supplied from Discovery APIs." }, "productBrandId": { "type": "string", "description": "The brand ID to target. This information is supplied from Discovery APIs." }, "productCategoryId": { "type": "string", "description": "The product category ID to target. This information is supplied from Discovery APIs." }, "productPriceGreaterThan": { "type": "number", "description": "Refinement to target products with a price greater than the value within the product category." }, "productPriceLessThan": { "type": "number", "description": "Refinement to target products with a price less than the value within the product category." }, "productPrimeShippingEligible": { "type": "boolean", "description": "Target based on if a product is Prime-shipping eligible." }, "productRatingGreaterThan": { "type": "number", "description": "Refinement to target products with a rating greater than the value within the product category." }, "productRatingLessThan": { "type": "number", "description": "Refinement to target products with a rating less than the value within the product category." } } } }, "required": [ "marketplace", "productCategoryRefinement" ] } } }, "required": [ "marketplaceSettings" ] } }, "required": [ "productCategoryRefinement" ] }, "themeTarget": { "type": "object", "description": "Theme targets let advertisers select high-performing targets based on a common theme.", "properties": { "matchType": { "type": "string", "description": "The match type associated to the target.", "enum": [ "KEYWORDS_RELATED_TO_GIFTS", "KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY", "KEYWORDS_RELATED_TO_PRIME_DAY", "KEYWORDS_RELATED_TO_YOUR_BRAND", "KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY" ] } }, "required": [ "matchType" ] }, "locationTarget": { "type": "object", "description": "Target based on geographic location. Non-global (single-marketplace) campaigns only.", "properties": { "locationId": { "type": "string", "description": "The ID of the geographic location to target. This information is supplied from Discovery APIs." } }, "required": [ "locationId" ] } } } }, "required": [ "targetType", "negative", "targetDetails" ] } }, "required": [ "marketplaces", "budgets", "bid", "creative" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "update_target_bidInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "bid": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "marketplaceSettings": { "type": "array", "description": "The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "bid": { "type": "number", "description": "The maximum bid for a target." }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } } } } }, "targetId": { "type": "string", "description": "A unique identifier for the target." } }, "required": [ "targetId", "bid" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "create_portfolioInputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "portfolios": { "type": "array", "maxItems": 1000, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the portfolio" }, "marketplaceScope": { "type": "string", "description": "| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` | |\n| `SINGLE_MARKETPLACE` | |", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "The list of country codes representing amazon marketplaces in which the portfolio is applicable", "maxItems": 30, "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "budget": { "type": "object", "properties": { "recurrenceTimePeriod": { "type": "string", "description": "| Recurrence | Description |\n| --- | --- |\n| `DAILY` | |\n| `MONTHLY` | |\n| `LIFETIME` | |", "enum": [ "DAILY", "MONTHLY", "LIFETIME" ] }, "budgetType": { "type": "string", "description": "| BudgetType | Description |\n| --- | --- |\n| `MONETARY` | |", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] }, "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } }, "required": [ "marketplace", "monetaryBudget" ] } } } } }, "required": [ "monetaryBudgetValue" ] } ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] }, "startDateTime": { "type": "string", "description": "The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME" }, "endDateTime": { "type": "string", "description": "The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME" }, "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |", "enum": [ "ENABLED", "PAUSED" ] }, "budgetControls": { "type": "object", "properties": { "campaignBudgetSharing": { "type": "object", "properties": { "shareUnspentCampaignBudget": { "type": "string", "description": "| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "shareUnspentCampaignBudget" ] } }, "required": [ "campaignBudgetSharing" ] }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.", "maxItems": 30, "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |", "enum": [ "ENABLED", "PAUSED", "ARCHIVED" ] }, "startDateTime": { "type": "string", "description": "The start date time for the Portfolio" }, "endDateTime": { "type": "string", "description": "The end date time for the Portfolio" }, "budgetControls": { "type": "object", "properties": { "campaignBudgetSharing": { "type": "object", "properties": { "shareUnspentCampaignBudget": { "type": "string", "description": "| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "shareUnspentCampaignBudget" ] } }, "required": [ "campaignBudgetSharing" ] } } } }, "required": [ "marketplace", "overrides" ] } } } } }, "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] } }, "required": [ "accessRequestedAccount" ] } } }, "update_campaign_budgetInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "budgets": { "type": "array", "description": "The object containing budget details for the campaign (for campaigns that support multiple budgets).", "items": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "Used only for Global Campaign. List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "Used only for Global Campaign. The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] }, "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "LIFETIME", "MONTHLY" ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] } }, "campaignId": { "type": "string", "description": "A unique identifier for a campaign." } }, "required": [ "campaignId", "budgets" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "delete_adInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accessRequestedAccount" ] } } }, "delete_targetInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "targetIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accessRequestedAccount" ] } } }, "update_ad_groupInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroups": { "type": "array", "items": { "type": "object", "properties": { "adGroupId": { "type": "string", "description": "The unique identifier of the ad group." }, "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "advertisedProductCategoryIds": { "type": "array", "description": "The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.", "items": { "type": "string" } }, "bid": { "type": "object", "properties": { "baseBid": { "type": "number", "description": "The lower bound bid used for the ads in the ad group." }, "defaultBid": { "type": "number", "description": "The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction." }, "marketplaceSettings": { "type": "array", "description": "The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "enum": [ "AED", "AUD", "BRL", "CAD", "CHF", "CNY", "DKK", "EGP", "EUR", "GBP", "INR", "JPY", "MXN", "MXP", "NGN", "NOK", "NZD", "PLN", "SAR", "SEK", "SGD", "TRY", "USD", "ZAR" ] }, "defaultBid": { "type": "number", "description": "The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction." }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } } }, "maxAverageBid": { "type": "number", "description": "The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number)." } } }, "budgets": { "type": "array", "description": "An object containing budget details for the ad group.", "items": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] }, "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "LIFETIME", "MONTHLY" ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] } }, "creativeRotationType": { "type": "string", "enum": [ "RANDOM", "WEIGHTED" ] }, "endDateTime": { "type": "string", "description": "The end date time for the ad group." }, "fees": { "type": "array", "description": "The fees associated with the ad group.", "items": { "type": "object", "properties": { "addToBudgetSpentAmount": { "type": "boolean", "description": "Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports." }, "feeType": { "type": "string", "description": "| FeeType | Description |\n| --- | --- |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |", "enum": [ "AMAZON_AUDIENCE", "AMAZON_DSP", "MANAGED_SERVICE_FEE", "OMNICHANNEL_METRICS", "THIRD_PARTY_APPLIED", "THIRD_PARTY_AUDIENCE", "THIRD_PARTY_TARGETING" ] }, "feeValue": { "type": "number", "description": "The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%." }, "thirdPartyProvider": { "type": "string", "enum": [ "COM_SCORE", "CPM_1", "CPM_2", "CPM_3", "DOUBLE_CLICK_CAMPAIGN_MANAGER", "DOUBLE_VERIFY", "INTEGRAL_AD_SCIENCE" ] } } } }, "frequencies": { "type": "array", "description": "An object containing frequency details for the ad group.", "items": { "type": "object", "properties": { "eventMaxCount": { "type": "integer", "description": "The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500." }, "frequencyTargetingSetting": { "type": "string", "description": "| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |", "enum": [ "HOUSEHOLD", "USER" ] }, "timeCount": { "type": "integer", "description": "The value associated with the time and unit of time for this frequency cap." }, "timeUnit": { "type": "string", "enum": [ "DAYS", "HOURS", "MINUTES" ] } } } }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ad group for this marketplace" }, "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Marketplace specific tags for the ad group", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the ad group." }, "optimization": { "type": "object", "properties": { "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "dailyMinSpendValue": { "type": "number", "description": "Denotes the daily minimum spend on the ad group in local currency." } } }, "goalSettings": { "type": "object", "properties": { "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] } } } } }, "pacing": { "type": "object", "properties": { "deliveryProfile": { "type": "string", "description": "| DeliveryProfile | Description |\n| --- | --- |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there's no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |", "enum": [ "ASAP", "EVEN", "PACE_AHEAD" ] } } }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number associated with the ad group." }, "startDateTime": { "type": "string", "description": "The start date time for the ad group." }, "state": { "type": "string", "description": "The user defined state for the resource. DRAFT applies to Amazon DSP ad groups only; every other ad product accepts ENABLED and PAUSED. For ADSP, campaign and ad group resources are created in the PAUSED or DRAFT state and must be updated to ENABLED to activate for delivery", "enum": [ "DRAFT", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad group", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetingSettings": { "type": "object", "properties": { "amazonViewability": { "type": "object", "properties": { "includeUnmeasurableImpressions": { "type": "boolean", "description": "Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal." }, "viewabilityTier": { "type": "string", "enum": [ "ALL_TIERS", "GREATER_THAN_40_PERCENT", "GREATER_THAN_50_PERCENT", "GREATER_THAN_60_PERCENT", "GREATER_THAN_70_PERCENT", "LESS_THAN_40_PERCENT" ] } } }, "defaultAudienceTargetingMatchType": { "type": "string", "description": "Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n| DefaultAudienceTargetingMatchType | Description |\n| --- | --- |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |", "enum": [ "EXACT", "SIMILAR" ] }, "enableLanguageTargeting": { "type": "boolean", "description": "If set to true, creatives will only target supply where the content language matches the creative language." }, "tacticsConvertersExclusionType": { "type": "string", "enum": [ "NO_EXCLUSION", "RECENT_CONVERTERS" ] }, "targetedPGDealId": { "type": "string", "description": "DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here." }, "timeZoneType": { "type": "string", "enum": [ "ADVERTISER_REGION", "VIEWER" ] }, "userLocationSignal": { "type": "string", "enum": [ "CURRENT", "MULTIPLE_SIGNALS" ] }, "videoCompletionTier": { "type": "string", "enum": [ "ALL_TIERS", "GREATER_THAN_10_PERCENT", "GREATER_THAN_20_PERCENT", "GREATER_THAN_30_PERCENT", "GREATER_THAN_40_PERCENT", "GREATER_THAN_50_PERCENT", "GREATER_THAN_60_PERCENT", "GREATER_THAN_70_PERCENT", "GREATER_THAN_80_PERCENT", "GREATER_THAN_90_PERCENT" ] } } } }, "required": [ "adGroupId" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "delete_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "campaignIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accessRequestedAccount" ] } } }, "update_ad_associationInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] } ] }, "adAssociations": { "type": "array", "items": { "type": "object", "properties": { "adAssociationId": { "type": "string", "description": "The unique identifier of the ad association." }, "endDateTime": { "type": "string", "description": "The end date time for the ad association." }, "startDateTime": { "type": "string", "description": "The start date time for the ad association." }, "state": { "type": "string", "description": "The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery", "enum": [ "ENABLED", "PAUSED" ] }, "weight": { "type": "integer", "description": "The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group." } }, "required": [ "adAssociationId" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "query_ad_groupInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroupIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adProductFilter": { "type": "object", "properties": { "include": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "description": "Only one ad product can be queried at a time." } }, "required": [ "include" ] }, "campaignIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "marketplaceScopeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] } } }, "required": [ "include" ] }, "maxResults": { "type": "integer" }, "nameFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "queryTermMatchType": { "type": "string", "enum": [ "BROAD_MATCH", "EXACT_MATCH" ] } }, "required": [ "include", "queryTermMatchType" ] }, "nextToken": { "type": "string" }, "stateFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "ARCHIVED", "DRAFT", "ENABLED", "PAUSED" ] }, "description": "DRAFT applies to Amazon DSP ad groups only. Send [\"DRAFT\"] on its own to get draft ad groups and nothing else. A state filter that does not name DRAFT leaves draft ad groups out. Naming DRAFT together with other states returns draft ad groups as well as ad groups in those states. Draft ad groups also come back when adGroupIdFilter names specific ad groups and no stateFilter is sent. At most 3 states are accepted per call, so all four values cannot be sent together." } }, "required": [ "include" ] } }, "required": [ "accessRequestedAccount", "adProductFilter" ] } }, "required": [ "body" ] }, "delete_ad_groupInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroupIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "accessRequestedAccount" ] } } }, "create_ad_groupInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroups": { "type": "array", "items": { "type": "object", "properties": { "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "advertisedProductCategoryIds": { "type": "array", "description": "The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.", "items": { "type": "string" } }, "bid": { "type": "object", "properties": { "baseBid": { "type": "number", "description": "The lower bound bid used for the ads in the ad group." }, "defaultBid": { "type": "number", "description": "The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction." }, "marketplaceSettings": { "type": "array", "description": "The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "enum": [ "AED", "AUD", "BRL", "CAD", "CHF", "CNY", "DKK", "EGP", "EUR", "GBP", "INR", "JPY", "MXN", "MXP", "NGN", "NOK", "NZD", "PLN", "SAR", "SEK", "SGD", "TRY", "USD", "ZAR" ] }, "defaultBid": { "type": "number", "description": "The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction." }, "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } } } }, "maxAverageBid": { "type": "number", "description": "The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number)." } } }, "budgets": { "type": "array", "description": "An object containing budget details for the ad group.", "items": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] }, "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "LIFETIME", "MONTHLY" ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] } }, "campaignId": { "type": "string", "description": "The unique identifier of the campaign the ad group belongs to." }, "creativeRotationType": { "type": "string", "enum": [ "RANDOM", "WEIGHTED" ] }, "creativeType": { "type": "string", "enum": [ "IMAGE", "VIDEO" ] }, "endDateTime": { "type": "string", "description": "The end date time for the ad group." }, "fees": { "type": "array", "description": "The fees associated with the ad group.", "items": { "type": "object", "properties": { "addToBudgetSpentAmount": { "type": "boolean", "description": "Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports." }, "feeType": { "type": "string", "description": "| FeeType | Description |\n| --- | --- |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |", "enum": [ "AMAZON_AUDIENCE", "AMAZON_DSP", "MANAGED_SERVICE_FEE", "OMNICHANNEL_METRICS", "THIRD_PARTY_APPLIED", "THIRD_PARTY_AUDIENCE", "THIRD_PARTY_TARGETING" ] }, "feeValue": { "type": "number", "description": "The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%." }, "thirdPartyProvider": { "type": "string", "enum": [ "COM_SCORE", "CPM_1", "CPM_2", "CPM_3", "DOUBLE_CLICK_CAMPAIGN_MANAGER", "DOUBLE_VERIFY", "INTEGRAL_AD_SCIENCE" ] } } } }, "frequencies": { "type": "array", "description": "An object containing frequency details for the ad group.", "items": { "type": "object", "properties": { "eventMaxCount": { "type": "integer", "description": "The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500." }, "frequencyTargetingSetting": { "type": "string", "description": "| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |", "enum": [ "HOUSEHOLD", "USER" ] }, "timeCount": { "type": "integer", "description": "The value associated with the time and unit of time for this frequency cap." }, "timeUnit": { "type": "string", "enum": [ "DAYS", "HOURS", "MINUTES" ] } } } }, "inventoryType": { "type": "string", "enum": [ "AAP_MOBILE_APP", "AMAZON_MOBILE_DISPLAY", "AUDIO", "DISPLAY", "ONLINE_VIDEO", "PODCAST", "STANDARD_DISPLAY", "STREAMING_TV", "VIDEO" ] }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ad group for this marketplace" }, "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Marketplace specific tags for the ad group", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the ad group." }, "optimization": { "type": "object", "properties": { "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "dailyMinSpendValue": { "type": "number", "description": "Denotes the daily minimum spend on the ad group in local currency." } } }, "goalSettings": { "type": "object", "properties": { "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] } } } } }, "pacing": { "type": "object", "properties": { "deliveryProfile": { "type": "string", "description": "| DeliveryProfile | Description |\n| --- | --- |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there's no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |", "enum": [ "ASAP", "EVEN", "PACE_AHEAD" ] } } }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number associated with the ad group." }, "startDateTime": { "type": "string", "description": "The start date time for the ad group." }, "state": { "type": "string", "description": "The user defined state for the resource. DRAFT applies to Amazon DSP ad groups only; every other ad product accepts ENABLED and PAUSED. A DRAFT ad group is not eligible for delivery.", "enum": [ "DRAFT", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the ad group", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } }, "targetingSettings": { "type": "object", "properties": { "amazonViewability": { "type": "object", "properties": { "includeUnmeasurableImpressions": { "type": "boolean", "description": "Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal." }, "viewabilityTier": { "type": "string", "enum": [ "ALL_TIERS", "GREATER_THAN_40_PERCENT", "GREATER_THAN_50_PERCENT", "GREATER_THAN_60_PERCENT", "GREATER_THAN_70_PERCENT", "LESS_THAN_40_PERCENT" ] } } }, "automatedTargetingTactic": { "type": "string", "description": "Represents targeting strategy of auto populated adGroup to drive outcome.", "enum": [ "AWARENESS", "CUSTOMER_ACQUISITION", "MAXIMIZE_PERFORMANCE", "PROSPECTING", "REMARKETING", "RETENTION", "SEARCH" ] }, "defaultAudienceTargetingMatchType": { "type": "string", "description": "Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n| DefaultAudienceTargetingMatchType | Description |\n| --- | --- |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |", "enum": [ "EXACT", "SIMILAR" ] }, "enableLanguageTargeting": { "type": "boolean", "description": "If set to true, creatives will only target supply where the content language matches the creative language." }, "tacticsConvertersExclusionType": { "type": "string", "enum": [ "NO_EXCLUSION", "RECENT_CONVERTERS" ] }, "targetedPGDealId": { "type": "string", "description": "DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here." }, "timeZoneType": { "type": "string", "enum": [ "ADVERTISER_REGION", "VIEWER" ] }, "userLocationSignal": { "type": "string", "enum": [ "CURRENT", "MULTIPLE_SIGNALS" ] }, "videoCompletionTier": { "type": "string", "enum": [ "ALL_TIERS", "GREATER_THAN_10_PERCENT", "GREATER_THAN_20_PERCENT", "GREATER_THAN_30_PERCENT", "GREATER_THAN_40_PERCENT", "GREATER_THAN_50_PERCENT", "GREATER_THAN_60_PERCENT", "GREATER_THAN_70_PERCENT", "GREATER_THAN_80_PERCENT", "GREATER_THAN_90_PERCENT" ] } } } }, "required": [ "adProduct", "campaignId", "name", "state" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "dsp_create_conversion_tracking_productsInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "pathParameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "The identifier of the DSP campaign to add conversion tracking products to." } }, "required": [ "campaignId" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] } ] }, "productTrackingList": { "type": "array", "description": "List of products to add for conversion tracking. Products are appended to the existing list.", "minItems": 1, "maxItems": 2000, "items": { "type": "object", "properties": { "productId": { "type": "string", "minLength": 10, "maxLength": 10, "description": "The Amazon Standard Identification Number (ASIN) of the product." }, "domain": { "type": "string", "enum": [ "AMAZON_AE", "AMAZON_AU", "AMAZON_BR", "AMAZON_CA", "AMAZON_DE", "AMAZON_ES", "AMAZON_FR", "AMAZON_IN", "AMAZON_IT", "AMAZON_JP", "AMAZON_MX", "AMAZON_NL", "AMAZON_SA", "AMAZON_SE", "AMAZON_TR", "AMAZON_UK", "AMAZON_US", "FRESH_STORES_US", "WHOLE_FOODS_MARKET_US" ], "description": "The Amazon domain associated with the product." }, "productAssociation": { "type": "string", "enum": [ "FEATURED", "FEATURED_WITH_VARIATION", "NOT_FEATURED" ], "description": "A featured ASIN is a specific product that is promoted in creatives within this campaign. Tracking non-featured ASINs or variations, in addition to featured and parent ASINs, will ensure proper conversion metrics and prevent data loss that is not recoverable once a campaign starts." } }, "required": [ "productId", "domain", "productAssociation" ] } } }, "required": [ "accessRequestedAccount", "productTrackingList" ] } }, "required": [ "pathParameters", "body" ] }, "query_targetInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adGroupIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "adProductFilter": { "type": "object", "properties": { "include": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "description": "Only one ad product can be queried at a time." } }, "required": [ "include" ] }, "campaignIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "keywordFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "queryTermMatchType": { "type": "string", "enum": [ "BROAD_MATCH", "EXACT_MATCH" ] } }, "required": [ "include", "queryTermMatchType" ] }, "marketplaceScopeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] } } }, "required": [ "include" ] }, "matchTypeFilter": { "type": "object", "properties": { "include": { "type": "array", "description": "| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE. |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |", "items": { "type": "string", "description": "| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE. |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |", "enum": [ "BROAD", "EXACT", "INTERESTED_AUDIENCE", "KEYWORDS_CLOSE_MATCH", "KEYWORDS_LOOSE_MATCH", "KEYWORDS_RELATED_TO_GIFTS", "KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY", "KEYWORDS_RELATED_TO_PRIME_DAY", "KEYWORDS_RELATED_TO_YOUR_BRAND", "KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES", "KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY", "MULTISIGNAL_BROAD", "PHRASE", "PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS", "PRODUCT_COMPLEMENTS", "PRODUCT_EXACT", "PRODUCT_SIMILAR", "PRODUCT_SUBSTITUTES" ] } } }, "required": [ "include" ] }, "maxResults": { "type": "integer" }, "nativeLanguageLocaleFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "description": "A combination of ISO-639 standard for language code and ISO-3166 for country code.", "enum": [ "ak_GH", "am_ET", "an_ES", "ar_AE", "as_IN", "av_RU", "ay_BO", "ba_RU", "be_BY", "bg_BG", "bh_IN", "bi_VU", "bm_ML", "bo_CN", "bs_BA", "ca_ES", "ce_RU", "ch_GU", "de_DE", "el_GR", "en_US", "eo_INT", "es_ES", "et_EE", "eu_ES", "fa_IR", "fi_FI", "fj_FJ", "fo_FO", "fr_FR", "fy_NL", "ga_IE", "gd_GB", "gl_ES", "gn_PY", "gu_IN", "gv_IM", "ha_NG", "he_IL", "hi_IN", "ho_PG", "hr_HR", "ht_HT", "hu_HU", "hy_AM", "hz_NA", "ia_INT", "id_ID", "ie_INT", "ig_NG", "ii_CN", "ik_US", "io_INT", "is_IS", "it_IT", "iu_CA", "ja_JP", "jv_ID", "ka_GE", "kg_CD", "ki_KE", "kj_NA", "kk_KZ", "kl_GL", "km_KH", "kn_IN", "ko_KR", "kr_NG", "ks_IN", "ku_TR", "kv_RU", "kw_GB", "ky_KG", "la_VA", "lb_LU", "lg_UG", "li_NL", "ln_CD", "lo_LA", "lt_LT", "lu_CD", "lv_LV", "mg_MG", "mh_MH", "mi_NZ", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "mt_MT", "my_MM", "na_NR", "nb_NO", "nd_ZW", "ne_NP", "ng_NA", "nl_NL", "nn_NO", "no_NO", "nr_ZA", "nv_US", "ny_MW", "oc_FR", "oj_CA", "om_ET", "or_IN", "os_RU", "pa_IN", "pi_IN", "pl_PL", "ps_AF", "pt_PT", "qu_PE", "rm_CH", "rn_BI", "ro_RO", "ru_RU", "rw_RW", "sa_IN", "sc_IT", "sd_PK", "se_NO", "sg_CF", "si_LK", "sk_SK", "sl_SI", "sm_WS", "sn_ZW", "so_SO", "sq_AL", "sr_RS", "ss_SZ", "st_LS", "su_ID", "sv_SE", "sw_TZ", "ta_IN", "te_IN", "tg_TJ", "th_TH", "ti_ET", "tk_TM", "tl_PH", "tn_BW", "to_TO", "tr_TR", "ts_ZA", "tt_RU", "tw_GH", "ty_PF", "ug_CN", "uk_UA", "ur_PK", "uz_UZ", "ve_ZA", "vi_VN", "vo_INT", "wa_BE", "wo_SN", "xh_ZA", "yi_IL", "yo_NG", "za_CN", "zh_CN", "zu_ZA" ] } } }, "required": [ "include" ] }, "negativeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "boolean" } } }, "required": [ "include" ] }, "nextToken": { "type": "string" }, "productIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "queryTermMatchType": { "type": "string", "description": "| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |", "enum": [ "BROAD_MATCH", "EXACT_MATCH" ] } }, "required": [ "include", "queryTermMatchType" ] }, "stateFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "ARCHIVED", "DRAFT", "ENABLED", "PAUSED" ] }, "description": "DRAFT applies to Amazon DSP targets only. Send [\"DRAFT\"] on its own to get draft targets and nothing else. A state filter that does not name DRAFT leaves draft targets out. Naming DRAFT together with other states returns draft targets as well as targets in those states. Draft targets also come back when no stateFilter is sent at all. At most 3 states are accepted per call, so all four values cannot be sent together." } }, "required": [ "include" ] }, "targetIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "targetTypeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "AD_INITIATION", "AD_PLAYER_SIZE", "APP", "AUDIENCE", "BRAND_SAFETY_TIER", "CONTENT_CATEGORY", "CONTENT_GENRE", "CONTENT_INSTREAM_POSITION", "CONTENT_OUTSTREAM_POSITION", "CONTENT_RATING", "DAYPART", "DEVICE", "DOMAIN", "FOLD_POSITION", "INVENTORY_SOURCE", "KEYWORD", "LOCATION", "NATIVE_CONTENT_POSITION", "PRODUCT", "PRODUCT_AUDIENCE", "PRODUCT_CATEGORY", "THEME", "THIRD_PARTY", "VIDEO_AD_FORMAT", "VIDEO_CONTENT_DURATION" ] } } }, "required": [ "include" ] } }, "required": [ "accessRequestedAccount", "adProductFilter" ] } }, "required": [ "body" ] }, "update_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "budgets": { "type": "array", "description": "The object containing budget details for the campaign (for campaigns that support multiple budgets).", "items": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] }, "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "LIFETIME", "MONTHLY" ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] } }, "campaignId": { "type": "string", "description": "A unique identifier for a campaign." }, "costType": { "type": "string", "description": "| CostType | Description |\n| --- | --- |\n| `CPC` | Cost per click. |\n| `VCPM` | Cost per thousand views. |", "enum": [ "CPC", "VCPM" ] }, "countries": { "type": "array", "description": "This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.", "items": { "type": "string", "enum": [ "AE", "AT", "AU", "BE", "BH", "BR", "CA", "CH", "DE", "DK", "EG", "ES", "FI", "FR", "GB", "IE", "IL", "IN", "IT", "JO", "JP", "KW", "LU", "MA", "MK", "MX", "NL", "NO", "NZ", "OM", "PL", "QA", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "endDateTime": { "type": "string", "description": "The end date time for the campaign." }, "fees": { "type": "array", "description": "Any fees associated with the campaign.", "items": { "type": "object", "properties": { "feeType": { "type": "string", "description": "| CampaignFeeType | Description |\n| --- | --- |\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |", "enum": [ "AGENCY" ] }, "feeValue": { "type": "number", "description": "A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign." }, "feeValueType": { "type": "string", "description": "| CampaignFeeValueType | Description |\n| --- | --- |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |", "enum": [ "PERCENTAGE_OF_BUDGET" ] } } } }, "flights": { "type": "array", "description": "Flight details associated with the campaign.", "items": { "type": "object", "properties": { "budget": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] } } }, "endDateTime": { "type": "string" }, "flightId": { "type": "string", "description": "The ID associated with the flight." }, "name": { "type": "string", "description": "The name of the flight." }, "startDateTime": { "type": "string", "description": "The start date of the flight." } } } }, "frequencies": { "type": "array", "description": "Any frequency caps associated with the campaign.", "items": { "type": "object", "properties": { "eventMaxCount": { "type": "integer", "description": "The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500." }, "frequencyTargetingSetting": { "type": "string", "description": "| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |", "enum": [ "HOUSEHOLD", "USER" ] }, "timeCount": { "type": "integer", "description": "The value associated with the time and unit of time for this frequency cap." }, "timeUnit": { "type": "string", "enum": [ "DAYS", "HOURS", "MINUTES" ] } } } }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate '2024-06-01' but needs to be PAUSED in DE with startDateTime '2024-06-02' marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: '2024-06-02'}}]. When a marketplace-specific override is not provided, the campaign's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "The end date time for the campaign" }, "name": { "type": "string", "description": "The name of the campaign" }, "optimizations": { "type": "object", "properties": { "bidSettings": { "type": "object", "properties": { "bidAdjustments": { "type": "object", "properties": { "audienceBidAdjustments": { "type": "array", "description": "Bid Adjustments based on the audiences", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique identifier of the Audience to apply bid adjustment." }, "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given audience and bid adjustment settings." } } } }, "placementBidAdjustments": { "type": "array", "description": "Bid adjustments based on ad placements.", "items": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given placement and bid adjustment settings." }, "placement": { "type": "string", "description": "| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |", "enum": [ "HOME_PAGE", "PRODUCT_PAGE", "REST_OF_SEARCH", "SITE_AMAZON_BUSINESS", "TOP_OF_SEARCH" ] } } } }, "shopperSegmentBidAdjustments": { "type": "array", "description": "Legacy SB field (marked for deprecation)", "items": { "type": "object" } } } }, "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] } } }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "flightBudgetRolloverStrategy": { "type": "string", "description": "| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |", "enum": [ "CUMULATIVE_BUDGET_ROLLOVER", "NO_ROLLOVER", "PRIOR_BUDGET_ROLLOVER" ] }, "offAmazonBudgetControlStrategy": { "type": "string", "enum": [ "MAXIMIZE_REACH", "MINIMIZE_SPEND" ] } } }, "goalSettings": { "type": "object", "properties": { "goal": { "type": "string", "enum": [ "AWARENESS", "CONSIDERATION", "CONVERSIONS" ] }, "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] }, "kpiValue": { "type": "number", "description": "The value of the KPI that the campaign is working to optimize." } } }, "primaryInventoryTypes": { "type": "array", "description": "Primary inventory type of the campaign for filtering KPIs and recommending tactics.", "items": { "type": "string", "enum": [ "AUDIO", "DISPLAY", "VIDEO_OLV", "VIDEO_STV" ] } } } }, "startDateTime": { "type": "string", "description": "The start date time for the campaign" }, "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the campaign", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the campaign." }, "optimizations": { "type": "object", "properties": { "bidSettings": { "type": "object", "properties": { "bidAdjustments": { "type": "object", "properties": { "audienceBidAdjustments": { "type": "array", "description": "Bid Adjustments based on the audiences", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique identifier of the Audience to apply bid adjustment." }, "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given audience and bid adjustment settings." } } } }, "placementBidAdjustments": { "type": "array", "description": "Bid adjustments based on ad placements.", "items": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given placement and bid adjustment settings." }, "placement": { "type": "string", "description": "| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |", "enum": [ "HOME_PAGE", "PRODUCT_PAGE", "REST_OF_SEARCH", "SITE_AMAZON_BUSINESS", "TOP_OF_SEARCH" ] } } } }, "shopperSegmentBidAdjustments": { "type": "array", "description": "Legacy SB field (marked for deprecation)", "items": { "type": "object" } } } }, "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] } } }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "flightBudgetRolloverStrategy": { "type": "string", "description": "| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |", "enum": [ "CUMULATIVE_BUDGET_ROLLOVER", "NO_ROLLOVER", "PRIOR_BUDGET_ROLLOVER" ] }, "offAmazonBudgetControlStrategy": { "type": "string", "enum": [ "MAXIMIZE_REACH", "MINIMIZE_SPEND" ] } } }, "goalSettings": { "type": "object", "properties": { "goal": { "type": "string", "enum": [ "AWARENESS", "CONSIDERATION", "CONVERSIONS" ] }, "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] }, "kpiValue": { "type": "number", "description": "The value of the KPI that the campaign is working to optimize." } } }, "primaryInventoryTypes": { "type": "array", "description": "Primary inventory type of the campaign for filtering KPIs and recommending tactics.", "items": { "type": "string", "enum": [ "AUDIO", "DISPLAY", "VIDEO_OLV", "VIDEO_STV" ] } } } }, "portfolioId": { "type": "string", "description": "The ID of the portfolio associated with the campaign." }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number associated with the campaign." }, "siteRestrictions": { "type": "array", "description": "Restrict the ad to a particular site", "items": { "type": "string", "description": "| SiteRestriction | Description |\n| --- | --- |\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |", "enum": [ "AMAZON_BUSINESS", "AMAZON_HAUL" ] } }, "skanAppId": { "type": "string", "description": "StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated." }, "startDateTime": { "type": "string", "description": "The start date time for the campaign." }, "state": { "type": "string", "description": "The user defined state for the resource. DRAFT applies to Amazon DSP campaigns only; every other ad product accepts ENABLED and PAUSED. For ADSP, campaign and ad group resources are created in the PAUSED or DRAFT state and must be updated to ENABLED to activate for delivery\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | Amazon DSP only. The campaign is a draft and is not eligible for delivery. |\n| `ENABLED` | |\n| `PAUSED` | |", "enum": [ "DRAFT", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the campaign", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } }, "required": [ "campaignId" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "create_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "adProduct": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "autoCreationSettings": { "type": "object", "properties": { "autoCreateTargets": { "type": "boolean", "description": "Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised." } } }, "brandId": { "type": "string", "description": "This is the ID of the brand that the campaign is associated with." }, "budgets": { "type": "array", "description": "The object containing budget details for the campaign (for campaigns that support multiple budgets).", "items": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] }, "recurrenceTimePeriod": { "type": "string", "enum": [ "DAILY", "LIFETIME", "MONTHLY" ] } }, "required": [ "budgetType", "budgetValue", "recurrenceTimePeriod" ] } }, "costType": { "type": "string", "description": "| CostType | Description |\n| --- | --- |\n| `CPC` | Cost per click. |\n| `VCPM` | Cost per thousand views. |", "enum": [ "CPC", "VCPM" ] }, "countries": { "type": "array", "description": "This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.", "items": { "type": "string", "enum": [ "AE", "AT", "AU", "BE", "BH", "BR", "CA", "CH", "DE", "DK", "EG", "ES", "FI", "FR", "GB", "IE", "IL", "IN", "IT", "JO", "JP", "KW", "LU", "MA", "MK", "MX", "NL", "NO", "NZ", "OM", "PL", "QA", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "endDateTime": { "type": "string", "format": "date-time", "description": "The end date time for the campaign." }, "fees": { "type": "array", "description": "Any fees associated with the campaign.", "items": { "type": "object", "properties": { "feeType": { "type": "string", "description": "| CampaignFeeType | Description |\n| --- | --- |\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |", "enum": [ "AGENCY" ] }, "feeValue": { "type": "number", "description": "A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign." }, "feeValueType": { "type": "string", "description": "| CampaignFeeValueType | Description |\n| --- | --- |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |", "enum": [ "PERCENTAGE_OF_BUDGET" ] } } } }, "flights": { "type": "array", "description": "Flight details associated with the campaign.", "items": { "type": "object", "properties": { "budget": { "type": "object", "properties": { "budgetType": { "type": "string", "enum": [ "MONETARY" ] }, "budgetValue": { "oneOf": [ { "type": "object", "properties": { "monetaryBudgetValue": { "type": "object", "properties": { "marketplaceSettings": { "type": "array", "description": "List of Monetary Budget values selectively applied at the given marketplace level", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "monetaryBudget": { "type": "object", "properties": { "value": { "type": "number", "description": "The monetary amount of the budget cap in the given currency." } }, "required": [ "value" ] } } } }, "required": [ "monetaryBudgetValue" ] } ] } } }, "endDateTime": { "type": "string", "format": "date-time" }, "flightId": { "type": "string", "description": "The ID associated with the flight." }, "name": { "type": "string", "description": "The name of the flight." }, "startDateTime": { "type": "string", "format": "date-time", "description": "The start date of the flight." } } } }, "frequencies": { "type": "array", "description": "Any frequency caps associated with the campaign.", "items": { "type": "object", "properties": { "eventMaxCount": { "type": "integer", "description": "The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500." }, "frequencyTargetingSetting": { "type": "string", "description": "| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |", "enum": [ "HOUSEHOLD", "USER" ] }, "timeCount": { "type": "integer", "description": "The value associated with the time and unit of time for this frequency cap." }, "timeUnit": { "type": "string", "enum": [ "DAYS", "HOURS", "MINUTES" ] } } } }, "marketplaceConfigurations": { "type": "array", "description": "List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate '2024-06-01' but needs to be PAUSED in DE with startDateTime '2024-06-02' marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: '2024-06-02'}}]. When a marketplace-specific override is not provided, the campaign's global value is applied to that marketplace.", "items": { "type": "object", "properties": { "marketplace": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] }, "overrides": { "type": "object", "properties": { "endDateTime": { "type": "string", "format": "date-time", "description": "The end date time for the campaign" }, "name": { "type": "string", "description": "The name of the campaign" }, "optimizations": { "type": "object", "properties": { "bidSettings": { "type": "object", "properties": { "bidAdjustments": { "type": "object", "properties": { "audienceBidAdjustments": { "type": "array", "description": "Bid Adjustments based on the audiences", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique identifier of the Audience to apply bid adjustment." }, "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given audience and bid adjustment settings." } } } }, "placementBidAdjustments": { "type": "array", "description": "Bid adjustments based on ad placements.", "items": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given placement and bid adjustment settings." }, "placement": { "type": "string", "description": "| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |", "enum": [ "HOME_PAGE", "PRODUCT_PAGE", "REST_OF_SEARCH", "SITE_AMAZON_BUSINESS", "TOP_OF_SEARCH" ] } } } }, "shopperSegmentBidAdjustments": { "type": "array", "description": "Legacy SB field (marked for deprecation)", "items": { "type": "object" } } } }, "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] } } }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "flightBudgetRolloverStrategy": { "type": "string", "description": "| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |", "enum": [ "CUMULATIVE_BUDGET_ROLLOVER", "NO_ROLLOVER", "PRIOR_BUDGET_ROLLOVER" ] }, "offAmazonBudgetControlStrategy": { "type": "string", "enum": [ "MAXIMIZE_REACH", "MINIMIZE_SPEND" ] } } }, "goalSettings": { "type": "object", "properties": { "goal": { "type": "string", "enum": [ "AWARENESS", "CONSIDERATION", "CONVERSIONS" ] }, "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] }, "kpiValue": { "type": "number", "description": "The value of the KPI that the campaign is working to optimize." } } }, "primaryInventoryTypes": { "type": "array", "description": "Primary inventory type of the campaign for filtering KPIs and recommending tactics.", "items": { "type": "string", "enum": [ "AUDIO", "DISPLAY", "VIDEO_OLV", "VIDEO_STV" ] } } } }, "startDateTime": { "type": "string", "format": "date-time", "description": "The start date time for the campaign" }, "state": { "type": "string", "enum": [ "ARCHIVED", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the campaign", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } } } } } }, "marketplaceScope": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] }, "marketplaces": { "type": "array", "description": "A list of country codes representing Amazon marketplaces", "items": { "type": "string", "description": "A list of country codes representing Amazon marketplaces", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ] } }, "name": { "type": "string", "description": "The name of the campaign." }, "optimizations": { "type": "object", "properties": { "bidSettings": { "type": "object", "properties": { "bidAdjustments": { "type": "object", "properties": { "audienceBidAdjustments": { "type": "array", "description": "Bid Adjustments based on the audiences", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "The unique identifier of the Audience to apply bid adjustment." }, "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given audience and bid adjustment settings." } } } }, "placementBidAdjustments": { "type": "array", "description": "Bid adjustments based on ad placements.", "items": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "The selection of the percentage change associated with a given placement and bid adjustment settings." }, "placement": { "type": "string", "description": "| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |", "enum": [ "HOME_PAGE", "PRODUCT_PAGE", "REST_OF_SEARCH", "SITE_AMAZON_BUSINESS", "TOP_OF_SEARCH" ] } } } }, "shopperSegmentBidAdjustments": { "type": "array", "description": "Legacy SB field (marked for deprecation)", "items": { "type": "object" } } } }, "bidStrategy": { "type": "string", "description": "| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` | |\n| `NEW_TO_BRAND` | |\n| `SPEND_BUDGET_IN_FULL` | |\n| `RULE_BASED` | |\n| `PRIORITIZE_KPI_TARGET` | |\n| `USE_CAMPAIGN_STRATEGY` | |", "enum": [ "MANUAL", "NEW_TO_BRAND", "PRIORITIZE_KPI_TARGET", "RULE_BASED", "SALES_DOWN_ONLY", "SALES_UP_AND_DOWN", "SPEND_BUDGET_IN_FULL", "USE_CAMPAIGN_STRATEGY" ] } } }, "budgetSettings": { "type": "object", "properties": { "budgetAllocation": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "flightBudgetRolloverStrategy": { "type": "string", "description": "| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |", "enum": [ "CUMULATIVE_BUDGET_ROLLOVER", "NO_ROLLOVER", "PRIOR_BUDGET_ROLLOVER" ] }, "offAmazonBudgetControlStrategy": { "type": "string", "enum": [ "MAXIMIZE_REACH", "MINIMIZE_SPEND" ] } } }, "goalSettings": { "type": "object", "properties": { "goal": { "type": "string", "enum": [ "AWARENESS", "CONSIDERATION", "CONVERSIONS" ] }, "kpi": { "type": "string", "description": "| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |", "enum": [ "ADD_TO_CART", "APPLICATIONS", "CHECKOUTS", "CLICKS", "CLICK_THROUGH_RATE", "COMBINED_RETURN_ON_AD_SPEND", "CONTACTS", "COST_PER_ACTION", "COST_PER_CLICK", "COST_PER_CONVERSION_OFF_AMAZON", "COST_PER_DETAIL_PAGE_VIEW", "COST_PER_FIRST_APP_OPEN", "COST_PER_INSTALL", "COST_PER_SIGN_UP", "COST_PER_VIDEO_COMPLETION", "DETAIL_PAGE_VIEW_RATE", "FREQUENCY_AVERAGE", "LEADS", "NEW_TO_BRAND_PURCHASES", "OTHER", "PAGE_VIEWS", "PURCHASES", "REACH", "RETURN_ON_AD_SPEND", "ROAS", "ROAS_COMBINED", "ROAS_PROMOTED", "SEARCH", "SIGN_UP", "SUBSCRIBE", "TOP_OF_SEARCH_IMPRESSION_SHARE", "TOTAL_RETURN_ON_AD_SPEND", "VIDEO_COMPLETION_RATE" ] }, "kpiValue": { "type": "number", "description": "The value of the KPI that the campaign is working to optimize." } } }, "primaryInventoryTypes": { "type": "array", "description": "Primary inventory type of the campaign for filtering KPIs and recommending tactics.", "items": { "type": "string", "enum": [ "AUDIO", "DISPLAY", "VIDEO_OLV", "VIDEO_STV" ] } } } }, "portfolioId": { "type": "string", "description": "The ID of the portfolio associated with the campaign." }, "productCategoryId": { "type": "string", "description": "This is the ID of the product category that the campaign is associated with." }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number associated with the campaign." }, "salesChannel": { "type": "string", "description": "| SalesChannel | Description |\n| --- | --- |\n| `AMAZON` | A product sold on Amazon-owned sites. |\n| `OFF_AMAZON` | A product sold on a site not owned by Amazon. |", "enum": [ "AMAZON", "OFF_AMAZON" ] }, "siteRestrictions": { "type": "array", "description": "Restrict the ad to a particular site", "items": { "type": "string", "description": "| SiteRestriction | Description |\n| --- | --- |\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |", "enum": [ "AMAZON_BUSINESS", "AMAZON_HAUL" ] } }, "skanAppId": { "type": "string", "description": "StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated." }, "startDateTime": { "type": "string", "format": "date-time", "description": "The start date time for the campaign." }, "state": { "type": "string", "description": "The user defined state for the resource. DRAFT applies to Amazon DSP campaigns only; every other ad product accepts ENABLED and PAUSED. A DRAFT campaign is not eligible for delivery.", "enum": [ "DRAFT", "ENABLED", "PAUSED" ] }, "tags": { "type": "array", "description": "Open ended labels with a key value pair applied to the campaign", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A custom key value pair entered by the advertiser." }, "value": { "type": "string", "description": "A custom key value pair entered by the advertiser." } } } } }, "required": [ "adProduct", "name", "state" ] } } }, "required": [ "accessRequestedAccount" ] } } }, "create_bid_adjustment_ruleInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." }, "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "advertiserAccountId", "profileId" ] }, "rule": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024, "description": "The rule name/description." }, "onRuleExpressionConflict": { "type": "string", "enum": [ "FIRST", "ALL" ], "description": "The conflict resolution strategy when multiple rule expressions match the same impression. Defaults to ALL if not provided." }, "expression": { "type": "array", "minItems": 1, "maxItems": 1000, "description": "A list of dimension rule expressions that define conditions and bid adjustment actions.", "items": { "type": "object", "properties": { "conditions": { "type": "object", "properties": { "dimensions": { "type": "array", "minItems": 1, "maxItems": 100, "description": "Dimensions to match. Each dimension type must be unique.", "items": { "type": "object", "properties": { "dimensionType": { "type": "string", "enum": [ "DEVICE_TYPE", "BROWSER", "DOMAIN", "OPERATING_SYSTEM", "COUNTRY", "REGION", "CITY", "POSTAL_CODE", "DMA", "SUPPLY_SOURCE", "SUPPLY_SOURCE_TYPE", "AD_FORMAT", "SLOT_SIZE", "SLOT_POSITION", "DEAL_ID", "APP_ID", "APP_NAME", "DEVICE_MAKE", "BEHAVIORAL_SEGMENT" ], "description": "The type of dimension." }, "dimensionValues": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string" }, "description": "The values to match for this dimension. Multiple values use OR logic." } }, "required": [ "dimensionType", "dimensionValues" ] } }, "negative": { "type": "boolean", "description": "If true, the bid adjustment applies when NONE of the dimensions match. Defaults to false." } }, "required": [ "dimensions" ] }, "actions": { "type": "object", "properties": { "bidAdjustment": { "type": "object", "properties": { "adjustmentType": { "type": "string", "enum": [ "MULTIPLIER" ], "description": "The adjustment type for bid adjustment rules." }, "adjustmentValue": { "type": "number", "minimum": 0, "maximum": 10, "description": "A bid multiplier applied to the DSP computed bid amount. Values will be truncated to 2 decimal places." } }, "required": [ "adjustmentType", "adjustmentValue" ] } }, "required": [ "bidAdjustment" ] } }, "required": [ "conditions", "actions" ] } } }, "required": [ "expression" ] }, "ruleLink": { "type": "object", "properties": { "ruleLinkEntityType": { "type": "string", "enum": [ "AD_GROUP" ], "description": "The type of the object to associate with the rule. Currently only supports DSP ad groups." }, "entityId": { "type": "string", "minLength": 1, "description": "The object ID to associate with the rule (e.g., DSP ad group ID)." } }, "required": [ "ruleLinkEntityType", "entityId" ] } }, "required": [ "accessRequestedAccount", "rule", "ruleLink" ] } }, "required": [ "body" ] }, "add_country_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account (global account construct representing a single advertiser). This API supports Advertiser Accounts only. Expected format: amzn1.ads-account.g.* (e.g., amzn1.ads-account.g.ABC123XYZ)" } }, "required": [ "profileId" ] } ] }, "campaigns": { "type": "array", "maxItems": 1, "description": "Array of campaign objects to add countries to (maximum 1 campaign per request).", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the campaign to add countries to." }, "countryCodes": { "type": "array", "maxItems": 1, "description": "Array of ISO 3166-1 alpha-2 country codes to add to the campaign (maximum 1 country per request).", "items": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "UK", "US", "ZA" ] } }, "budgetCaps": { "type": "object", "description": "Budget caps configuration for the countries being added.", "properties": { "countryMonetaryBudgetSettings": { "type": "object", "description": "Country-specific monetary budget settings with marketplace-specific constraints.", "properties": { "US": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for US marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "CA": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for CA marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "UK": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for UK marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "GB": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for GB marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "DE": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for DE marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "FR": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for FR marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "IT": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for IT marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "ES": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for ES marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "IN": { "type": "object", "properties": { "value": { "type": "number", "minimum": 50, "maximum": 21000000, "description": "Daily budget for IN marketplace (min: 50, max: 21,000,000)" } }, "required": [ "value" ] }, "JP": { "type": "object", "properties": { "value": { "type": "number", "minimum": 100, "maximum": 21000000, "description": "Daily budget for JP marketplace (min: 100, max: 21,000,000)" } }, "required": [ "value" ] }, "AU": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1.4, "maximum": 1500000, "description": "Daily budget for AU marketplace (min: 1.4, max: 1,500,000)" } }, "required": [ "value" ] }, "MX": { "type": "object", "properties": { "value": { "type": "number", "minimum": 12, "maximum": 1000000, "description": "Daily budget for MX marketplace (min: 12, max: 1,000,000)" } }, "required": [ "value" ] }, "AE": { "type": "object", "properties": { "value": { "type": "number", "minimum": 4, "maximum": 3700000, "description": "Daily budget for AE marketplace (min: 4, max: 3,700,000)" } }, "required": [ "value" ] }, "SA": { "type": "object", "properties": { "value": { "type": "number", "minimum": 4, "maximum": 3700000, "description": "Daily budget for SA marketplace (min: 4, max: 3,700,000)" } }, "required": [ "value" ] }, "BR": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1.32, "maximum": 5300000, "description": "Daily budget for BR marketplace (min: 1.32, max: 5,300,000)" } }, "required": [ "value" ] }, "NL": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for NL marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "SG": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1.39, "maximum": 1300000, "description": "Daily budget for SG marketplace (min: 1.39, max: 1,300,000)" } }, "required": [ "value" ] }, "TR": { "type": "object", "properties": { "value": { "type": "number", "minimum": 2, "maximum": 2500000, "description": "Daily budget for TR marketplace (min: 2, max: 2,500,000)" } }, "required": [ "value" ] }, "PL": { "type": "object", "properties": { "value": { "type": "number", "minimum": 2, "maximum": 2000000, "description": "Daily budget for PL marketplace (min: 2, max: 2,000,000)" } }, "required": [ "value" ] }, "SE": { "type": "object", "properties": { "value": { "type": "number", "minimum": 9, "maximum": 9300000, "description": "Daily budget for SE marketplace (min: 9, max: 9,300,000)" } }, "required": [ "value" ] }, "EG": { "type": "object", "properties": { "value": { "type": "number", "minimum": 7, "maximum": 7400000, "description": "Daily budget for EG marketplace (min: 7, max: 7,400,000)" } }, "required": [ "value" ] }, "BE": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for BE marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] }, "ZA": { "type": "object", "properties": { "value": { "type": "number", "minimum": 20, "maximum": 7000000, "description": "Daily budget for ZA marketplace (min: 20, max: 7,000,000)" } }, "required": [ "value" ] }, "IE": { "type": "object", "properties": { "value": { "type": "number", "minimum": 1, "maximum": 1000000, "description": "Daily budget for IE marketplace (min: 1, max: 1,000,000)" } }, "required": [ "value" ] } }, "additionalProperties": false } }, "required": [ "countryMonetaryBudgetSettings" ] } }, "defaultBid": { "type": "number", "description": "Default bid applied to all ad groups in the target country. Must be greater than 0." }, "keywords": { "type": "array", "minItems": 1, "description": "Keywords to target in the expanded country, applied to all ad groups.", "items": { "type": "object", "properties": { "keyword": { "type": "string", "description": "The keyword text to target." }, "matchType": { "type": "string", "description": "The match type for the keyword.", "enum": [ "BROAD", "PHRASE", "EXACT" ] }, "bid": { "type": "number", "description": "The bid amount for this keyword. Must be greater than 0." } }, "required": [ "keyword", "matchType", "bid" ] } } }, "required": [ "id", "countryCodes", "budgetCaps", "defaultBid", "keywords" ] } }, "required": [ "accessRequestedAccount", "campaigns" ] } }, "required": [ "body" ] }, "query_campaignInputSchema": { "type": "object", "properties": { "skill": { "type": "object", "description": "Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.", "properties": { "skillName": { "type": "string" }, "version": { "type": "string" } }, "required": [ "skillName", "version" ] }, "body": { "type": "object", "properties": { "accessRequestedAccount": { "oneOf": [ { "type": "object", "properties": { "advertiserAccountId": { "type": "string", "description": "The identifier of an Amazon Ads Advertiser Account." } }, "required": [ "advertiserAccountId" ] }, { "type": "object", "properties": { "profileId": { "type": "string", "description": "The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input." } }, "required": [ "profileId" ] } ] }, "adProductFilter": { "type": "object", "properties": { "include": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "string", "enum": [ "AMAZON_DSP", "SPONSORED_BRANDS", "SPONSORED_DISPLAY", "SPONSORED_PRODUCTS", "SPONSORED_TELEVISION" ] }, "description": "Only one ad product can be queried at a time." } }, "required": [ "include" ] }, "campaignIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "goalFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "AWARENESS", "CONSIDERATION", "CONVERSIONS" ] } } }, "required": [ "include" ] }, "marketplaceScopeFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "GLOBAL", "SINGLE_MARKETPLACE" ] } } }, "required": [ "include" ] }, "maxResults": { "type": "integer" }, "nameFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "queryTermMatchType": { "type": "string", "enum": [ "BROAD_MATCH", "EXACT_MATCH" ] } }, "required": [ "include", "queryTermMatchType" ] }, "nextToken": { "type": "string" }, "portfolioIdFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } } }, "required": [ "include" ] }, "stateFilter": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "enum": [ "ARCHIVED", "DRAFT", "ENABLED", "PAUSED" ] }, "description": "DRAFT applies to Amazon DSP campaigns only. Send [\"DRAFT\"] on its own to get draft campaigns and nothing else. A state filter that does not name DRAFT leaves draft campaigns out. Naming DRAFT together with other states returns draft campaigns as well as campaigns in those states. Draft campaigns also come back when campaignIdFilter names specific campaigns and no stateFilter is sent. At most 3 states are accepted per call, so all four values cannot be sent together." } }, "required": [ "include" ] } }, "required": [ "accessRequestedAccount", "adProductFilter" ] } }, "required": [ "body" ] } } } }