{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","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"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdProduct":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","enum":["AMAZON_DSP"],"type":"string"},"AdvertisingDealPriceType":{"description":"**AdvertisingDealPriceType Enum:**\n| AdvertisingDealPriceType | Description |\n| --- | --- |\n| `FLAT_FEE` | This value is deprecated. Please use FIXED_PRICE. |\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. |","enum":["FIXED_CPM","FIXED_PRICE","FLAT_FEE","FLOOR_RATE"],"type":"string"},"AdvertisingDealType":{"enum":["PREFERRED","PRIVATE_AUCTION","PROGRAMMATIC_GUARANTEED","SHARE_OF_VOICE"],"type":"string"},"AmazonMediaSupplierAdProductExtension":{"description":"Amazon Media specific supplier ad product fields.","properties":{"description":{"description":"The description of the publisher product.","type":"string"}},"type":"object"},"AmazonPublisherCloudGoalConstraints":{"description":"Amazon Publisher Cloud specific goal constraints.","properties":{"supportedGoals":{"description":"List of supported goal types for APC.","items":{"$ref":"#/components/schemas/AmazonPublisherServicesGoalTypes"},"maxItems":49,"minItems":0,"type":"array"}},"type":"object"},"AmazonPublisherDirectGoalConstraints":{"description":"Amazon Publisher Direct specific goal constraints.","properties":{"supportedGoals":{"description":"List of supported goal types for APD.","items":{"$ref":"#/components/schemas/AmazonPublisherServicesGoalTypes"},"maxItems":49,"minItems":0,"type":"array"}},"type":"object"},"AmazonPublisherServicesGoalTypes":{"description":"AmazonPublisherServicesGoalTypes is an enum representing the goal types that are supported in AmazonPublisherService. ON_TARGET_REACH: On-target reach, the absolute number of people in your target audience that is being reached by a campaign. CLICK_THROUGH_RATE: Clickthrough rate, a ratio showing how often people who see your ad or free product listing end up clicking it. VIDEO_COMPLETION_RATE: Video Completion Rate, measures the percentage of viewers who watch a video ad all the way to the end. VIEW_THROUGH_RATE: View-Through Rate, measures how many viewers watch a video ad to completion.","enum":["CLICK_THROUGH_RATE","ON_TARGET_REACH","VIDEO_COMPLETION_RATE","VIEW_THROUGH_RATE"],"type":"string"},"AudioCreativeRequirements":{"description":"Audio creative requirements.","properties":{"durationMs":{"description":"Required duration for audio creatives in milliseconds.","format":"int32","type":"integer"}},"type":"object"},"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"},"CountryCode":{"enum":["AD","AE","AF","AG","AI","AU","BR","CA","DE","ES","FR","GB","IT","JP","KR","MX","US"],"type":"string"},"CountryConfiguration":{"description":"Supported country configuration.","properties":{"constraintsOverride":{"$ref":"#/components/schemas/SupplierAdProductConstraints"},"country":{"$ref":"#/components/schemas/CountryCode"},"creativeRequirementsOverride":{"description":"Creative requirements override for this specific country. If this field is present, even if empty, the root-level creativeRequirements should be ignored for this country configuration.","items":{"$ref":"#/components/schemas/SupplierProposedDealCreativeRequirement"},"maxItems":49,"minItems":0,"type":"array"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"timezone":{"$ref":"#/components/schemas/TimeZone"}},"required":["country"],"type":"object"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n| CurrencyCode | Description |\n| --- | --- |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `JPY` | Japanese Yen |\n| `KRW` | South Korean Won |\n| `MXN` | Mexican Peso |\n| `USD` | United States Dollar |","enum":["AUD","BRL","CAD","EUR","GBP","JPY","KRW","MXN","USD"],"type":"string"},"DayOfWeek":{"description":"**DayOfWeek Enum:**\n| DayOfWeek | Description |\n| --- | --- |\n| `MONDAY` | Monday. |\n| `TUESDAY` | Tuesday. |\n| `WEDNESDAY` | Wednesday. |\n| `THURSDAY` | Thursday. |\n| `FRIDAY` | Friday. |\n| `SATURDAY` | Saturday. |\n| `SUNDAY` | Sunday. |","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"DisplayCreativeRequirements":{"description":"Display creative requirements.","properties":{"size":{"$ref":"#/components/schemas/Size"}},"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |","enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"EventType":{"enum":["IMPRESSION"],"type":"string"},"ExtraFrequencyCapImpressionType":{"description":"**ExtraFrequencyCapImpressionType Enum:**\n| ExtraFrequencyCapImpressionType | Description |\n| --- | --- |\n| `LinearTVImpression` | Indicates include LinearTV impressions for CompleteTV Order Incremental Reach goal KPI. |","enum":["LinearTVImpression"],"type":"string"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Frequency":{"properties":{"eventCount":{"description":"The number of events in a given frequency cap.","format":"int32","maximum":500,"minimum":1,"type":"integer"},"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"},"eventType":{"$ref":"#/components/schemas/EventType"},"extraFrequencyCapImpressionTypes":{"description":"Add the additional types of impression to frequency cap. Default to empty list when not selected","items":{"$ref":"#/components/schemas/ExtraFrequencyCapImpressionType"},"maxItems":10,"minItems":0,"type":"array"},"frequencyTargetingSetting":{"$ref":"#/components/schemas/FrequencyTargetingSetting"},"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/TimeUnit"}},"required":["eventMaxCount","frequencyTargetingSetting"],"type":"object"},"FrequencyTargetingSetting":{"description":"**FrequencyTargetingSetting Enum:**\n| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"],"type":"string"},"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"},"InventoryType":{"description":"**InventoryType Enum:**\n| InventoryType | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `DISPLAY` |  |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |","enum":["AUDIO","DISPLAY","ONLINE_VIDEO","STANDARD_DISPLAY","STREAMING_TV","VIDEO"],"type":"string"},"LanguageIso":{"description":"ISO-639-1 two-letter language codes.\n**LanguageIso Enum:**\n| LanguageIso | Description |\n| --- | --- |\n| `aa` | Afar. |\n| `ab` | Abkhazian. |\n| `ae` | Avestan. |\n| `af` | Afrikaans. |\n| `ak` | Akan. |\n| `am` | Amharic. |\n| `an` | Aragonese. |\n| `ar` | Arabic. |\n| `as` | Assamese. |\n| `av` | Avaric. |\n| `ay` | Aymara. |\n| `az` | Azerbaijani. |\n| `ba` | Bashkir. |\n| `be` | Belarusian. |\n| `bg` | Bulgarian. |\n| `bh` | Bihari. |\n| `bi` | Bislama. |\n| `bm` | Bambara. |\n| `bn` | Bengali. |\n| `bo` | Tibetan. |\n| `br` | Breton. |\n| `bs` | Bosnian. |\n| `ca` | Catalan. |\n| `ce` | Chechen. |\n| `ch` | Chamorro. |\n| `co` | Corsican. |\n| `cr` | Cree. |\n| `cs` | Czech. |\n| `cu` | Church Slavonic. |\n| `cv` | Chuvash. |\n| `cy` | Welsh. |\n| `da` | Danish. |\n| `de` | German. |\n| `dv` | Divehi. |\n| `dz` | Dzongkha. |\n| `ee` | Ewe. |\n| `el` | Greek. |\n| `en` | English. |\n| `eo` | Esperanto. |\n| `es` | Spanish. |\n| `et` | Estonian. |\n| `eu` | Basque. |\n| `fa` | Persian. |\n| `ff` | Fulah. |\n| `fi` | Finnish. |\n| `fj` | Fijian. |\n| `fo` | Faroese. |\n| `fr` | French. |\n| `fy` | Western Frisian. |\n| `ga` | Irish. |\n| `gd` | Scottish Gaelic. |\n| `gl` | Galician. |\n| `gn` | Guarani. |\n| `gu` | Gujarati. |\n| `gv` | Manx. |\n| `ha` | Hausa. |\n| `he` | Hebrew. |\n| `hi` | Hindi. |\n| `ho` | Hiri Motu. |\n| `hr` | Croatian. |\n| `ht` | Haitian Creole. |\n| `hu` | Hungarian. |\n| `hy` | Armenian. |\n| `hz` | Herero. |\n| `ia` | Interlingua. |\n| `id` | Indonesian. |\n| `ie` | Interlingue. |\n| `ig` | Igbo. |\n| `ii` | Sichuan Yi. |\n| `ik` | Inupiaq. |\n| `io` | Ido. |\n| `is` | Icelandic. |\n| `it` | Italian. |\n| `iu` | Inuktitut. |\n| `ja` | Japanese. |\n| `jv` | Javanese. |\n| `ka` | Georgian. |\n| `kg` | Kongo. |\n| `ki` | Kikuyu. |\n| `kj` | Kwanyama. |\n| `kk` | Kazakh. |\n| `kl` | Kalaallisut. |\n| `km` | Khmer. |\n| `kn` | Kannada. |\n| `ko` | Korean. |\n| `kr` | Kanuri. |\n| `ks` | Kashmiri. |\n| `ku` | Kurdish. |\n| `kv` | Komi. |\n| `kw` | Cornish. |\n| `ky` | Kyrgyz. |\n| `la` | Latin. |\n| `lb` | Luxembourgish. |\n| `lg` | Ganda. |\n| `li` | Limburgish. |\n| `ln` | Lingala. |\n| `lo` | Lao. |\n| `lt` | Lithuanian. |\n| `lu` | Luba-Katanga. |\n| `lv` | Latvian. |\n| `mg` | Malagasy. |\n| `mh` | Marshallese. |\n| `mi` | Māori. |\n| `mk` | Macedonian. |\n| `ml` | Malayalam. |\n| `mn` | Mongolian. |\n| `mr` | Marathi. |\n| `ms` | Malay. |\n| `mt` | Maltese. |\n| `my` | Burmese. |\n| `na` | Nauru. |\n| `nb` | Norwegian Bokmål. |\n| `nd` | North Ndebele. |\n| `ne` | Nepali. |\n| `ng` | Ndonga. |\n| `nl` | Dutch. |\n| `nn` | Norwegian Nynorsk. |\n| `no` | Norwegian. |\n| `nr` | South Ndebele. |\n| `nv` | Navajo. |\n| `ny` | Chichewa. |\n| `oc` | Occitan. |\n| `oj` | Ojibwa. |\n| `om` | Oromo. |\n| `or` | Oriya. |\n| `os` | Ossetian. |\n| `pa` | Punjabi. |\n| `pi` | Pali. |\n| `pl` | Polish. |\n| `ps` | Pashto. |\n| `pt` | Portuguese. |\n| `qu` | Quechua. |\n| `rm` | Romansh. |\n| `rn` | Kirundi. |\n| `ro` | Romanian. |\n| `ru` | Russian. |\n| `rw` | Kinyarwanda. |\n| `sa` | Sanskrit. |\n| `sc` | Sardinian. |\n| `sd` | Sindhi. |\n| `se` | Northern Sami. |\n| `sg` | Sango. |\n| `si` | Sinhala. |\n| `sk` | Slovak. |\n| `sl` | Slovenian. |\n| `sm` | Samoan. |\n| `sn` | Shona. |\n| `so` | Somali. |\n| `sq` | Albanian. |\n| `sr` | Serbian. |\n| `ss` | Swati. |\n| `st` | Southern Sotho. |\n| `su` | Sundanese. |\n| `sv` | Swedish. |\n| `sw` | Swahili. |\n| `ta` | Tamil. |\n| `te` | Telugu. |\n| `tg` | Tajik. |\n| `th` | Thai. |\n| `ti` | Tigrinya. |\n| `tk` | Turkmen. |\n| `tl` | Tagalog. |\n| `tn` | Tswana. |\n| `to` | Tonga. |\n| `tr` | Turkish. |\n| `ts` | Tsonga. |\n| `tt` | Tatar. |\n| `tw` | Twi. |\n| `ty` | Tahitian. |\n| `ug` | Uyghur. |\n| `uk` | Ukrainian. |\n| `ur` | Urdu. |\n| `uz` | Uzbek. |\n| `ve` | Venda. |\n| `vi` | Vietnamese. |\n| `vo` | Volapük. |\n| `wa` | Walloon. |\n| `wo` | Wolof. |\n| `xh` | Xhosa. |\n| `yi` | Yiddish. |\n| `yo` | Yoruba. |\n| `za` | Zhuang. |\n| `zh` | Chinese. |\n| `zu` | Zulu. |","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"MonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"QuerySupplierAdProductRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SupplierAdProductAdProductFilter"},"countryFilter":{"$ref":"#/components/schemas/SupplierAdProductCountryCodeFilter"},"dealTypeFilter":{"$ref":"#/components/schemas/SupplierAdProductAdvertisingDealTypeFilter"},"inventoryTypeFilter":{"$ref":"#/components/schemas/SupplierAdProductInventoryTypeFilter"},"maxDateTimeFilter":{"$ref":"#/components/schemas/SupplierAdProductMaxDateTimeFilter"},"maxResults":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"minDateTimeFilter":{"$ref":"#/components/schemas/SupplierAdProductMinDateTimeFilter"},"nameFilter":{"$ref":"#/components/schemas/SupplierAdProductSupplierNameFilter"},"nextToken":{"type":"string"},"sort":{"items":{"$ref":"#/components/schemas/SupplierAdProductSortOption"},"maxItems":2,"minItems":0,"type":"array"},"supplierAdProductIdFilter":{"$ref":"#/components/schemas/SupplierAdProductSupplierAdProductIdFilter"},"supplierProposalDestinationIdFilter":{"$ref":"#/components/schemas/SupplierAdProductSupplierProposalDestinationIdFilter"},"supplierPublisherIdFilter":{"$ref":"#/components/schemas/SupplierAdProductSupplierPublisherIdFilter"}},"required":["adProductFilter"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Size":{"properties":{"height":{"description":"The height of the creative placement.","format":"int32","type":"integer"},"width":{"description":"The width of the creative placement.","format":"int32","type":"integer"}},"required":["height","width"],"type":"object"},"SortDirection":{"description":"**SortDirection Enum:**\n| SortDirection | Description |\n| --- | --- |\n| `ASCENDING` | Sort in ascending order |\n| `DESCENDING` | Sort in descending order |","enum":["ASCENDING","DESCENDING"],"type":"string"},"SupplierAdProduct":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"constraints":{"$ref":"#/components/schemas/SupplierAdProductConstraints"},"countryConfigurations":{"description":"Supported countries for this supplier ad product.","items":{"$ref":"#/components/schemas/CountryConfiguration"},"maxItems":49,"minItems":0,"type":"array"},"creativeRequirements":{"description":"Creative requirements for this supplier ad product.","items":{"$ref":"#/components/schemas/SupplierProposedDealCreativeRequirement"},"maxItems":49,"minItems":0,"type":"array"},"customPublisherDescription":{"description":"The unstructured name of this product, similar to customPublisherDescription in AdvertisingDeal.","items":{"type":"string"},"maxItems":49,"minItems":0,"type":"array"},"dealType":{"$ref":"#/components/schemas/AdvertisingDealType"},"name":{"description":"The name of the supplier ad product.","pattern":"^[ -:\u003c-z|]+$","type":"string"},"priceType":{"$ref":"#/components/schemas/AdvertisingDealPriceType"},"supplierAdProductExtension":{"$ref":"#/components/schemas/SupplierAdProductExtension"},"supplierAdProductId":{"description":"The supplier ad product unique identifier.","type":"string"},"supplierAdProductType":{"$ref":"#/components/schemas/SupplierAdProductType"},"supplierProposalDestinationId":{"description":"The supplier proposal destination for this supplier ad product.","type":"string"},"supplierPublisherId":{"description":"The publisher ids associated with this supplier ad product.","items":{"type":"string"},"maxItems":49,"minItems":0,"type":"array"}},"required":["dealType","name","supplierAdProductId"],"type":"object"},"SupplierAdProductAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductAdvertisingDealTypeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/AdvertisingDealType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductBookingConstraints":{"description":"Booking constraints are the dates in which an advertiser can create a proposed deal. If an advertiser attempts to create a proposed deal outside of the booking constraint dates, an error will be returned by the supplier.","properties":{"range":{"$ref":"#/components/schemas/SupplierBookingRangeConstraint"}},"type":"object"},"SupplierAdProductBudgetConstraints":{"properties":{"maximumBudget":{"$ref":"#/components/schemas/MonetaryBudget"},"minimumBudget":{"$ref":"#/components/schemas/MonetaryBudget"},"privateAuctionBaseCpm":{"$ref":"#/components/schemas/MonetaryBudget"},"programGuaranteedBaseCpm":{"$ref":"#/components/schemas/MonetaryBudget"}},"type":"object"},"SupplierAdProductConstraints":{"properties":{"bookingConstraints":{"$ref":"#/components/schemas/SupplierAdProductBookingConstraints"},"budgetConstraints":{"$ref":"#/components/schemas/SupplierAdProductBudgetConstraints"},"flightConstraints":{"$ref":"#/components/schemas/SupplierAdProductFlightConstraints"},"frequencyConstraints":{"$ref":"#/components/schemas/SupplierAdProductFrequencyConstraints"},"goalConstraints":{"$ref":"#/components/schemas/SupplierAdProductGoalConstraints"},"shareOfVoiceConstraints":{"$ref":"#/components/schemas/SupplierAdProductShareOfVoiceConstraints"},"targetingConstraints":{"$ref":"#/components/schemas/SupplierAdProductTargetingConstraints"}},"type":"object"},"SupplierAdProductCountryCodeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductExtension":{"oneOf":[{"properties":{"amazonMediaSupplierAdProductExtension":{"$ref":"#/components/schemas/AmazonMediaSupplierAdProductExtension"}},"required":["amazonMediaSupplierAdProductExtension"],"title":"amazonMediaSupplierAdProductExtension","type":"object"}]},"SupplierAdProductFlightConstraints":{"description":"Flight constraints limit the startDateTime and endDateTime on a proposed deal.","properties":{"fixed":{"$ref":"#/components/schemas/SupplierFlightFixedConstraint"},"range":{"$ref":"#/components/schemas/SupplierFlightRangeConstraint"}},"type":"object"},"SupplierAdProductFrequencyConstraints":{"properties":{"fixed":{"$ref":"#/components/schemas/SupplierFrequencyFixedConstraint"},"range":{"$ref":"#/components/schemas/SupplierFrequencyRangeConstraint"},"supportsFrequencyIntent":{"description":"Indicates whether publisher product supports frequency intents.","type":"boolean"}},"type":"object"},"SupplierAdProductGoalConstraints":{"properties":{"goalConstraintsExtension":{"$ref":"#/components/schemas/SupplierAdProductGoalConstraintsExtension"}},"required":["goalConstraintsExtension"],"type":"object"},"SupplierAdProductGoalConstraintsExtension":{"oneOf":[{"properties":{"amazonPublisherCloudGoalConstraints":{"$ref":"#/components/schemas/AmazonPublisherCloudGoalConstraints"}},"required":["amazonPublisherCloudGoalConstraints"],"title":"amazonPublisherCloudGoalConstraints","type":"object"},{"properties":{"amazonPublisherDirectGoalConstraints":{"$ref":"#/components/schemas/AmazonPublisherDirectGoalConstraints"}},"required":["amazonPublisherDirectGoalConstraints"],"title":"amazonPublisherDirectGoalConstraints","type":"object"}]},"SupplierAdProductInventoryTypeFilter":{"properties":{"include":{"description":"**InventoryType Enum:**\n| InventoryType | Description |\n| --- | --- |\n| `STANDARD_DISPLAY` |  |\n| `DISPLAY` |  |\n| `VIDEO` |  |\n| `STREAMING_TV` |  |\n| `ONLINE_VIDEO` |  |\n| `AUDIO` | Audio ads that serve on streaming audio inventory. |","items":{"$ref":"#/components/schemas/InventoryType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductMaxDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductMinDateTimeFilter":{"properties":{"include":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductShareOfVoiceConstraints":{"properties":{"fixed":{"$ref":"#/components/schemas/SupplierShareOfVoiceFixedConstraint"},"range":{"$ref":"#/components/schemas/SupplierShareOfVoiceRangeConstraint"}},"type":"object"},"SupplierAdProductSortOption":{"properties":{"by":{"$ref":"#/components/schemas/SupplierAdProductSortOptionsFields"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["by"],"type":"object"},"SupplierAdProductSortOptionsFields":{"description":"Specify which field to order by.\n| Field Name | Supported Ordering |\n| --- | --- |\n| name | ASCENDING,DESCENDING |\n| supplierAdProductId | ASCENDING,DESCENDING |","enum":["name","supplierAdProductId"],"type":"string"},"SupplierAdProductSuccessResponse":{"properties":{"nextToken":{"type":"string"},"supplierAdProducts":{"items":{"$ref":"#/components/schemas/SupplierAdProduct"},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"format":"int32","type":"integer"}},"type":"object"},"SupplierAdProductSupplierAdProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductSupplierNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductSupplierProposalDestinationIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductSupplierPublisherIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SupplierAdProductTargetingConstraints":{"description":"Targeting constraint values are limits on what may be targeted, such as minimum or maximum number of targeting that is available for a SupplierAdProduct.","properties":{"fixed":{"description":"Fixed targeting are target values that must be applied by the buyer for a proposed deal. If the targeting is not applied, then the deal may be rejected by the supplier.","items":{"$ref":"#/components/schemas/SupplierTargetGroup"},"maxItems":49,"minItems":0,"type":"array"},"supplierTargetGroups":{"description":"The supplier target groups that can be targeted and their constrained values.","items":{"$ref":"#/components/schemas/SupplierTargetGroupConstraint"},"maxItems":49,"minItems":0,"type":"array"}},"type":"object"},"SupplierAdProductType":{"enum":["AMAZON_MEDIA","AMAZON_PUBLISHER_CLOUD","AMAZON_PUBLISHER_DIRECT"],"type":"string"},"SupplierAppTarget":{"description":"Target based on a specified app ID.","properties":{"groupId":{"description":"The string identifying a group of apps. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add apps to a new group, choose any string not currently being used on this ad group. To add apps to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The app to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceAgeTarget":{"description":"Target based on a specified audience age ID.","properties":{"groupId":{"description":"The string identifying a group of audience ages. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience ages to a new group, choose any string not currently being used on this ad group. To add audience ages to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience age to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceEducationTarget":{"description":"Target based on a specified audience education ID.","properties":{"groupId":{"description":"The string identifying a group of audience educations. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience educations to a new group, choose any string not currently being used on this ad group. To add audience educations to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience education to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceGenderTarget":{"description":"Target based on a specified audience gender ID.","properties":{"groupId":{"description":"The string identifying a group of audience genders. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience genders to a new group, choose any string not currently being used on this ad group. To add audience genders to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience gender to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHomeownershipTarget":{"description":"Target based on a specified audience homeownership ID.","properties":{"groupId":{"description":"The string identifying a group of audience homeownerships. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience homeownerships to a new group, choose any string not currently being used on this ad group. To add audience homeownerships to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience homeownership to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHouseholdCompositionTarget":{"description":"Target based on a specified audience household composition ID.","properties":{"groupId":{"description":"The string identifying a group of audience household compositions. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience household compositions to a new group, choose any string not currently being used on this ad group. To add audience household compositions to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience household composition to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceHouseholdIncomeTarget":{"description":"Target based on a specified audience household income ID.","properties":{"groupId":{"description":"The string identifying a group of audience household incomes. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience household incomes to a new group, choose any string not currently being used on this ad group. To add audience household incomes to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience household income to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceInMarketTarget":{"description":"Target based on a specified audience in-market ID.","properties":{"groupId":{"description":"The string identifying a group of audience in-market segments. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience in-market segments to a new group, choose any string not currently being used on this ad group. To add audience in-market segments to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience in-market segment to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceInterestsTarget":{"description":"Target based on a specified audience interest ID.","properties":{"groupId":{"description":"The string identifying a group of audience interests. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience interests to a new group, choose any string not currently being used on this ad group. To add audience interests to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience interest to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceMaritalStatusTarget":{"description":"Target based on a specified audience marital status ID.","properties":{"groupId":{"description":"The string identifying a group of audience marital statuses. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience marital statuses to a new group, choose any string not currently being used on this ad group. To add audience marital statuses to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience marital status to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceMoodTarget":{"description":"Target based on a specified audience mood ID.","properties":{"groupId":{"description":"The string identifying a group of audience moods. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience moods to a new group, choose any string not currently being used on this ad group. To add audience moods to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience mood to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceSocioeconomicGroupTarget":{"description":"Target based on a specified audience socioeconomic group ID.","properties":{"groupId":{"description":"The string identifying a group of audience socioeconomic groups. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audience socioeconomic groups to a new group, choose any string not currently being used on this ad group. To add audience socioeconomic groups to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience socioeconomic group to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The audience to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierBookingRangeConstraint":{"properties":{"maxDateTime":{"description":"Latest date that this product can be booked as a deal.","format":"date-time","type":"string"},"minDateTime":{"description":"Earliest date that this product can be booked as a deal.","format":"date-time","type":"string"}},"required":["minDateTime"],"type":"object"},"SupplierContentCategoryTarget":{"description":"Target based on a specified content category ID.","properties":{"groupId":{"description":"The string identifying a group of content categories. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content categories to a new group, choose any string not currently being used on this ad group. To add content categories to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content category to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentGenreTarget":{"description":"Target based on a specified content genre ID.","properties":{"groupId":{"description":"The string identifying a group of content genres. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content genres to a new group, choose any string not currently being used on this ad group. To add content genres to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content genre to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentRatingTarget":{"description":"Target based on a specified content rating ID.","properties":{"groupId":{"description":"The string identifying a group of content ratings. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content ratings to a new group, choose any string not currently being used on this ad group. To add content ratings to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content rating to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierContentSensitiveCategoryTarget":{"description":"Target based on a specified content sensitive category ID.","properties":{"groupId":{"description":"The string identifying a group of content sensitive categories. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add content sensitive categories to a new group, choose any string not currently being used on this ad group. To add content sensitive categories to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The content sensitive category to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDayPartDayTarget":{"description":"Target based on a specified daypart day ID.","properties":{"groupId":{"description":"The string identifying a group of daypart days. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add daypart days to a new group, choose any string not currently being used on this ad group. To add daypart days to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The daypart day to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDayPartTarget":{"description":"Supplier target based on time of day.","properties":{"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeek"},"timeOfDay":{"$ref":"#/components/schemas/TimeOfDay"},"timeZoneType":{"$ref":"#/components/schemas/SupplierTargetingDaypartTimezoneType"}},"required":["dayOfWeek","timeOfDay"],"type":"object"},"SupplierDayPartTimeTarget":{"description":"Target based on a specified daypart time ID.","properties":{"groupId":{"description":"The string identifying a group of daypart times. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add daypart times to a new group, choose any string not currently being used on this ad group. To add daypart times to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The daypart time to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDeviceOperatingSystemTarget":{"description":"Target based on a specified device operating system ID.","properties":{"groupId":{"description":"The string identifying a group of device operating systems. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add device operating systems to a new group, choose any string not currently being used on this ad group. To add device operating systems to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The device operating system to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierDeviceTypeTarget":{"description":"Target based on a specified device type ID.","properties":{"groupId":{"description":"The string identifying a group of device types. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add device types to a new group, choose any string not currently being used on this ad group. To add device types to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The device type to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierFlightFixedConstraint":{"properties":{"endDateTime":{"description":"Fixed end date for deals.","format":"date-time","type":"string"},"startDateTime":{"description":"Fixed start date for deals.","format":"date-time","type":"string"}},"required":["endDateTime","startDateTime"],"type":"object"},"SupplierFlightRangeConstraint":{"properties":{"maxDateTime":{"description":"Latest date that deals can execute.","format":"date-time","type":"string"},"maxHours":{"description":"Maximum number of hours a deal can run.","format":"int32","type":"integer"},"minDateTime":{"description":"Earliest date that deals can execute.","format":"date-time","type":"string"},"minHours":{"description":"Minimum number of hours a deal must run.","format":"int32","type":"integer"}},"required":["minDateTime"],"type":"object"},"SupplierFrequencyFixedConstraint":{"properties":{"frequencyIntents":{"description":"List of frequency intents applied to all deals.","items":{"$ref":"#/components/schemas/Frequency"},"maxItems":49,"minItems":0,"type":"array"}},"type":"object"},"SupplierFrequencyRangeConstraint":{"properties":{"maxCount":{"description":"Maximum number of frequency intents allowed.","format":"int32","type":"integer"},"minCount":{"description":"Minimum number of frequency intents allowed.","format":"int32","type":"integer"}},"type":"object"},"SupplierGroupDetails":{"oneOf":[{"properties":{"supplierLocationGroup":{"$ref":"#/components/schemas/SupplierLocationGroup"}},"required":["supplierLocationGroup"],"title":"supplierLocationGroup","type":"object"}]},"SupplierGroupType":{"enum":["LOCATION"],"type":"string"},"SupplierLocationGroup":{"description":"Location group details for supplier.","properties":{"onlyUseRealTimeLocation":{"description":"Only use real-time location for this group. Targeting customers based on home location may deliver when they travel and their real-time location is outside the targeted locations. This can lead to discrepancies with internal or external reports that validate location based on the real-time location. This setting may not be available to select if the selected supplier ad product requires using a specific value.","type":"boolean"}},"type":"object"},"SupplierLocationTarget":{"description":"Location target for supplier. Multiple locations can be used.","properties":{"supplierTargetItemId":{"description":"The geo location values to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierPositionVideoTarget":{"description":"Target based on a specified video position ID.","properties":{"groupId":{"description":"The string identifying a group of video positions. Only numbers formatted as strings are accepted (e.g. \u00271\u0027). To add video positions to a new group, choose any string not currently being used on this ad group. To add video positions to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group. Targets may share groupIds with other targets. Please refer to a supplier\u0027s SupplierTargetDefinition to review what targets may share groups.","type":"string"},"supplierTargetItemId":{"description":"The video position to target.","type":"string"}},"required":["supplierTargetItemId"],"type":"object"},"SupplierProposedDealCreativeRequirement":{"description":"Creative requirement with inventory type.","properties":{"creativeRequirement":{"$ref":"#/components/schemas/SupplierProposedDealCreativeRequirements"},"inventoryType":{"$ref":"#/components/schemas/InventoryType"},"languages":{"description":"Languages available for this creative requirement.","items":{"$ref":"#/components/schemas/LanguageIso"},"maxItems":100,"minItems":0,"type":"array"}},"required":["creativeRequirement","inventoryType"],"type":"object"},"SupplierProposedDealCreativeRequirements":{"oneOf":[{"properties":{"audioCreativeRequirements":{"$ref":"#/components/schemas/AudioCreativeRequirements"}},"required":["audioCreativeRequirements"],"title":"audioCreativeRequirements","type":"object"},{"properties":{"videoCreativeRequirements":{"$ref":"#/components/schemas/VideoCreativeRequirements"}},"required":["videoCreativeRequirements"],"title":"videoCreativeRequirements","type":"object"},{"properties":{"displayCreativeRequirements":{"$ref":"#/components/schemas/DisplayCreativeRequirements"}},"required":["displayCreativeRequirements"],"title":"displayCreativeRequirements","type":"object"}]},"SupplierShareOfVoiceFixedConstraint":{"properties":{"percent":{"description":"Fixed percentage of inventory elements.","format":"double","type":"number"}},"required":["percent"],"type":"object"},"SupplierShareOfVoiceRangeConstraint":{"properties":{"maxPercent":{"description":"Maximum percentage of inventory elements.","format":"double","type":"number"},"minPercent":{"description":"Minimum percentage of inventory elements.","format":"double","type":"number"},"percentIncrement":{"description":"Percentage increments for deals.","format":"double","type":"number"}},"type":"object"},"SupplierTarget":{"description":"Marketplace targeting configuration.","properties":{"negative":{"description":"Indicates whether the target is negative or not. Negative targeting allows advertisers to provide intent where they do not want to show ads. Please ensure that the supplier for this target supports negative targeting before setting to true. If this field is not present, then negative is assumed to be false (meaning that a target is inclusive by default).","type":"boolean"},"supplierTargetDetails":{"$ref":"#/components/schemas/SupplierTargetDetails"},"supplierTargetType":{"$ref":"#/components/schemas/SupplierTargetType"}},"required":["supplierTargetDetails","supplierTargetType"],"type":"object"},"SupplierTargetConstraint":{"description":"Supplier targeting constraint configuration for a particular SupplierTargetType on a SupplierAdProduct. The supplier target contraints within targetingConstraints define what SupplierTargets may be used for a SupplierProposedDeal using this SupplierAdProduct. If a SupplierTargetConstraint is present in targetingConstraints for a SupplierAdProduct, that indicates that the SupplierTargetType, such as AUDIENCE, is supported for this SupplierAdProduct.","properties":{"negative":{"$ref":"#/components/schemas/SupplierTargetValueConstraint"},"positive":{"$ref":"#/components/schemas/SupplierTargetValueConstraint"},"supplierTargetType":{"$ref":"#/components/schemas/SupplierTargetType"}},"required":["positive","supplierTargetType"],"type":"object"},"SupplierTargetConstraintLocationDetails":{"properties":{"allowsRealTimeLocationOnly":{"description":"Allows use of onlyUseRealTimeLocation in location targets for this supplier ad product. When enabled, targets customers based only on their real-time location rather than home location. Targeting based on home location may deliver when customers travel and their real-time location is outside the targeted locations, which can lead to discrepancies with reports that validate location based on real-time location.","type":"boolean"}},"required":["allowsRealTimeLocationOnly"],"type":"object"},"SupplierTargetDetails":{"oneOf":[{"properties":{"supplierAudienceTarget":{"$ref":"#/components/schemas/SupplierAudienceTarget"}},"required":["supplierAudienceTarget"],"title":"supplierAudienceTarget","type":"object"},{"properties":{"supplierAudienceAgeTarget":{"$ref":"#/components/schemas/SupplierAudienceAgeTarget"}},"required":["supplierAudienceAgeTarget"],"title":"supplierAudienceAgeTarget","type":"object"},{"properties":{"supplierAudienceGenderTarget":{"$ref":"#/components/schemas/SupplierAudienceGenderTarget"}},"required":["supplierAudienceGenderTarget"],"title":"supplierAudienceGenderTarget","type":"object"},{"properties":{"supplierAudienceInterestsTarget":{"$ref":"#/components/schemas/SupplierAudienceInterestsTarget"}},"required":["supplierAudienceInterestsTarget"],"title":"supplierAudienceInterestsTarget","type":"object"},{"properties":{"supplierAudienceMoodTarget":{"$ref":"#/components/schemas/SupplierAudienceMoodTarget"}},"required":["supplierAudienceMoodTarget"],"title":"supplierAudienceMoodTarget","type":"object"},{"properties":{"supplierAudienceInMarketTarget":{"$ref":"#/components/schemas/SupplierAudienceInMarketTarget"}},"required":["supplierAudienceInMarketTarget"],"title":"supplierAudienceInMarketTarget","type":"object"},{"properties":{"supplierAudienceHouseholdIncomeTarget":{"$ref":"#/components/schemas/SupplierAudienceHouseholdIncomeTarget"}},"required":["supplierAudienceHouseholdIncomeTarget"],"title":"supplierAudienceHouseholdIncomeTarget","type":"object"},{"properties":{"supplierAudienceEducationTarget":{"$ref":"#/components/schemas/SupplierAudienceEducationTarget"}},"required":["supplierAudienceEducationTarget"],"title":"supplierAudienceEducationTarget","type":"object"},{"properties":{"supplierAudienceHomeownershipTarget":{"$ref":"#/components/schemas/SupplierAudienceHomeownershipTarget"}},"required":["supplierAudienceHomeownershipTarget"],"title":"supplierAudienceHomeownershipTarget","type":"object"},{"properties":{"supplierAudienceHouseholdCompositionTarget":{"$ref":"#/components/schemas/SupplierAudienceHouseholdCompositionTarget"}},"required":["supplierAudienceHouseholdCompositionTarget"],"title":"supplierAudienceHouseholdCompositionTarget","type":"object"},{"properties":{"supplierAudienceMaritalStatusTarget":{"$ref":"#/components/schemas/SupplierAudienceMaritalStatusTarget"}},"required":["supplierAudienceMaritalStatusTarget"],"title":"supplierAudienceMaritalStatusTarget","type":"object"},{"properties":{"supplierAudienceSocioeconomicGroupTarget":{"$ref":"#/components/schemas/SupplierAudienceSocioeconomicGroupTarget"}},"required":["supplierAudienceSocioeconomicGroupTarget"],"title":"supplierAudienceSocioeconomicGroupTarget","type":"object"},{"properties":{"supplierLocationTarget":{"$ref":"#/components/schemas/SupplierLocationTarget"}},"required":["supplierLocationTarget"],"title":"supplierLocationTarget","type":"object"},{"properties":{"supplierDayPartTarget":{"$ref":"#/components/schemas/SupplierDayPartTarget"}},"required":["supplierDayPartTarget"],"title":"supplierDayPartTarget","type":"object"},{"properties":{"supplierDayPartDayTarget":{"$ref":"#/components/schemas/SupplierDayPartDayTarget"}},"required":["supplierDayPartDayTarget"],"title":"supplierDayPartDayTarget","type":"object"},{"properties":{"supplierDayPartTimeTarget":{"$ref":"#/components/schemas/SupplierDayPartTimeTarget"}},"required":["supplierDayPartTimeTarget"],"title":"supplierDayPartTimeTarget","type":"object"},{"properties":{"supplierContentCategoryTarget":{"$ref":"#/components/schemas/SupplierContentCategoryTarget"}},"required":["supplierContentCategoryTarget"],"title":"supplierContentCategoryTarget","type":"object"},{"properties":{"supplierContentGenreTarget":{"$ref":"#/components/schemas/SupplierContentGenreTarget"}},"required":["supplierContentGenreTarget"],"title":"supplierContentGenreTarget","type":"object"},{"properties":{"supplierContentRatingTarget":{"$ref":"#/components/schemas/SupplierContentRatingTarget"}},"required":["supplierContentRatingTarget"],"title":"supplierContentRatingTarget","type":"object"},{"properties":{"supplierContentSensitiveCategoryTarget":{"$ref":"#/components/schemas/SupplierContentSensitiveCategoryTarget"}},"required":["supplierContentSensitiveCategoryTarget"],"title":"supplierContentSensitiveCategoryTarget","type":"object"},{"properties":{"supplierDeviceTypeTarget":{"$ref":"#/components/schemas/SupplierDeviceTypeTarget"}},"required":["supplierDeviceTypeTarget"],"title":"supplierDeviceTypeTarget","type":"object"},{"properties":{"supplierDeviceOperatingSystemTarget":{"$ref":"#/components/schemas/SupplierDeviceOperatingSystemTarget"}},"required":["supplierDeviceOperatingSystemTarget"],"title":"supplierDeviceOperatingSystemTarget","type":"object"},{"properties":{"supplierPositionVideoTarget":{"$ref":"#/components/schemas/SupplierPositionVideoTarget"}},"required":["supplierPositionVideoTarget"],"title":"supplierPositionVideoTarget","type":"object"},{"properties":{"supplierAppTarget":{"$ref":"#/components/schemas/SupplierAppTarget"}},"required":["supplierAppTarget"],"title":"supplierAppTarget","type":"object"}]},"SupplierTargetGroup":{"properties":{"groupDetails":{"$ref":"#/components/schemas/SupplierGroupDetails"},"groupName":{"type":"string"},"groupTargets":{"items":{"$ref":"#/components/schemas/SupplierTarget"},"maxItems":49,"minItems":1,"type":"array"},"groupType":{"$ref":"#/components/schemas/SupplierGroupType"}},"required":["groupName","groupTargets"],"type":"object"},"SupplierTargetGroupConstraint":{"description":"A SupplierTargetGroupConstraint provides a group of SupplierTargetConstraint elements where the collection share a common theme such as location, contextual targeting, etc. If a set of SupplierTargetConstraint are contained in a group, then when a proposed deal is created, the supplier target types of those within the group may share a groupId to create a set. Please refer to the documentation of groupId within a SupplierTarget for more information.","properties":{"groupConstraints":{"items":{"$ref":"#/components/schemas/SupplierTargetConstraint"},"maxItems":49,"minItems":1,"type":"array"},"groupName":{"type":"string"},"supplierTargetGroupConstraintDetails":{"$ref":"#/components/schemas/SupplierTargetGroupConstraintDetails"},"supplierTargetGroupConstraintType":{"$ref":"#/components/schemas/SupplierTargetGroupConstraintType"}},"required":["groupConstraints","groupName"],"type":"object"},"SupplierTargetGroupConstraintDetails":{"oneOf":[{"properties":{"supplierTargetConstraintLocationDetails":{"$ref":"#/components/schemas/SupplierTargetConstraintLocationDetails"}},"required":["supplierTargetConstraintLocationDetails"],"title":"supplierTargetConstraintLocationDetails","type":"object"}]},"SupplierTargetGroupConstraintType":{"enum":["LOCATION"],"type":"string"},"SupplierTargetType":{"enum":["APP","AUDIENCE","AUDIENCE_AGE","AUDIENCE_EDUCATION","AUDIENCE_GENDER","AUDIENCE_HOMEOWNERSHIP","AUDIENCE_HOUSEHOLD_COMPOSITION","AUDIENCE_HOUSEHOLD_INCOME","AUDIENCE_INTERESTS","AUDIENCE_IN_MARKET","AUDIENCE_MARITAL_STATUS","AUDIENCE_MOOD","AUDIENCE_SOCIOECONOMIC_GROUP","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_RATING","CONTENT_SENSITIVE_CATEGORY","DAYPART","DAYPART_DAY","DAYPART_TIME","DEVICE_OPERATING_SYSTEM","DEVICE_TYPE","LOCATION_CITY","LOCATION_COUNTRY","LOCATION_DESIGNATED_MARKET_AREA","LOCATION_METRO","LOCATION_POSTAL_CODE","LOCATION_REGION","POSITION_VIDEO"],"type":"string"},"SupplierTargetValueConstraint":{"properties":{"maxValues":{"description":"Maximum number of supplier targets of a supplier target type for a proposed deal. If this value is not present, then the max is limited by the schema of SupplierProposedDeal.","format":"int32","type":"integer"},"minValues":{"description":"Minimum number of supplier targets of a supplier target type for a proposed deal. If this value is not present, then there is no minimum.","format":"int32","type":"integer"}},"type":"object"},"SupplierTargetingDaypartTimezoneType":{"description":"**SupplierTargetingDaypartTimezoneType Enum:**\n| SupplierTargetingDaypartTimezoneType | Description |\n| --- | --- |\n| `DEAL` | Set the daypart targeting to the timezone of the deal by the supplier |\n| `VIEWER` | Set the daypart targeting to the timezone of the viewer of the advertisement. |","enum":["DEAL","VIEWER"],"type":"string"},"TimeOfDay":{"properties":{"endTime":{"description":"Selected end time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"},"startTime":{"description":"Selected start time","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]Z$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"TimeUnit":{"enum":["DAYS","HOURS","MINUTES"],"type":"string"},"TimeZone":{"description":"Each complies with the ISO 8601 TZ identifier standard\n**TimeZone Enum:**\n| TimeZone | Description |\n| --- | --- |\n| `AMERICA_ANCHORAGE` | America/Anchorage |\n| `AMERICA_CARACAS` | America/Caracas |\n| `AMERICA_CHICAGO` | America/Chicago |\n| `AMERICA_DENVER` | America/Denver |\n| `AMERICA_HALIFAX` | America/Halifax |\n| `AMERICA_LOS_ANGELES` | America/Los_Angeles |\n| `AMERICA_NEW_YORK` | America/New_York |\n| `AMERICA_MEXICO_CITY` | America/Mexico_City |\n| `AMERICA_SAO_PAULO` | America/Sao_Paulo |\n| `AMERICA_ST_JOHNS` | America/St_Johns |\n| `ASIA_ALMATY` | Asia/Almaty |\n| `ASIA_BAGHDAD` | Asia/Baghdad |\n| `ASIA_BANGKOK` | Asia/Bangkok |\n| `ASIA_DUBAI` | Asia/Dubai |\n| `ASIA_HONG_KONG` | Asia/Hong_Kong |\n| `ASIA_KABUL` | Asia/Kabul |\n| `ASIA_KATHMANDU` | Asia/Kathmandu |\n| `ASIA_KOLKATA` | Asia/Kolkata |\n| `ASIA_MAGADAN` | Asia/Magadan |\n| `ASIA_RIYADH` | Asia/Riyadh |\n| `ASIA_SHANGHAI` | Asia/Shanghai |\n| `ASIA_SINGAPORE` | Asia/Singapore |\n| `ASIA_TEHRAN` | Asia/Tehran |\n| `ASIA_TOKYO` | Asia/Tokyo |\n| `ASIA_YEKATERINBURG` | Asia/Yekaterinburg |\n| `ASIA_YEREVAN` | Asia/Yerevan |\n| `ATLANTIC_AZORES` | Atlantic/Azores |\n| `ATLANTIC_SOUTH_GEORGIA` | Atlantic/South_Georgia |\n| `AUSTRALIA_BRISBANE` | Australia/Brisbane |\n| `AUSTRALIA_DARWIN` | Australia/Darwin |\n| `AUSTRALIA_SYDNEY` | Australia/Sydney |\n| `EET` | EET |\n| `EUROPE_AMSTERDAM` | Europe/Amsterdam |\n| `EUROPE_ISTANBUL` | Europe/Istanbul |\n| `EUROPE_LONDON` | Europe/London |\n| `EUROPE_PARIS` | Europe/Paris |\n| `EUROPE_STOCKHOLM` | Europe/Stockholm |\n| `INDIAN_COCOS` | Indian/Cocos |\n| `PACIFIC_FIJI` | Pacific/Fiji |\n| `PACIFIC_HONOLULU` | Pacific/Honolulu |\n| `PACIFIC_KWAJALEIN` | Pacific/Kwajalein |\n| `PACIFIC_MIDWAY` | Pacific/Midway |\n| `PACIFIC_AUCKLAND` | Pacific/Auckland |\n| `UTC` | UTC |","enum":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY","UTC"],"type":"string"},"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"},"VideoCreativeRequirements":{"description":"Video creative requirements.","properties":{"durationMs":{"description":"Required duration for video creatives in milliseconds.","format":"int32","type":"integer"},"size":{"$ref":"#/components/schemas/Size"}},"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":"SupplierAdProducts API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/supplierAdProducts":{"post":{"description":"Query supplier ad products\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"QuerySupplierAdProduct","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySupplierAdProductRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierAdProductSuccessResponse"}}},"description":"QuerySupplierAdProduct 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":["SupplierAdProducts"]}}},"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"}]}