{"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"},"DSPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","enum":["AMAZON_DSP"],"type":"string"},"DSPAdvertisingDeal":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"advertisingDealId":{"description":"A unique identifier generated by ADSP for a deal. This is not the same as the identifier provided by an exchange/SSP for a deal.","type":"string"},"creationDateTime":{"description":"The date time that the deal was created.","format":"date-time","type":"string"},"creativeRequirements":{"$ref":"#/components/schemas/DSPCreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/DSPAdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"exchangeDealId":{"description":"An identifier provided by an exchange/SSP for a deal. This is the deal ID visible in the ADSP UI and used by exchanges/SSPs when communicating with advertisers.","type":"string"},"exchangeId":{"description":"The exchange/SSP that provides the deal.","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/DSPAdvertisingDealStatus"},"supplyInventoryTypes":{"description":"The inventory type of the deal declared by the supplier. Use this field to find deals compatible with an ad group. For a DISPLAY ad group, query deals with supplyInventoryType DISPLAY. For a STREAMING_TV or ONLINE_VIDEO ad group, query deals with supplyInventoryType VIDEO. For an AUDIO or PODCAST ad group, query deals with supplyInventoryType AUDIO. Deals with an empty supplyInventoryTypes list have no inventory type restriction.","items":{"$ref":"#/components/schemas/DSPSupplyInventoryType"},"maxItems":3,"minItems":0,"type":"array"},"supplyMetadata":{"$ref":"#/components/schemas/DSPSupplyMetadata"},"terms":{"$ref":"#/components/schemas/DSPAdvertisingDealTerms"}},"required":["adProduct","advertisingDealId","creationDateTime","dealType","endDateTime","name","startDateTime","status"],"type":"object"},"DSPAdvertisingDealAdProductFilter":{"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"},"DSPAdvertisingDealAdvertisingDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealAdvertisingDealPriceTypeFilter":{"properties":{"include":{"description":"**PriceType Enum:**\n| PriceType | Description |\n| --- | --- |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `FIXED_CPM` | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n| `FLOOR_RATE` | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |","items":{"$ref":"#/components/schemas/DSPAdvertisingDealPriceType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealAdvertisingDealTypeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealBroadcastersFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealCountryCodeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPCountryCode"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"creativeRequirements":{"$ref":"#/components/schemas/DSPCreateCreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/DSPAdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"exchangeDealId":{"description":"An identifier provided by an exchange/SSP for a deal. This is the deal ID visible in the ADSP UI and used by exchanges/SSPs when communicating with advertisers.","type":"string"},"exchangeId":{"description":"The exchange/SSP that provides the deal.","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"terms":{"$ref":"#/components/schemas/DSPCreateAdvertisingDealTerms"}},"required":["adProduct","dealType","endDateTime","name","startDateTime"],"type":"object"},"DSPAdvertisingDealCreationDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPDateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealEndDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPDateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealExchangeDealIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealExchangeIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealLeaguesFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealMarketplaceDealFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"DSPAdvertisingDealMultiStatusSuccess":{"properties":{"advertisingDeal":{"$ref":"#/components/schemas/DSPAdvertisingDeal"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["advertisingDeal","index"],"type":"object"},"DSPAdvertisingDealNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/DSPAdvertisingDealNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"DSPAdvertisingDealNameFilterType":{"description":"**AdvertisingDealNameFilterType Enum:**\n| AdvertisingDealNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |","enum":["EXACT_MATCH"],"type":"string"},"DSPAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"priceType":{"$ref":"#/components/schemas/DSPAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"DSPAdvertisingDealPriceRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPMonetaryRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealPriceType":{"description":"**AdvertisingDealPriceType Enum:**\n\n| AdvertisingDealPriceType | Description |\n|------|------|\n| `FIXED_CPM` | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n| `FIXED_PRICE` | Sale price for a specific ad placement regardless of auction performance. |\n| `FLOOR_RATE` | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |\n","enum":["FIXED_CPM","FIXED_PRICE","FLOOR_RATE"],"type":"string"},"DSPAdvertisingDealSortOption":{"properties":{"by":{"$ref":"#/components/schemas/DSPAdvertisingDealSortOptionsFields"},"direction":{"$ref":"#/components/schemas/DSPSortDirection"}},"required":["by"],"type":"object"},"DSPAdvertisingDealSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| advertisingDealId | ASCENDING,DESCENDING |\n| creationDateTime | ASCENDING,DESCENDING |\n| dealType | ASCENDING,DESCENDING |\n| endDateTime | ASCENDING,DESCENDING |\n| exchangeDealId | ASCENDING,DESCENDING |\n| name | ASCENDING,DESCENDING |\n| price | ASCENDING,DESCENDING |\n| startDateTime | ASCENDING,DESCENDING |","enum":["advertisingDealId","creationDateTime","dealType","endDateTime","exchangeDealId","name","price","startDateTime"],"type":"string"},"DSPAdvertisingDealSportsFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealStartDateTimeRangeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPDateTimeRange"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealStatus":{"properties":{"status":{"$ref":"#/components/schemas/DSPAdvertisingDealStatusEnum"}},"required":["status"],"type":"object"},"DSPAdvertisingDealStatusEnum":{"description":"**AdvertisingDealStatusEnum Enum:**\n\n| AdvertisingDealStatusEnum | Description |\n|------|------|\n| `ACTIVE` | Deal is ready to serve from SSP perspective. SSP will send bid requests for this deal (subject to dates and other validations). |\n| `ENDED` | Deal has passed its end date and is no longer active. |\n| `PAUSED` | Deal is temporarily paused from SSP perspective. SSP will not send bid requests for this deal, regardless of dates. |\n| `SCHEDULED` | Deal is approved and scheduled but has not yet reached its start date. |\n","enum":["ACTIVE","ENDED","PAUSED","SCHEDULED"],"type":"string"},"DSPAdvertisingDealStatusFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealStatus"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealSuccessResponse":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDeal"},"maxItems":10000,"minItems":0,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"DSPAdvertisingDealSupplyInventoryTypeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/DSPSupplyInventoryType"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/DSPMonetaryBudget"},"guaranteed":{"description":"If true, deal is PG Deal.","type":"boolean"},"marketplaceDeal":{"description":"If true, deal is available to all Amazon DSP entities globally. Marketplace deals cannot be edited by individual buyers.","type":"boolean"},"price":{"$ref":"#/components/schemas/DSPAdvertisingDealPrice"},"shareOfVoicePercentage":{"description":"Guaranteed Share-of-voice Percentage of the advertising deal. Used for SOV-based PG deals. Value must be \u003e 0 and \u003c\u003d 100. Mutually exclusive with budget.","format":"double","type":"number"}},"required":["guaranteed","marketplaceDeal","price"],"type":"object"},"DSPAdvertisingDealType":{"enum":["PREFERRED","PRIVATE_AUCTION","PROGRAMMATIC_GUARANTEED"],"type":"string"},"DSPAdvertisingDealUpdate":{"properties":{"advertisingDealId":{"description":"A unique identifier generated by ADSP for a deal. This is not the same as the identifier provided by an exchange/SSP for a deal.","type":"string"},"creativeRequirements":{"$ref":"#/components/schemas/DSPUpdateCreativeRequirements"},"customPublisherDescription":{"description":"Custom description of the publisher providing inventory for this deal.","type":"string"},"dealType":{"$ref":"#/components/schemas/DSPAdvertisingDealType"},"endDateTime":{"description":"The end date time for the deal.","format":"date-time","type":"string"},"name":{"description":"The name of the deal.","type":"string"},"startDateTime":{"description":"The start date time for the deal.","format":"date-time","type":"string"},"terms":{"$ref":"#/components/schemas/DSPUpdateAdvertisingDealTerms"}},"required":["advertisingDealId"],"type":"object"},"DSPCountryCode":{"enum":["IN"],"type":"string"},"DSPCreateAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"priceType":{"$ref":"#/components/schemas/DSPAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"required":["currencyCode","priceType","value"],"type":"object"},"DSPCreateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["advertisingDeals"],"type":"object"},"DSPCreateAdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/DSPCreateMonetaryBudget"},"price":{"$ref":"#/components/schemas/DSPCreateAdvertisingDealPrice"}},"required":["price"],"type":"object"},"DSPCreateCreativeRequirements":{"description":"Creative requirements associated with the deal.","type":"object"},"DSPCreateMonetaryBudget":{"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"},"DSPCreativeRequirements":{"description":"Creative requirements associated with the deal.","properties":{"creativeSource":{"$ref":"#/components/schemas/DSPCreativeSource"}},"type":"object"},"DSPCreativeSource":{"description":"**CreativeSource Enum:**\n\n| CreativeSource | Description |\n|------|------|\n| `ADVERTISER` | Creative is provided by the demand side (standard flow). |\n| `PUBLISHER` | Creative is hosted by the publisher\u0027s ad server (e.g., Google Ad Manager). |\n","enum":["ADVERTISER","PUBLISHER"],"type":"string"},"DSPCurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CNY` | Chinese Yuan |\n| `DKK` | Danish Krone |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |\n","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","INR","JPY","MXN","NOK","NZD","SAR","SEK","SGD","TRY","USD"],"type":"string"},"DSPDateTimeRange":{"description":"A date-time range with optional inclusive min and max bounds.","properties":{"max":{"description":"The maximum (inclusive) date time of the range.","format":"date-time","type":"string"},"min":{"description":"The minimum (inclusive) date time of the range.","format":"date-time","type":"string"}},"type":"object"},"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"},"DSPMonetaryRange":{"description":"A monetary range with optional inclusive min and max bounds and a required currency code.","properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"max":{"description":"The maximum (inclusive) monetary value of the range.","format":"double","type":"number"},"min":{"description":"The minimum (inclusive) monetary value of the range.","format":"double","type":"number"}},"required":["currencyCode"],"type":"object"},"DSPQueryAdvertisingDealRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealAdProductFilter"},"advertisingDealIdFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealAdvertisingDealIdFilter"},"broadcastersFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealBroadcastersFilter"},"countryCodeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealCountryCodeFilter"},"creationDateTimeRangeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealCreationDateTimeRangeFilter"},"dealTypeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealAdvertisingDealTypeFilter"},"endDateTimeRangeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealEndDateTimeRangeFilter"},"exchangeDealIdFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealExchangeDealIdFilter"},"exchangeIdFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealExchangeIdFilter"},"leaguesFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealLeaguesFilter"},"marketplaceDealFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealMarketplaceDealFilter"},"maxResults":{"default":1000,"format":"int32","maximum":10000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealNameFilter"},"nextToken":{"type":"string"},"priceRangeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealPriceRangeFilter"},"priceTypeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealAdvertisingDealPriceTypeFilter"},"sort":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealSortOption"},"maxItems":8,"minItems":0,"type":"array"},"sportsFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealSportsFilter"},"startDateTimeRangeFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealStartDateTimeRangeFilter"},"statusFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealStatusFilter"},"supplyInventoryTypesFilter":{"$ref":"#/components/schemas/DSPAdvertisingDealSupplyInventoryTypeFilter"}},"required":["adProductFilter"],"type":"object"},"DSPSortDirection":{"description":"**SortDirection Enum:**\n| SortDirection | Description |\n| --- | --- |\n| `ASCENDING` | Sort in ascending order |\n| `DESCENDING` | Sort in descending order |","enum":["ASCENDING","DESCENDING"],"type":"string"},"DSPSportsMetadata":{"description":"Live-sports classification for a deal. Populated for certified live-sports deals.","properties":{"broadcasters":{"description":"IDs of the broadcasters associated with this live-events deal, such as ESPN. Each ID references an entry in the Amazon Ads Live-Events Broadcasters Taxonomy; the human-readable name is resolved from that taxonomy. IDs are scoped to the broadcasters taxonomy and are not comparable to sport or league IDs. Populated for certified live-events deals.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"leagues":{"description":"IDs of the leagues associated with this live-events deal, such as NFL. Each ID references an entry in the Amazon Ads Live-Events Leagues Taxonomy; the human-readable name is resolved from that taxonomy. IDs are scoped to the leagues taxonomy and are not comparable to sport or broadcaster IDs. Populated for certified live-events deals.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"sports":{"description":"IDs of the sports associated with this live-events deal, such as American Football. Each ID references an entry in the Amazon Ads Live-Events Sports Taxonomy; the human-readable name is resolved from that taxonomy. IDs are scoped to the sports taxonomy and are not comparable to league or broadcaster IDs. Populated for certified live-events deals.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DSPSupplyInventoryType":{"enum":["AUDIO","DISPLAY","VIDEO"],"type":"string"},"DSPSupplyMetadata":{"description":"Supply-specific metadata for a deal. Which metadata applies depends on the type of supply the deal provides — for example, live-sports deals carry live-events classification (sports, leagues, broadcasters).\n\n| SupplyMetadata | Description |\n|------|------|\n| `sportsMetadata` | Classification for a live-sports deal (sports, leagues, broadcasters). |\n","oneOf":[{"properties":{"sportsMetadata":{"$ref":"#/components/schemas/DSPSportsMetadata"}},"required":["sportsMetadata"],"title":"sportsMetadata","type":"object"}]},"DSPUpdateAdvertisingDealPrice":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"priceType":{"$ref":"#/components/schemas/DSPAdvertisingDealPriceType"},"value":{"description":"The monetary amount of the price in the given currency.","format":"double","type":"number"}},"type":"object"},"DSPUpdateAdvertisingDealRequest":{"properties":{"advertisingDeals":{"items":{"$ref":"#/components/schemas/DSPAdvertisingDealUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["advertisingDeals"],"type":"object"},"DSPUpdateAdvertisingDealTerms":{"description":"Terms for a deal. Supports PA \u0026 PD deals along with both spend-based guarantees (standard PG) and share-of-voice based guarantees (PG-SOV).","properties":{"budget":{"$ref":"#/components/schemas/DSPUpdateMonetaryBudget"},"price":{"$ref":"#/components/schemas/DSPUpdateAdvertisingDealPrice"}},"type":"object"},"DSPUpdateCreativeRequirements":{"description":"Creative requirements associated with the deal.","type":"object"},"DSPUpdateMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"type":"object"},"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| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\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| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n","enum":["BAD_REQUEST","CONTENT_TOO_LARGE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":9,"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 AdvertisingDeals API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/advertisingDeals":{"post":{"description":"Create advertising deals\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"DSPCreateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCreateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdvertisingDealMultiStatusResponse"}}},"description":"DSPCreateAdvertisingDeal 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":["AdvertisingDeals"]}},"/adsApi/v1/query/advertisingDeals":{"post":{"description":"Query advertising deals with filters\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"DSPQueryAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPQueryAdvertisingDealRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdvertisingDealSuccessResponse"}}},"description":"DSPQueryAdvertisingDeal 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":["AdvertisingDeals"]}},"/adsApi/v1/update/advertisingDeals":{"post":{"description":"Update advertising deals\n\n**Requires one of these permissions**:\n[\"inventory_edit\", \"inventory_view\"]","operationId":"DSPUpdateAdvertisingDeal","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPUpdateAdvertisingDealRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdvertisingDealMultiStatusResponse"}}},"description":"DSPUpdateAdvertisingDeal 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":["AdvertisingDeals"]}}},"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"}]}