{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"DSPAdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised 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"},"maxItems":500,"minItems":1,"type":"array"},"bid":{"$ref":"#/components/schemas/DSPAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/DSPBudget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creationDateTime":{"description":"The date time that the ad group was created.","format":"date-time","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/DSPCreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/DSPFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/DSPFrequency"},"maxItems":3,"minItems":0,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/DSPInventoryType"},"lastUpdatedDateTime":{"description":"The date time that the ad group was last updated.","format":"date-time","type":"string"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DSPOptimization"},"pacing":{"$ref":"#/components/schemas/DSPPacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DSPState"},"status":{"$ref":"#/components/schemas/DSPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/DSPTag"},"maxItems":1,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/DSPTargetingSettings"}},"required":["adGroupId","adProduct","advertisedProductCategoryIds","bid","campaignId","creationDateTime","creativeRotationType","endDateTime","inventoryType","lastUpdatedDateTime","name","optimization","pacing","startDateTime","state","targetingSettings"],"type":"object"},"DSPAdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdGroupAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/DSPAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group. This field is optional for ad groups that use automated bid optimization; when omitted, the system manages bidding on your behalf. It remains required when automated bid optimization is false, or if automated bid optimization is not available (e.g. programmatic guaranteed deal).","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"maxAverageBid":{"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).","format":"double","type":"number"}},"required":["currencyCode"],"type":"object"},"DSPAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/DSPBudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"DSPAdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised 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"},"maxItems":500,"minItems":1,"type":"array"},"bid":{"$ref":"#/components/schemas/DSPCreateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/DSPCreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creativeRotationType":{"$ref":"#/components/schemas/DSPCreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/DSPCreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/DSPCreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"inventoryType":{"$ref":"#/components/schemas/DSPInventoryType"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DSPCreateOptimization"},"pacing":{"$ref":"#/components/schemas/DSPCreatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DSPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/DSPCreateTag"},"maxItems":1,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/DSPCreateTargetingSettings"}},"required":["adProduct","advertisedProductCategoryIds","bid","campaignId","creativeRotationType","endDateTime","inventoryType","name","optimization","pacing","startDateTime","state","targetingSettings"],"type":"object"},"DSPAdGroupInventoryTypeFilter":{"properties":{"include":{"description":"**InventoryType Enum:**\n| InventoryType | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AAP_MOBILE_APP` |  |\n| `DISPLAY` |  |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `AUDIO_AMAZON_DEAL` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling.  |","items":{"$ref":"#/components/schemas/DSPInventoryType"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdGroupMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":20,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPAdGroupMultiStatusSuccess"},"maxItems":20,"minItems":0,"type":"array"}},"type":"object"},"DSPAdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/DSPAdGroup"},"index":{"format":"int32","maximum":19,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"DSPAdGroupStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\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. |","items":{"$ref":"#/components/schemas/DSPState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DSPAdGroup"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DSPAdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"advertisedProductCategoryIds":{"description":"The array of identifiers of advertised 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"},"maxItems":500,"minItems":1,"type":"array"},"bid":{"$ref":"#/components/schemas/DSPUpdateAdGroupBid"},"budgets":{"description":"An object containing budget details for the ad group.","items":{"$ref":"#/components/schemas/DSPCreateBudget"},"maxItems":3,"minItems":0,"type":"array"},"creativeRotationType":{"$ref":"#/components/schemas/DSPCreativeRotationType"},"endDateTime":{"description":"The end date time for the ad group.","format":"date-time","type":"string"},"fees":{"description":"The fees associated with the ad group.","items":{"$ref":"#/components/schemas/DSPCreateFee"},"maxItems":7,"minItems":0,"type":"array"},"frequencies":{"description":"An object containing frequency details for the ad group.","items":{"$ref":"#/components/schemas/DSPCreateFrequency"},"maxItems":3,"minItems":0,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/DSPUpdateOptimization"},"pacing":{"$ref":"#/components/schemas/DSPUpdatePacing"},"purchaseOrderNumber":{"description":"The purchase order number associated with the ad group.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the ad group.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/DSPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad group","items":{"$ref":"#/components/schemas/DSPCreateTag"},"maxItems":1,"minItems":0,"type":"array"},"targetingSettings":{"$ref":"#/components/schemas/DSPUpdateTargetingSettings"}},"required":["adGroupId"],"type":"object"},"DSPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","enum":["AMAZON_DSP"],"type":"string"},"DSPAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"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.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/DSPViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"DSPAutomatedTargetingTactic":{"description":"**AutomatedTargetingTactic Enum:**\n\n| AutomatedTargetingTactic | Description |\n|------|------|\n| `AWARENESS` | Ad Group tactic (Complete TV) that indicates that this line item drives awareness to your selected audience on publisher streaming TV for the linked deal while fulfilling your commitment. |\n| `CUSTOMER_ACQUISITION` | Ad Group Tactic (P+) that reaches shoppers who are similar to past purchasers |\n| `MAXIMIZE_PERFORMANCE` | Ad Group Tactic (P+) that reaches shoppers who are similar to past shoppers who viewed a product detail page |\n| `PROSPECTING` | Ad Group Tactic (B+) that reaches consumers who are highly likely to show interest and engage with your brand or product |\n| `REMARKETING` | Ad Group Tactic (P+) that reaches shoppers who have viewed a product detail page, searched for your product, or visited your homepage |\n| `RETENTION` | Ad Group Tactic (P+) that reaches shoppers who have purchased your product |\n| `SEARCH` | Ad Group Tactic that targets shoppers based on search signals. |\n","enum":["AWARENESS","CUSTOMER_ACQUISITION","MAXIMIZE_PERFORMANCE","PROSPECTING","REMARKETING","RETENTION","SEARCH"],"type":"string"},"DSPBidStrategy":{"description":"**BidStrategy Enum:**\n\n| BidStrategy | Description |\n|------|------|\n| `PRIORITIZE_KPI_TARGET` | Optimizes bidding to achieve the KPI target specified. |\n| `SPEND_BUDGET_IN_FULL` | Prioritize spending full budget, while maximizing performance |\n| `USE_CAMPAIGN_STRATEGY` | Inherit the bid strategy from the parent campaign. |\n","enum":["PRIORITIZE_KPI_TARGET","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"],"type":"string"},"DSPBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/DSPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/DSPBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/DSPRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"DSPBudgetAllocation":{"description":"**BudgetAllocation Enum:**\n\n| BudgetAllocation | Description |\n|------|------|\n| `AUTO` | Automatically allocate budget to better performing ad groups based on the selected goal KPI. |\n| `MANUAL` | Manually allocate budget across ad groups. |\n","enum":["AUTO","MANUAL"],"type":"string"},"DSPBudgetType":{"enum":["MONETARY"],"type":"string"},"DSPBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/DSPMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"DSPCreateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group. This field is optional for ad groups that use automated bid optimization; when omitted, the system manages bidding on your behalf. It remains required when automated bid optimization is false, or if automated bid optimization is not available (e.g. programmatic guaranteed deal).","format":"double","type":"number"},"maxAverageBid":{"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).","format":"double","type":"number"}},"type":"object"},"DSPCreateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/DSPBudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"DSPCreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DSPAdGroupCreate"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"DSPCreateAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"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.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/DSPViewabilityTier"}},"required":["includeUnmeasurableImpressions","viewabilityTier"],"type":"object"},"DSPCreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/DSPBudgetType"},"budgetValue":{"$ref":"#/components/schemas/DSPCreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/DSPRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"DSPCreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/DSPCreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"DSPCreateFee":{"properties":{"addToBudgetSpentAmount":{"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.","type":"boolean"},"feeType":{"$ref":"#/components/schemas/DSPFeeType"},"feeValue":{"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%.","format":"double","type":"number"},"thirdPartyProvider":{"$ref":"#/components/schemas/DSPFeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","feeType","feeValue","thirdPartyProvider"],"type":"object"},"DSPCreateFrequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/DSPFrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/DSPTimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"DSPCreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"DSPCreateMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/DSPCreateMonetaryBudget"}},"type":"object"},"DSPCreateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/DSPBidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/DSPCreateAdGroupBudgetSettings"}},"required":["bidStrategy"],"type":"object"},"DSPCreatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DSPDeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"DSPCreateState":{"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 Enum:**\n| CreateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\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":["DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPCreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"DSPCreateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/DSPCreateAmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/DSPAutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DSPDefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/DSPTacticsConvertersExclusionType"},"targetedPGDealId":{"description":"The deal Id (advertisingDealId in Ads API v1, deal.id in v0) to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal is provided at time of ad group creation. The deal ID visible in the ADSP UI corresponds to exchangeDealId in Ads API v1, and externalDealId in v0.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/DSPTimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/DSPUserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/DSPVideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"DSPCreativeRotationType":{"description":"**CreativeRotationType Enum:**\n\n| CreativeRotationType | Description |\n|------|------|\n| `RANDOM` | Creatives are rotated randomly with equal weight. |\n| `WEIGHTED` | Creatives are rotated based on assigned weights. |\n","enum":["RANDOM","WEIGHTED"],"type":"string"},"DSPCurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `ARS` | Argentine Peso |\n| `AUD` | Australian Dollar |\n| `BGN` | Bulgarian Lev |\n| `BHD` | Bahraini Dinar |\n| `BOB` | Bolivian Boliviano |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CLP` | Chilean Peso |\n| `CNY` | Chinese Yuan |\n| `COP` | Colombian Peso |\n| `CRC` | Costa Rican Colón |\n| `CZK` | Czech Koruna |\n| `DKK` | Danish Krone |\n| `DOP` | Dominican Peso |\n| `DZD` | Algerian Dinar |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `GTQ` | Guatemalan Quetzal |\n| `HKD` | Hong Kong Dollar |\n| `HNL` | Honduran Lempira |\n| `HRK` | Croatian Kuna |\n| `HUF` | Hungarian Forint |\n| `IDR` | Indonesian Rupiah |\n| `ILS` | Israeli New Shekel |\n| `INR` | Indian Rupee |\n| `JMD` | Jamaican Dollar |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `KWD` | Kuwaiti Dinar |\n| `MAD` | Moroccan Dirham |\n| `MXN` | Mexican Peso |\n| `MYR` | Malaysian Ringgit |\n| `NOK` | Norwegian Krone |\n| `PAB` | Panamanian Balboa |\n| `PEN` | Peruvian Sol |\n| `PHP` | Philippine Peso |\n| `PKR` | Pakistani Rupee |\n| `PLN` | Polish Złoty |\n| `PYG` | Paraguayan Guaraní |\n| `QAR` | Qatari Riyal |\n| `RON` | Romanian Leu |\n| `RSD` | Serbian Dinar |\n| `RUB` | Russian Ruble |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `THB` | Thai Baht |\n| `TND` | Tunisian Dinar |\n| `TRY` | Turkish Lira |\n| `TWD` | New Taiwan Dollar |\n| `UAH` | Ukrainian Hryvnia |\n| `USD` | United States Dollar |\n| `UYU` | Uruguayan Peso |\n| `VND` | Vietnamese Đồng |\n| `ZAR` | South African Rand |\n","enum":["AED","ARS","AUD","BGN","BHD","BOB","BRL","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","DZD","EGP","EUR","GBP","GTQ","HKD","HNL","HRK","HUF","IDR","ILS","INR","JMD","JPY","KRW","KWD","MAD","MXN","MYR","NOK","PAB","PEN","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SEK","SGD","THB","TND","TRY","TWD","UAH","USD","UYU","VND","ZAR"],"type":"string"},"DSPDefaultAudienceTargetingMatchType":{"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 Enum:**\n\n| DefaultAudienceTargetingMatchType | Description |\n|------|------|\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n","enum":["EXACT","SIMILAR"],"type":"string"},"DSPDeliveryProfile":{"description":"**DeliveryProfile Enum:**\n\n| DeliveryProfile | Description |\n|------|------|\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there\u0027s no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |\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","enum":["ASAP","EVEN","PACE_AHEAD"],"type":"string"},"DSPDeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `OTHER` |  |\n","enum":["AD_CREATIVES_NOT_RUNNING","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","OTHER"],"type":"string"},"DSPDeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DSPFee":{"properties":{"addToBudgetSpentAmount":{"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.","type":"boolean"},"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"feeType":{"$ref":"#/components/schemas/DSPFeeType"},"feeValue":{"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%.","format":"double","type":"number"},"feeValueType":{"$ref":"#/components/schemas/DSPFeeValueType"},"thirdPartyProvider":{"$ref":"#/components/schemas/DSPFeesThirdPartyProvider"}},"required":["addToBudgetSpentAmount","feeType","feeValue","feeValueType","thirdPartyProvider"],"type":"object"},"DSPFeeType":{"description":"**FeeType Enum:**\n\n| FeeType | Description |\n|------|------|\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\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| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |\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_AUDIENCE` | CPM fee for using a third party audience. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"],"type":"string"},"DSPFeeValueType":{"description":"**FeeValueType Enum:**\n\n| FeeValueType | Description |\n|------|------|\n| `FIXED_CPM` | Charged based on a fixed CPM. The currency depends on the feeType. |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |\n| `PERCENTAGE_OF_SUPPLY_COST` | Charged as a percent of supply (media) cost. Ranges from 0 to 1 where 0.15 represents 15%. |\n","enum":["FIXED_CPM","PERCENTAGE_OF_BUDGET","PERCENTAGE_OF_SUPPLY_COST"],"type":"string"},"DSPFeesThirdPartyProvider":{"enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"],"type":"string"},"DSPFrequency":{"properties":{"eventMaxCount":{"description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500.","format":"int32","maximum":99000,"minimum":1,"type":"integer"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/DSPFrequencyTargetingSetting"},"timeCount":{"description":"The value associated with the time and unit of time for this frequency cap.","format":"int32","maximum":60,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/DSPTimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting","timeCount","timeUnit"],"type":"object"},"DSPFrequencyTargetingSetting":{"description":"**FrequencyTargetingSetting Enum:**\n\n| FrequencyTargetingSetting | Description |\n|------|------|\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |\n| `USER` | Control frequency an ad will be selected to a person. |\n","enum":["HOUSEHOLD","USER"],"type":"string"},"DSPInventoryType":{"description":"**InventoryType Enum:**\n\n| InventoryType | Description |\n|------|------|\n| `AAP_MOBILE_APP` |  |\n| `AMAZON_MOBILE_DISPLAY` |  |\n| `AUDIO_AMAZON_DEAL` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |\n| `DISPLAY` |  |\n| `LIVE_EVENTS` | Real-time broadcast inventory (sports, concerts, award shows) with audience volatility and concentrated traffic patterns requiring specialized pacing algorithms and event-specific metadata handling. |\n| `ONLINE_VIDEO` |  |\n| `PODCAST` | Podcast ads that serve on streaming podcast inventory. |\n| `STANDARD_DISPLAY` |  |\n| `STREAMING_TV_AMAZON_DEAL` |  |\n| `STREAMING_TV` |  |\n| `VIDEO` |  |\n","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","AUDIO_AMAZON_DEAL","DISPLAY","LIVE_EVENTS","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","STREAMING_TV_AMAZON_DEAL","VIDEO"],"type":"string"},"DSPMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"DSPMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/DSPMonetaryBudget"}},"type":"object"},"DSPOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/DSPBidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/DSPAdGroupBudgetSettings"}},"required":["bidStrategy"],"type":"object"},"DSPPacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DSPDeliveryProfile"}},"required":["deliveryProfile"],"type":"object"},"DSPQueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/DSPAdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/DSPAdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/DSPAdGroupCampaignIdFilter"},"inventoryTypeFilter":{"$ref":"#/components/schemas/DSPAdGroupInventoryTypeFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/DSPAdGroupStateFilter"}},"required":["adProductFilter"],"type":"object"},"DSPRecurrence":{"enum":["DAILY","LIFETIME","MONTHLY"],"type":"string"},"DSPSiteLanguage":{"description":"**SiteLanguage Enum:**\n\n| SiteLanguage | Description |\n|------|------|\n| `AR` | Arabic. |\n| `BN` | Bengali. |\n| `CS` | Czech. |\n| `DA` | Danish. |\n| `DE` | German. |\n| `EN` | English. |\n| `ES` | Spanish. |\n| `FI` | Finnish. |\n| `FR` | French. |\n| `GU` | Gujarati. |\n| `HI` | Hindi. |\n| `IT` | Italian. |\n| `JA` | Japanese. |\n| `KN` | Kannada. |\n| `ML` | Malayalam. |\n| `MR` | Marathi. |\n| `NL` | Dutch. |\n| `NO` | Norwegian. |\n| `OTHER` | Other language. |\n| `PA` | Punjabi. |\n| `PL` | Polish. |\n| `PT` | Portuguese. |\n| `SV` | Swedish. |\n| `TA` | Tamil. |\n| `TE` | Telugu. |\n| `TR` | Turkish. |\n| `ZH` | Chinese. |\n","enum":["AR","BN","CS","DA","DE","EN","ES","FI","FR","GU","HI","IT","JA","KN","ML","MR","NL","NO","OTHER","PA","PL","PT","SV","TA","TE","TR","ZH"],"type":"string"},"DSPState":{"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 Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\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","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DSPDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DSPDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"DSPTacticsConvertersExclusionType":{"description":"**TacticsConvertersExclusionType Enum:**\n\n| TacticsConvertersExclusionType | Description |\n|------|------|\n| `NO_EXCLUSION` | Do not exclude any converters from targeting. |\n| `RECENT_CONVERTERS` | Exclude recent converters from targeting to focus on new customers. |\n","enum":["NO_EXCLUSION","RECENT_CONVERTERS"],"type":"string"},"DSPTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"DSPTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/DSPAmazonViewability"},"automatedTargetingTactic":{"$ref":"#/components/schemas/DSPAutomatedTargetingTactic"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DSPDefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"siteLanguage":{"$ref":"#/components/schemas/DSPSiteLanguage"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/DSPTacticsConvertersExclusionType"},"targetedPGDealId":{"description":"The deal Id (advertisingDealId in Ads API v1, deal.id in v0) to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal is provided at time of ad group creation. The deal ID visible in the ADSP UI corresponds to exchangeDealId in Ads API v1, and externalDealId in v0.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/DSPTimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/DSPUserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/DSPVideoCompletionTier"}},"required":["amazonViewability","timeZoneType","userLocationSignal"],"type":"object"},"DSPTimeUnit":{"enum":["DAYS","HOURS","MINUTES"],"type":"string"},"DSPTimeZoneType":{"description":"**TimeZoneType Enum:**\n\n| TimeZoneType | Description |\n|------|------|\n| `ADVERTISER_REGION` | Use the advertiser\u0027s regional time zone for daypart targeting. |\n| `VIEWER` | Use the viewer\u0027s local time zone for daypart targeting. |\n","enum":["ADVERTISER_REGION","VIEWER"],"type":"string"},"DSPUpdateAdGroupBid":{"properties":{"baseBid":{"description":"The lower bound bid used for the ads in the ad group. This field is optional for ad groups that use automated bid optimization; when omitted, the system manages bidding on your behalf. It remains required when automated bid optimization is false, or if automated bid optimization is not available (e.g. programmatic guaranteed deal).","format":"double","type":"number"},"maxAverageBid":{"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).","format":"double","nullable":true,"type":"number"}},"type":"object"},"DSPUpdateAdGroupBudgetSettings":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/DSPBudgetAllocation"},"dailyMinSpendValue":{"description":"Denotes the daily minimum spend on the ad group in local currency.","format":"double","type":"number"}},"type":"object"},"DSPUpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/DSPAdGroupUpdate"},"maxItems":20,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"DSPUpdateAmazonViewability":{"properties":{"includeUnmeasurableImpressions":{"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.","type":"boolean"},"viewabilityTier":{"$ref":"#/components/schemas/DSPViewabilityTier"}},"type":"object"},"DSPUpdateOptimization":{"properties":{"bidStrategy":{"$ref":"#/components/schemas/DSPBidStrategy"},"budgetSettings":{"$ref":"#/components/schemas/DSPUpdateAdGroupBudgetSettings"}},"type":"object"},"DSPUpdatePacing":{"properties":{"deliveryProfile":{"$ref":"#/components/schemas/DSPDeliveryProfile"}},"type":"object"},"DSPUpdateState":{"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 Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\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":["DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPUpdateTargetingSettings":{"properties":{"amazonViewability":{"$ref":"#/components/schemas/DSPUpdateAmazonViewability"},"defaultAudienceTargetingMatchType":{"$ref":"#/components/schemas/DSPDefaultAudienceTargetingMatchType"},"enableLanguageTargeting":{"description":"If set to true, creatives will only target supply where the content language matches the creative language.","type":"boolean"},"tacticsConvertersExclusionType":{"$ref":"#/components/schemas/DSPTacticsConvertersExclusionType"},"targetedPGDealId":{"description":"The deal Id (advertisingDealId in Ads API v1, deal.id in v0) to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal is provided at time of ad group creation. The deal ID visible in the ADSP UI corresponds to exchangeDealId in Ads API v1, and externalDealId in v0.","type":"string"},"timeZoneType":{"$ref":"#/components/schemas/DSPTimeZoneType"},"userLocationSignal":{"$ref":"#/components/schemas/DSPUserLocationSignal"},"videoCompletionTier":{"$ref":"#/components/schemas/DSPVideoCompletionTier"}},"type":"object"},"DSPUserLocationSignal":{"description":"**UserLocationSignal Enum:**\n\n| UserLocationSignal | Description |\n|------|------|\n| `CURRENT` | Target users based on their current geographic location. |\n| `MULTIPLE_SIGNALS` | Target users based on multiple location signals. |\n","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"DSPVideoCompletionTier":{"description":"**VideoCompletionTier Enum:**\n\n| VideoCompletionTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all video completion tiers. |\n| `GREATER_THAN_10_PERCENT` | Target videos with greater than 10% predicted completion rate. |\n| `GREATER_THAN_20_PERCENT` | Target videos with greater than 20% predicted completion rate. |\n| `GREATER_THAN_30_PERCENT` | Target videos with greater than 30% predicted completion rate. |\n| `GREATER_THAN_40_PERCENT` | Target videos with greater than 40% predicted completion rate. |\n| `GREATER_THAN_50_PERCENT` | Target videos with greater than 50% predicted completion rate. |\n| `GREATER_THAN_60_PERCENT` | Target videos with greater than 60% predicted completion rate. |\n| `GREATER_THAN_70_PERCENT` | Target videos with greater than 70% predicted completion rate. |\n| `GREATER_THAN_80_PERCENT` | Target videos with greater than 80% predicted completion rate. |\n| `GREATER_THAN_90_PERCENT` | Target videos with greater than 90% predicted completion rate. |\n","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"],"type":"string"},"DSPViewabilityTier":{"description":"**ViewabilityTier Enum:**\n\n| ViewabilityTier | Description |\n|------|------|\n| `ALL_TIERS` | Target all viewability tiers with no filtering. |\n| `GREATER_THAN_40_PERCENT` | Target impressions with greater than 40% predicted viewability. |\n| `GREATER_THAN_50_PERCENT` | Target impressions with greater than 50% predicted viewability. |\n| `GREATER_THAN_60_PERCENT` | Target impressions with greater than 60% predicted viewability. |\n| `GREATER_THAN_70_PERCENT` | Target impressions with greater than 70% predicted viewability. |\n| `LESS_THAN_40_PERCENT` | Target impressions with less than 40% predicted viewability. |\n","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"],"type":"string"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `ACTION_NOT_SUPPORTED` | The request is not supported. |\n| `ACTIVE_RESOURCE_LIMIT_EXCEEDED` | Too many live resources. Remove resources and try again. |\n| `ARCHIVED_PARENT_CANNOT_CREATE` | New resources cannot be created within an archived parent. |\n| `ARCHIVED_PARENT_CANNOT_EDIT` | Resources within an archived parent cannot be edited. |\n| `ARCHIVED_RESOURCE_CANNOT_EDIT` | Archived resources cannot be edited. |\n| `ASSET_NOT_READY` | The provided asset is still being processed. |\n| `AUTOCREATED_ENTITY_CANNOT_EDIT` | Autocreated entities cannot be edited. To complete this action, create the resource manually. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","ASSET_NOT_READY","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":4999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"DSP AdGroups API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/adGroups":{"post":{"description":"Create ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"DSPCreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCreateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdGroupMultiStatusResponse"}}},"description":"DSPCreateAdGroup 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/query/adGroups":{"post":{"description":"List ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"DSPQueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPQueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdGroupSuccessResponse"}}},"description":"DSPQueryAdGroup 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}},"/adsApi/v1/update/adGroups":{"post":{"description":"Update ad groups\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Note:** For Amazon DSP, `state` supports only ENABLED and PAUSED; ARCHIVED is not a valid state for DSP ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"DSPUpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPUpdateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdGroupMultiStatusResponse"}}},"description":"DSPUpdateAdGroup 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["AdGroups"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}