{"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"}},"ScopeHeaderOptional":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"Ad":{"properties":{"activeCreative":{"$ref":"#/components/schemas/Creative"},"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"campaignId":{"description":"The campaign associated with the ad. It\u0027s a read-only field.","type":"string"},"creationDateTime":{"description":"The date time that the ad was created.","format":"date-time","type":"string"},"creative":{"$ref":"#/components/schemas/Creative"},"globalAdId":{"description":"The global ad identifier that manages this marketplace ad.","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/MarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"retailerScope":{"$ref":"#/components/schemas/RetailerScope"},"state":{"$ref":"#/components/schemas/State"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId","adProduct","adType","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","state"],"type":"object"},"AdAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/AdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdChoicesPosition":{"enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"],"type":"string"},"AdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"adType":{"$ref":"#/components/schemas/AdType"},"creative":{"$ref":"#/components/schemas/CreateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/CreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","adType","creative","state"],"type":"object"},"AdMarketplaceScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/MarketplaceScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdMultiStatusResponseWithPartialErrors":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"partialSuccess":{"items":{"$ref":"#/components/schemas/AdPartialIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"AdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"AdNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/AdNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"AdNameFilterType":{"description":"**AdNameFilterType Enum:**\n| AdNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"AdPartialIndex":{"properties":{"ad":{"$ref":"#/components/schemas/Ad"},"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["ad","errors","index"],"type":"object"},"AdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n| `SPONSORED_BRANDS` | Sponsored Brands ad product. |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n| `SPONSORED_TELEVISION` | Sponsored Television ad product. |\n","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"],"type":"string"},"AdRetailerScopeFilter":{"properties":{"include":{"description":"**RetailerScope Enum:**\n| RetailerScope | Description |\n| --- | --- |\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |","items":{"$ref":"#/components/schemas/RetailerScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/State"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"AdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/Ad"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"AdType":{"description":"**AdType Enum:**\n\n| AdType | Description |\n|------|------|\n| `AUDIO` | A creative that features one or more audio assets. |\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n| `DISPLAY` | A creative that features one or more custom images. |\n| `PRODUCT_AD` | A creative built based on a specified product. |\n| `THIRD_PARTY` | A creative that is served from a third party ad server. |\n| `VIDEO` | A creative that features one or more videos. |\n","enum":["AUDIO","COMPONENT","DISPLAY","PRODUCT_AD","THIRD_PARTY","VIDEO"],"type":"string"},"AdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/UpdateCreative"},"marketplaceConfigurations":{"description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad\u0027s global value is applied to that marketplace.","items":{"$ref":"#/components/schemas/CreateMarketplaceAdConfigurations"},"maxItems":30,"minItems":0,"type":"array"},"marketplaceScope":{"$ref":"#/components/schemas/MarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad is applicable. For Sponsored Ads, the marketplaces included should either be same as or subset of parent ad group. For ADSP, this represents retail domains such as Amazon.com, Amazon.co.uk, and Amazon.mx, each corresponding to a country where an Amazon customer can shop. The field represents the Amazon marketplaces for the advertised product included in the creative settings.","items":{"$ref":"#/components/schemas/Marketplace"},"maxItems":30,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/UpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"AddToCartVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"}},"required":["position"],"type":"object"},"AdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"AdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/GlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/AdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"},"resolvedProductId":{"description":"The identifier of product associated with the advertised product. It\u0027s a read-only field.","type":"string"},"resolvedProductIdType":{"$ref":"#/components/schemas/ProductIdType"},"retailerId":{"description":"Identifier for retailer associated with this advertised product. This is a read-only field. Only applicable for OTHER_RETAILERS retailer scope.","type":"string"}},"required":["productIdType"],"type":"object"},"AssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"AssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"AssetBasedCreativeCallToActionType":{"enum":["BOOK_NOW","BUY_NOW","DISCOVER_MORE","DOWNLOAD_NOW","EXPLORE_NOW","GET_APP","GET_QUOTE","LEARN_MORE","PRE_ORDER_NOW","SEE_DETAILS","SHOP_NOW","SIGN_UP_NOW","SUBSCRIBE_NOW"],"type":"string"},"AssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"backgrounds":{"description":"The background which is displayed on the ad.","items":{"$ref":"#/components/schemas/Background"},"maxItems":1,"minItems":0,"type":"array"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/AssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/Video"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"hasTermsAndConditions":{"description":"Indicates that the ad promotes a free product or service and has qualifying terms and conditions applicable to the customer. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those.","type":"boolean"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"Audio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"AudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"AudioCreative":{"description":"| AudioCreative | Description |\n|------|------|\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |\n","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/StandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"AutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"Background":{"properties":{"color":{"description":"The color hex code of the background.","type":"string"}},"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"},"BrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/Image"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"BrandGalleryCreativePropertiesToOptimize":{"description":"**BrandGalleryCreativePropertiesToOptimize Enum:**\n\n| BrandGalleryCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"BrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/BrandGalleryCardCreativeElement"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","landingPage"],"type":"object"},"BrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/BrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"BrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"BrandStoreCallToActionType":{"enum":["BUY_NOW","DISCOVER_MORE","LEARN_MORE","SEE_DETAILS","SHOP_NOW"],"type":"string"},"BrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/BrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"CardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"ClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"ClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"ClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CollectionLandingPageType":{"description":"**CollectionLandingPageType Enum:**\n\n| CollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","STORE"],"type":"string"},"ComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/AssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/AutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/BrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/BrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/ManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/ProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/ProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/ResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/StoreSpotlightSettings"}},"type":"object"},"ComponentInventoryType":{"enum":["DISPLAY","NATIVE"],"type":"string"},"ComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ComponentLandingPageType":{"description":"**ComponentLandingPageType Enum:**\n\n| ComponentLandingPageType | Description |\n|------|------|\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n","enum":["OFF_AMAZON_LINK"],"type":"string"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"CreateAddToCartVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"}},"required":["position"],"type":"object"},"CreateAdvertisedProductMarketplaceSetting":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"productId":{"description":"The identifier of the product advertised.","type":"string"}},"required":["marketplace","productId"],"type":"object"},"CreateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/CreateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"required":["productIdType"],"type":"object"},"CreateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"CreateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/CreateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateComponentLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"required":["headlines"],"type":"object"},"CreateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"CreateAudioCreative":{"description":"| CreateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/CreateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"CreateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"}},"required":["sharedSettings"],"type":"object"},"CreateBrandGalleryCardCreativeElement":{"properties":{"customImage":{"$ref":"#/components/schemas/CreateImage"},"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["customImage","headline","landingPage"],"type":"object"},"CreateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/CreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","landingPage"],"type":"object"},"CreateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/CreateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"CreateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"CreateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/CreateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"CreateCardCreativeElement":{"properties":{"headline":{"description":"The headline used for the card.","type":"string"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"}},"required":["headline","landingPage","products"],"type":"object"},"CreateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"CreateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"CreateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/CreateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/CreateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/CreateBrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/CreateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/CreateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/CreateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/CreateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/CreateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/CreateStoreSpotlightSettings"}},"type":"object"},"CreateComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/CreateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/CreateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/CreateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/CreateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/CreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/CreateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"CreateCreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"CreateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"CreateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/CreateStandardDisplaySettings"}},"type":"object"},"CreateFormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"CreateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"CreateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"CreateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"CreateLearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"CreateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CreateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/CreateSharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","type":"string"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"CreateMarketplaceAdConfigurations":{"properties":{"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/CreateMarketplaceAdFieldOverrides"}},"required":["marketplace","overrides"],"type":"object"},"CreateMarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/CreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CreateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["language","videos"],"type":"object"},"CreateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/CreateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"CreateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"CreateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/CreateProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"CreateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/CreateSpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"CreateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"required":["videos"],"type":"object"},"CreateResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/CreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"CreateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/CreateImage"}},"required":["brand"],"type":"object"},"CreateSize":{"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"},"CreateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"CreateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/CreateAudio"},"callToActions":{"$ref":"#/components/schemas/CreateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/CreateImage"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"CreateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/CreateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"CreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n| CreateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"},"CreateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"CreateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateStoreSpotlightLandingPage"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"CreateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/CreateVideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/CreateVideo"}},"required":["videos"],"type":"object"},"CreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"CreateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/CreateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/CreateThirdPartyVideoSettings"}},"type":"object"},"CreateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["adChoicesPosition","language"],"type":"object"},"CreateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["language"],"type":"object"},"CreateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"CreateVideoCallToAction":{"oneOf":[{"properties":{"addToCartVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateAddToCartVideoCallToActionSettings"}},"required":["addToCartVideoCallToActionSettings"],"title":"addToCartVideoCallToActionSettings","type":"object"},{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/CreateLearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"CreateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/CreateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/CreateStreamingTvSettings"}},"type":"object"},"CreateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"Creative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/AudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/ComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/ProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/ThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/VideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"}]},"CreativeOptimizationGoalKpi":{"enum":["CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE","PURCHASE_RATE"],"type":"string"},"CreativeStatus":{"properties":{"moderationStatus":{"$ref":"#/components/schemas/ModerationStatus"}},"required":["moderationStatus"],"type":"object"},"CreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"DeepLinkingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"DeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"DeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_INELIGIBLE` |  |\n| `ADVERTISER_OUT_OF_BUDGET` | Indicates that an advertiser is out of budget for Sponsored Products campaigns for sellers. |\n| `ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT` | Indicates that a postpay advertiser is out of credit limit for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET` | Indicates that a postpay advertiser is out of monthly budget for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_PREPAY_BALANCE` | Indicates that a prepay advertiser is out of prepay balance for all Sponsored Ads campaigns. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `ADVERTISER_POLICING_PENDING_REVIEW` |  |\n| `ADVERTISER_POLICING_SUSPENDED` |  |\n| `AD_ARCHIVED` |  |\n| `AD_CREATION_FAILED` |  |\n| `AD_CREATION_IN_PROGRESS` |  |\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_NOT_DELIVERING` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `BRAND_INELIGIBLE` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_REVIEW` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_INELIGIBLE","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT","ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_IN_PROGRESS","AD_CREATIVES_NOT_RUNNING","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INCOMPLETE","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_LOW_BID","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_REJECTED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_NOT_DELIVERING","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","BRAND_INELIGIBLE","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_REVIEW","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"DeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DisplayCallToAction":{"oneOf":[{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"},{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"}]},"DisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/StandardDisplaySettings"}},"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| `ACTION_NOT_SUPPORTED` | The request is not supported. |\n| `ACTIVE_RESOURCE_LIMIT_EXCEEDED` | Too many live resources. Remove resources and try again. |\n| `ARCHIVED_PARENT_CANNOT_CREATE` | New resources cannot be created within an archived parent. |\n| `ARCHIVED_PARENT_CANNOT_EDIT` | Resources within an archived parent cannot be edited. |\n| `ARCHIVED_RESOURCE_CANNOT_EDIT` | Archived resources cannot be edited. |\n| `ASSET_NOT_READY` | The provided asset is still being processed. |\n| `AUTOCREATED_ENTITY_CANNOT_EDIT` | Autocreated entities cannot be edited. To complete this action, create the resource manually. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FEATURE_NOT_AVAILABLE` | The requested feature is not available. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","ASSET_NOT_READY","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FEATURE_NOT_AVAILABLE","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":4999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"FormatProperties":{"properties":{"applyBorder":{"description":"Apply a boarder to the image to fit rules for some supplies.","type":"boolean"},"height":{"description":"The height (in pixels) of the cropped image.","format":"int32","type":"integer"},"left":{"description":"The number of pixels from the left of the image where the crop should begin.","format":"int32","type":"integer"},"top":{"description":"The number of pixels from the top of the image where the crop should begin.","format":"int32","type":"integer"},"width":{"description":"The width (in pixels) of the cropped image.","format":"int32","type":"integer"}},"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"Image":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/FormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"LandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins"],"type":"object"},"LanguageLocale":{"description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.\n**LanguageLocale Enum:**\n\n| LanguageLocale | Description |\n|------|------|\n| `aa_ET` | Afar (Ethiopia). |\n| `ab_GE` | Abkhazian (Georgia). |\n| `ae_INT` | Avestan (International). |\n| `af_ZA` | Afrikaans (South Africa). |\n| `ak_GH` | Akan (Ghana). |\n| `am_ET` | Amharic (Ethiopia). |\n| `an_ES` | Aragonese (Spain). |\n| `ar_AE` | Arabic (UAE). |\n| `as_IN` | Assamese (India). |\n| `av_RU` | Avaric (Russia). |\n| `ay_BO` | Aymara (Bolivia). |\n| `az_AZ` | Azerbaijani (Azerbaijan). |\n| `ba_RU` | Bashkir (Russia). |\n| `be_BY` | Belarusian (Belarus). |\n| `bg_BG` | Bulgarian (Bulgaria). |\n| `bh_IN` | Bihari (India). |\n| `bi_VU` | Bislama (Vanuatu). |\n| `bm_ML` | Bambara (Mali). |\n| `bn_BD` | Bengali (Bangladesh). |\n| `bo_CN` | Tibetan (China). |\n| `br_FR` | Breton (France). |\n| `bs_BA` | Bosnian (Bosnia and Herzegovina). |\n| `ca_ES` | Catalan (Spain). |\n| `ce_RU` | Chechen (Russia). |\n| `ch_GU` | Chamorro (Guam). |\n| `co_FR` | Corsican (France). |\n| `cr_CA` | Cree (Canada). |\n| `cs_CZ` | Czech (Czech Republic). |\n| `cu_INT` | Church Slavonic (International). |\n| `cv_RU` | Chuvash (Russia). |\n| `cy_GB` | Welsh (United Kingdom). |\n| `da_DK` | Danish (Denmark). |\n| `de_DE` | German (Germany). |\n| `dv_MV` | Divehi (Maldives). |\n| `dz_BT` | Dzongkha (Bhutan). |\n| `ee_GH` | Ewe (Ghana). |\n| `el_GR` | Greek (Greece). |\n| `en_US` | English (United States). |\n| `eo_INT` | Esperanto (International). |\n| `es_ES` | Spanish (Spain). |\n| `et_EE` | Estonian (Estonia). |\n| `eu_ES` | Basque (Spain). |\n| `fa_IR` | Persian (Iran). |\n| `ff_SN` | Fulah (Senegal). |\n| `fi_FI` | Finnish (Finland). |\n| `fj_FJ` | Fijian (Fiji). |\n| `fo_FO` | Faroese (Faroe Islands). |\n| `fr_FR` | French (France). |\n| `fy_NL` | Western Frisian (Netherlands). |\n| `ga_IE` | Irish (Ireland). |\n| `gd_GB` | Scottish Gaelic (United Kingdom). |\n| `gl_ES` | Galician (Spain). |\n| `gn_PY` | Guarani (Paraguay). |\n| `gu_IN` | Gujarati (India). |\n| `gv_IM` | Manx (Isle of Man). |\n| `ha_NG` | Hausa (Nigeria). |\n| `he_IL` | Hebrew (Israel). |\n| `hi_IN` | Hindi (India). |\n| `ho_PG` | Hiri Motu (Papua New Guinea). |\n| `hr_HR` | Croatian (Croatia). |\n| `ht_HT` | Haitian Creole (Haiti). |\n| `hu_HU` | Hungarian (Hungary). |\n| `hy_AM` | Armenian (Armenia). |\n| `hz_NA` | Herero (Namibia). |\n| `ia_INT` | Interlingua (International). |\n| `id_ID` | Indonesian (Indonesia). |\n| `ie_INT` | Interlingue (International). |\n| `ig_NG` | Igbo (Nigeria). |\n| `ii_CN` | Sichuan Yi (China). |\n| `ik_US` | Inupiaq (United States). |\n| `io_INT` | Ido (International). |\n| `is_IS` | Icelandic (Iceland). |\n| `it_IT` | Italian (Italy). |\n| `iu_CA` | Inuktitut (Canada). |\n| `iw_IL` | Hebrew (Israel). |\n| `ja_JP` | Japanese (Japan). |\n| `ji_IL` | Yiddish (Israel). |\n| `jv_ID` | Javanese (Indonesia). |\n| `ka_GE` | Georgian (Georgia). |\n| `kg_CD` | Kongo (Democratic Republic of the Congo). |\n| `ki_KE` | Kikuyu (Kenya). |\n| `kj_NA` | Kwanyama (Namibia). |\n| `kk_KZ` | Kazakh (Kazakhstan). |\n| `kl_GL` | Kalaallisut (Greenland). |\n| `km_KH` | Khmer (Cambodia). |\n| `kn_IN` | Kannada (India). |\n| `ko_KR` | Korean (South Korea). |\n| `kr_NG` | Kanuri (Nigeria). |\n| `ks_IN` | Kashmiri (India). |\n| `ku_TR` | Kurdish (Turkey). |\n| `kv_RU` | Komi (Russia). |\n| `kw_GB` | Cornish (United Kingdom). |\n| `ky_KG` | Kyrgyz (Kyrgyzstan). |\n| `la_VA` | Latin (Vatican City). |\n| `lb_LU` | Luxembourgish (Luxembourg). |\n| `lg_UG` | Ganda (Uganda). |\n| `li_NL` | Limburgish (Netherlands). |\n| `ln_CD` | Lingala (Democratic Republic of the Congo). |\n| `lo_LA` | Lao (Laos). |\n| `lt_LT` | Lithuanian (Lithuania). |\n| `lu_CD` | Luba-Katanga (Democratic Republic of the Congo). |\n| `lv_LV` | Latvian (Latvia). |\n| `mg_MG` | Malagasy (Madagascar). |\n| `mh_MH` | Marshallese (Marshall Islands). |\n| `mi_NZ` | Māori (New Zealand). |\n| `mk_MK` | Macedonian (North Macedonia). |\n| `ml_IN` | Malayalam (India). |\n| `mn_MN` | Mongolian (Mongolia). |\n| `mo_MD` | Moldavian (Moldova). |\n| `mr_IN` | Marathi (India). |\n| `ms_MY` | Malay (Malaysia). |\n| `mt_MT` | Maltese (Malta). |\n| `my_MM` | Burmese (Myanmar). |\n| `na_NR` | Nauru (Nauru). |\n| `nb_NO` | Norwegian Bokmål (Norway). |\n| `nd_ZW` | North Ndebele (Zimbabwe). |\n| `ne_NP` | Nepali (Nepal). |\n| `ng_NA` | Ndonga (Namibia). |\n| `nl_NL` | Dutch (Netherlands). |\n| `nn_NO` | Norwegian Nynorsk (Norway). |\n| `no_NO` | Norwegian (Norway). |\n| `nr_ZA` | South Ndebele (South Africa). |\n| `nv_US` | Navajo (United States). |\n| `ny_MW` | Chichewa (Malawi). |\n| `oc_FR` | Occitan (France). |\n| `oj_CA` | Ojibwa (Canada). |\n| `om_ET` | Oromo (Ethiopia). |\n| `or_IN` | Oriya (India). |\n| `os_RU` | Ossetian (Russia). |\n| `pa_IN` | Punjabi (India). |\n| `pi_IN` | Pali (India). |\n| `pl_PL` | Polish (Poland). |\n| `ps_AF` | Pashto (Afghanistan). |\n| `pt_PT` | Portuguese (Portugal). |\n| `qu_PE` | Quechua (Peru). |\n| `rm_CH` | Romansh (Switzerland). |\n| `rn_BI` | Kirundi (Burundi). |\n| `ro_RO` | Romanian (Romania). |\n| `ru_RU` | Russian (Russia). |\n| `rw_RW` | Kinyarwanda (Rwanda). |\n| `sa_IN` | Sanskrit (India). |\n| `sc_IT` | Sardinian (Italy). |\n| `sd_PK` | Sindhi (Pakistan). |\n| `se_NO` | Northern Sami (Norway). |\n| `sg_CF` | Sango (Central African Republic). |\n| `si_LK` | Sinhala (Sri Lanka). |\n| `sk_SK` | Slovak (Slovakia). |\n| `sl_SI` | Slovenian (Slovenia). |\n| `sm_WS` | Samoan (Samoa). |\n| `sn_ZW` | Shona (Zimbabwe). |\n| `so_SO` | Somali (Somalia). |\n| `sq_AL` | Albanian (Albania). |\n| `sr_RS` | Serbian (Serbia). |\n| `ss_SZ` | Swati (Eswatini). |\n| `st_LS` | Southern Sotho (Lesotho). |\n| `su_ID` | Sundanese (Indonesia). |\n| `sv_SE` | Swedish (Sweden). |\n| `sw_TZ` | Swahili (Tanzania). |\n| `ta_IN` | Tamil (India). |\n| `te_IN` | Telugu (India). |\n| `tg_TJ` | Tajik (Tajikistan). |\n| `th_TH` | Thai (Thailand). |\n| `ti_ET` | Tigrinya (Ethiopia). |\n| `tk_TM` | Turkmen (Turkmenistan). |\n| `tl_PH` | Tagalog (Philippines). |\n| `tn_BW` | Tswana (Botswana). |\n| `to_TO` | Tonga (Tonga). |\n| `tr_TR` | Turkish (Turkey). |\n| `ts_ZA` | Tsonga (South Africa). |\n| `tt_RU` | Tatar (Russia). |\n| `tw_GH` | Twi (Ghana). |\n| `ty_PF` | Tahitian (French Polynesia). |\n| `ug_CN` | Uyghur (China). |\n| `uk_UA` | Ukrainian (Ukraine). |\n| `ur_PK` | Urdu (Pakistan). |\n| `uz_UZ` | Uzbek (Uzbekistan). |\n| `ve_ZA` | Venda (South Africa). |\n| `vi_VN` | Vietnamese (Vietnam). |\n| `vo_INT` | Volapük (International). |\n| `wa_BE` | Walloon (Belgium). |\n| `wo_SN` | Wolof (Senegal). |\n| `xh_ZA` | Xhosa (South Africa). |\n| `yi_IL` | Yiddish (Israel). |\n| `yo_NG` | Yoruba (Nigeria). |\n| `za_CN` | Zhuang (China). |\n| `zh_CN` | Chinese (China). |\n| `zu_ZA` | Zulu (South Africa). |\n","enum":["aa_ET","ab_GE","ae_INT","af_ZA","ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","az_AZ","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bn_BD","bo_CN","br_FR","bs_BA","ca_ES","ce_RU","ch_GU","co_FR","cr_CA","cs_CZ","cu_INT","cv_RU","cy_GB","da_DK","de_DE","dv_MV","dz_BT","ee_GH","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","ff_SN","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","iw_IL","ja_JP","ji_IL","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mo_MD","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"],"type":"string"},"LearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/VideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"ManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/CollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/SharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","type":"string"}},"required":["landingPage","productInclusions","sharedSettings"],"type":"object"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"MarketplaceAdConfigurations":{"properties":{"adId":{"description":"Represents marketplace ad id (Ex: adId-US) associated to global ad (Ex: adId-Global)","type":"string"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overrides":{"$ref":"#/components/schemas/MarketplaceAdFieldOverrides"}},"required":["adId","marketplace","overrides"],"type":"object"},"MarketplaceAdFieldOverrides":{"properties":{"state":{"$ref":"#/components/schemas/State"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/Tag"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"MarketplaceScope":{"enum":["GLOBAL","SINGLE_MARKETPLACE"],"type":"string"},"ModerationStatus":{"description":"**ModerationStatus Enum:**\n\n| ModerationStatus | Description |\n|------|------|\n| `APPROVED_WITH_EXCEPTIONS` | The creative passed basic moderation but was found to be invalid for some supplies. The creative is serving on approved supplies. |\n| `PENDING_TRANSLATION` | The creative is pending creative Translations. |\n| `PUBLISHED` | The creative passed moderation and is serving. |\n| `REJECTED_BY_MODERATION` | The creative was rejected during the moderation process. |\n| `SUBMITTED_FOR_MODERATION` | The creative has been submitted, but has not yet been reviewed. |\n","enum":["APPROVED_WITH_EXCEPTIONS","PENDING_TRANSLATION","PUBLISHED","REJECTED_BY_MODERATION","SUBMITTED_FOR_MODERATION"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"OnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/AdvertisedProducts"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["language","videos"],"type":"object"},"ProductCollectionCreativePropertiesToOptimize":{"description":"**ProductCollectionCreativePropertiesToOptimize Enum:**\n\n| ProductCollectionCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"ProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/LandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"required":["landingPageType"],"type":"object"},"ProductCollectionLandingPageType":{"description":"**ProductCollectionLandingPageType Enum:**\n\n| ProductCollectionLandingPageType | Description |\n|------|------|\n| `ASIN_LIST` | A list of products based on the products promoted in the ad creative. |\n| `CUSTOM_URL` | A custom landing page. Available for vendors only. |\n| `STORE` | A brand Store landing page. |\n","enum":["ASIN_LIST","CUSTOM_URL","STORE"],"type":"string"},"ProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ProductCollectionLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headlines entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","customImages","headlines","landingPage"],"type":"object"},"ProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/ProductCreativeSettings"}},"required":["productCreativeSettings"],"type":"object"},"ProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/AdvertisedProducts"},"headline":{"description":"The headline/custom text associated with the ad creative.","type":"string"},"spotlightVideos":{"$ref":"#/components/schemas/SpotlightVideoSettings"}},"required":["advertisedProduct"],"type":"object"},"ProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `RETAILER_OFFER` | Retailer offer identifier type. Used for Retail Ad Service products. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","RETAILER_OFFER","SKU"],"type":"string"},"ProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/VideoLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedVideos":{"description":"The original video assets submitted as part of the creative.","items":{"$ref":"#/components/schemas/Video"},"maxItems":2,"minItems":1,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/Video"},"maxItems":2,"minItems":1,"type":"array"}},"required":["untranslatedVideos","videos"],"type":"object"},"PublisherHostedCreativeSource":{"description":"The publisher ad server source for publisher hosted creative placeholder creatives.\n**PublisherHostedCreativeSource Enum:**\n\n| PublisherHostedCreativeSource | Description |\n|------|------|\n| `GOOGLE_AD_MANAGER` | Google Ad Manager publisher ad server. |\n","enum":["GOOGLE_AD_MANAGER"],"type":"string"},"QueryAdRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/AdAdGroupIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/AdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/AdAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/AdCampaignIdFilter"},"marketplaceScopeFilter":{"$ref":"#/components/schemas/AdMarketplaceScopeFilter"},"maxResults":{"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/AdNameFilter"},"nextToken":{"type":"string"},"retailerScopeFilter":{"$ref":"#/components/schemas/AdRetailerScopeFilter"},"stateFilter":{"$ref":"#/components/schemas/AdStateFilter"}},"required":["adProductFilter"],"type":"object"},"ResponsiveEcommerceAdVariations":{"enum":["ADD_TO_CART","COUPON","CUSTOMER_REVIEWS","SHOP_NOW"],"type":"string"},"ResponsiveEcommerceCreativePropertiesToOptimize":{"description":"**ResponsiveEcommerceCreativePropertiesToOptimize Enum:**\n\n| ResponsiveEcommerceCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n| `IMAGE` | The image in the creative. |\n| `TITLE` | The title in the creative. |\n","enum":["HEADLINE","IMAGE","TITLE"],"type":"string"},"ResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"ResponsiveEcommerceLandingPageType":{"description":"**ResponsiveEcommerceLandingPageType Enum:**\n\n| ResponsiveEcommerceLandingPageType | Description |\n|------|------|\n| `MOMENT` | A moment landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["MOMENT","STORE"],"type":"string"},"ResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/Image"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/ResponsiveEcommerceLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","type":"string"}},"type":"object"},"ResponsiveSizingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"RetailerScope":{"description":"**RetailerScope Enum:**\n\n| RetailerScope | Description |\n|------|------|\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |\n","enum":["AMAZON","OTHER_RETAILERS"],"type":"string"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/Image"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"}},"required":["brand"],"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"},"SpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/Video"},"maxItems":5,"minItems":1,"type":"array"}},"required":["optimizeText","videos"],"type":"object"},"StandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/Audio"},"callToActions":{"$ref":"#/components/schemas/AudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/Image"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"StandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/Image"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"State":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"],"type":"string"},"Status":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplaceSettings":{"description":"The list of marketplace level delivery status and reasons of global resources, for all the marketplaces the global resource is applicable in.","items":{"$ref":"#/components/schemas/StatusMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"}},"required":["deliveryStatus"],"type":"object"},"StatusMarketplaceSetting":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"marketplace":{"$ref":"#/components/schemas/Marketplace"}},"required":["deliveryStatus","marketplace"],"type":"object"},"StoreSpotlightCreativePropertiesToOptimize":{"description":"**StoreSpotlightCreativePropertiesToOptimize Enum:**\n\n| StoreSpotlightCreativePropertiesToOptimize | Description |\n|------|------|\n| `HEADLINE` | The headline in the creative. |\n","enum":["HEADLINE"],"type":"string"},"StoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"StoreSpotlightLandingPageType":{"description":"**StoreSpotlightLandingPageType Enum:**\n\n| StoreSpotlightLandingPageType | Description |\n|------|------|\n| `STORE` | A brand Store landing page. |\n","enum":["STORE"],"type":"string"},"StoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/Image"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/StoreSpotlightLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"required":["brand","brandLogos","cards","headlines","landingPage"],"type":"object"},"StreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/VideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/VideoLandingPage"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"moderationStatus":{"$ref":"#/components/schemas/CreativeStatus"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/AdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/Video"}},"required":["videos"],"type":"object"},"SupportedThirdPartySellers":{"enum":["ALL","NONE"],"type":"string"},"Tag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"ThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/ThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/ThirdPartyVideoSettings"}},"type":"object"},"ThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/Size"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["adChoicesPosition","language"],"type":"object"},"ThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"required":["language"],"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"},"UpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/AdUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"UpdateAdvertisedProducts":{"properties":{"globalStoreSetting":{"$ref":"#/components/schemas/UpdateGlobalStoreSettings"},"marketplaceSettings":{"description":"List of advertised product selectively applied at the given marketplace level","items":{"$ref":"#/components/schemas/CreateAdvertisedProductMarketplaceSetting"},"maxItems":30,"minItems":0,"type":"array"},"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/ProductIdType"}},"type":"object"},"UpdateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"UpdateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/AssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateAssetBasedCreativeSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/UpdateVideo"},"disclaimers":{"description":"The disclaimers to use for the Asset Based Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"UpdateAudio":{"properties":{"assetId":{"description":"The asset library ID associated with the audio asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the audio asset.","type":"string"}},"type":"object"},"UpdateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"UpdateAudioCreative":{"description":"| UpdateAudioCreative | Description |\n| --- | --- |\n| `standardAudioSettings` | The standard audio experience settings. See the Audio Spec for more info: https://advertising.amazon.com/en-us/resources/ad-specs/audio-ads?ref_\u003da20m_us_spcs_spcs_aa |","oneOf":[{"properties":{"standardAudioSettings":{"$ref":"#/components/schemas/UpdateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"UpdateAutoCollectionSettings":{"description":"Settings for automatically generated collections.","properties":{"productExclusions":{"description":"Products to exclude from auto collection.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":1000,"minItems":0,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"}},"type":"object"},"UpdateBrandGallerySettings":{"description":"An ad creative that showcases a brand and its categories and collections.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different category associated to a brand.","items":{"$ref":"#/components/schemas/CreateBrandGalleryCardCreativeElement"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/BrandGalleryCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateStoreSpotlightLandingPage"}},"type":"object"},"UpdateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/UpdateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"UpdateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/BrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateBrandStoreSettings":{"properties":{"additionalHtml":{"description":"Additional HTML to include with the render response for display inventory targets.","type":"string"},"bodyText":{"description":"The body text to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"brand":{"description":"The brand of the product(s) being advertised.","type":"string"},"callToActions":{"$ref":"#/components/schemas/UpdateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimers to use for the Brand Store Creative experience.","type":"string"},"headlines":{"description":"The headline(s) to use for the Brand Store Creative experience.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"type":"object"},"UpdateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"type":"object"},"UpdateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"UpdateCollectionLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/CollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page.","type":"string"}},"type":"object"},"UpdateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/UpdateAssetBasedCreativeSettings"},"autoCollectionSettings":{"$ref":"#/components/schemas/UpdateAutoCollectionSettings"},"brandGallerySettings":{"$ref":"#/components/schemas/UpdateBrandGallerySettings"},"brandStoreSettings":{"$ref":"#/components/schemas/UpdateBrandStoreSettings"},"manualCollectionSettings":{"$ref":"#/components/schemas/UpdateManualCollectionSettings"},"productCollectionSettings":{"$ref":"#/components/schemas/UpdateProductCollectionSettings"},"productVideoSettings":{"$ref":"#/components/schemas/UpdateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/UpdateResponsiveEcommerceSettings"},"storeSpotlightSettings":{"$ref":"#/components/schemas/UpdateStoreSpotlightSettings"}},"type":"object"},"UpdateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/UpdateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/UpdateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/UpdateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/UpdateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/UpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"productCreative":{"$ref":"#/components/schemas/UpdateProductCreative"}},"required":["productCreative"],"title":"productCreative","type":"object"}]},"UpdateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/UpdateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"UpdateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/UpdateStandardDisplaySettings"}},"type":"object"},"UpdateGlobalStoreSettings":{"properties":{"catalogSourceMarketplace":{"$ref":"#/components/schemas/Marketplace"}},"type":"object"},"UpdateImage":{"properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"},"formatProperties":{"description":"The cropping and positioning properties associated with the asset.","items":{"$ref":"#/components/schemas/CreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateLandingPageAsins":{"properties":{"asins":{"description":"For landing page of type ASIN_LIST, the list of ASINs used to create the landing page.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"UpdateManualCollectionSettings":{"description":"Settings for manually curated collections.","properties":{"landingPage":{"$ref":"#/components/schemas/UpdateCollectionLandingPage"},"productInclusions":{"description":"The products featured in the ad. Required for manual collections.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":3,"type":"array"},"sharedSettings":{"$ref":"#/components/schemas/UpdateSharedCollectionSettings"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","nullable":true,"type":"string"}},"type":"object"},"UpdateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateProductCollectionLandingPage":{"properties":{"landingPageAsins":{"$ref":"#/components/schemas/UpdateLandingPageAsins"},"landingPageType":{"$ref":"#/components/schemas/ProductCollectionLandingPageType"},"landingPageUrl":{"description":"The URL associated to the landing page. Read only if landingPageType is ASIN_LIST","type":"string"}},"type":"object"},"UpdateProductCollectionSettings":{"description":"An ad creative that contains multiple products and a custom image.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":2,"minItems":1,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ProductCollectionCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"customImages":{"description":"The set of custom images featured in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":5,"minItems":1,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateProductCollectionLandingPage"},"products":{"description":"The products featured in the ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"UpdateProductCreative":{"properties":{"productCreativeSettings":{"$ref":"#/components/schemas/UpdateProductCreativeSettings"}},"type":"object"},"UpdateProductCreativeSettings":{"description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"$ref":"#/components/schemas/UpdateAdvertisedProducts"},"spotlightVideos":{"$ref":"#/components/schemas/UpdateSpotlightVideoSettings"}},"type":"object"},"UpdateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":3,"minItems":0,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":2,"minItems":1,"type":"array"}},"type":"object"},"UpdateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/ComponentInventoryType"},"maxItems":2,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"logos":{"$ref":"#/components/schemas/UpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/CreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/ResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/ResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/SupportedThirdPartySellers"}},"type":"object"},"UpdateSharedCollectionSettings":{"description":"Settings shared by all collection types.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"$ref":"#/components/schemas/UpdateImage"}},"type":"object"},"UpdateSpotlightVideoSettings":{"description":"An ad with a creative built with spotlight videos.","properties":{"optimizeText":{"description":"If the advertiser wants text they provided to be optimized by Amazon or not.","type":"boolean"},"videos":{"description":"The video asset(s) to use for the Sponsored Product experience.","items":{"$ref":"#/components/schemas/CreateVideo"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"UpdateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/UpdateAudio"},"callToActions":{"$ref":"#/components/schemas/UpdateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/UpdateImage"},"headlines":{"description":"The headline(s) to use for the standard audio experience. Headlines must be a maximum of 20 characters.","type":"string"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"UpdateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/UpdateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"}},"type":"object"},"UpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"},"UpdateStoreSpotlightLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/StoreSpotlightLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"UpdateStoreSpotlightSettings":{"description":"An ad creative that contains ASINs within a brand Store.","properties":{"brand":{"description":"The name of the brand being advertised.","type":"string"},"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/CreateImage"},"maxItems":1,"minItems":1,"type":"array"},"cards":{"description":"The sub-elements of the creative. Each card highlights a different ASIN associated to a brand Store.","items":{"$ref":"#/components/schemas/CreateCardCreativeElement"},"maxItems":3,"minItems":3,"type":"array"},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","items":{"$ref":"#/components/schemas/StoreSpotlightCreativePropertiesToOptimize"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"landingPage":{"$ref":"#/components/schemas/UpdateStoreSpotlightLandingPage"}},"type":"object"},"UpdateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/CreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/CreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/UpdateVideo"}},"type":"object"},"UpdateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/UpdateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/UpdateThirdPartyVideoSettings"}},"type":"object"},"UpdateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/AdChoicesPosition"},"additionalHtml":{"description":"Additional html to be included along with the creative when rendered.","type":"string"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","items":{"$ref":"#/components/schemas/CreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"thirdPartyTagHostingSource":{"description":"The html tag to use to fetch this creative from the 3p ad server. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"type":"object"},"UpdateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/CreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/LanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/PublisherHostedCreativeSource"},"vastUrl":{"description":"The url to use to fetch the VAST XML for this video creative. Required for non publisher hosted creatives (when publisherHostedCreativeSource is not set).","type":"string"}},"type":"object"},"UpdateVideo":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"type":"object"},"UpdateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/UpdateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/UpdateStreamingTvSettings"}},"type":"object"},"UpdateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"type":"object"},"Video":{"properties":{"assetId":{"description":"The asset library ID associated with the video asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the video asset.","type":"string"},"description":{"description":"The description of the video content.","type":"string"},"headline":{"description":"The headline/custom text associated with the video.","type":"string"}},"required":["assetId","assetVersion"],"type":"object"},"VideoCallToAction":{"oneOf":[{"properties":{"addToCartVideoCallToActionSettings":{"$ref":"#/components/schemas/AddToCartVideoCallToActionSettings"}},"required":["addToCartVideoCallToActionSettings"],"title":"addToCartVideoCallToActionSettings","type":"object"},{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/ClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/LearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"VideoCallToActionPosition":{"enum":["LEFT","MINIMAL","RIGHT"],"type":"string"},"VideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/OnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/StreamingTvSettings"}},"type":"object"},"VideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/VideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType"],"type":"object"},"VideoLandingPageType":{"description":"**VideoLandingPageType Enum:**\n\n| VideoLandingPageType | Description |\n|------|------|\n| `DETAIL_PAGE` | A product detail page. |\n| `MOMENT` | A moment landing page. |\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["DETAIL_PAGE","MOMENT","OFF_AMAZON_LINK","STORE"],"type":"string"}},"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":"Ads API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/ads":{"post":{"description":"Create ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_creatives_edit\", \"creatives_edit\"]","operationId":"CreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"CreateAd 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":["Ads"]}},"/adsApi/v1/delete/ads":{"post":{"description":"Delete ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"DeleteAd 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":["Ads"]}},"/adsApi/v1/query/ads":{"post":{"description":"List ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_creatives_view\", \"creatives_view\", \n\"dsp_creatives_edit\", \"creatives_edit\", \"advertiser_campaign_view\"]","operationId":"QueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSuccessResponse"}}},"description":"QueryAd 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":["Ads"]}},"/adsApi/v1/update/ads":{"post":{"description":"Update ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\", \"dsp_creatives_edit\", \"creatives_edit\"]","operationId":"UpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdMultiStatusResponseWithPartialErrors"}}},"description":"UpdateAd 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":["Ads"]}}},"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"}]}