{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"DSPAd":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"adType":{"$ref":"#/components/schemas/DSPAdType"},"creationDateTime":{"description":"The date time that the ad was created.","format":"date-time","type":"string"},"creative":{"$ref":"#/components/schemas/DSPCreative"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/DSPMarketplaceScope"},"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/DSPMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/DSPState"},"status":{"$ref":"#/components/schemas/DSPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/DSPTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId","adProduct","adType","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","name","state"],"type":"object"},"DSPAdAdIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","items":{"$ref":"#/components/schemas/DSPAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"DSPAdChoicesPosition":{"enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"],"type":"string"},"DSPAdCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/DSPAdProduct"},"adType":{"$ref":"#/components/schemas/DSPAdType"},"creative":{"$ref":"#/components/schemas/DSPCreateCreative"},"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/DSPMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/DSPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/DSPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","adType","creative","name","state"],"type":"object"},"DSPAdMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPAdMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"DSPAdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/DSPAd"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"DSPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","enum":["AMAZON_DSP"],"type":"string"},"DSPAdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/DSPAd"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DSPAdType":{"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| `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","THIRD_PARTY","VIDEO"],"type":"string"},"DSPAdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/DSPUpdateCreative"},"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/DSPMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/DSPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the ad","items":{"$ref":"#/components/schemas/DSPCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adId"],"type":"object"},"DSPAddToCartVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/DSPVideoCallToActionPosition"}},"required":["position"],"type":"object"},"DSPAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/DSPProductIdType"}},"required":["productId","productIdType"],"type":"object"},"DSPAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/DSPAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"DSPAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/DSPAssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"DSPAssetBasedCreativeCallToActionType":{"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"},"DSPAssetBasedCreativeSettings":{"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/DSPAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/DSPVideo"},"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/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"DSPAudio":{"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"},"DSPAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/DSPClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"DSPAudioCreative":{"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/DSPStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"DSPBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/DSPBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"DSPBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/DSPBrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"DSPBrandStoreCallToActionType":{"enum":["BUY_NOW","DISCOVER_MORE","LEARN_MORE","SEE_DETAILS","SHOP_NOW"],"type":"string"},"DSPBrandStoreSettings":{"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/DSPBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPSize"},"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/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"DSPClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"DSPClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/DSPAssetBasedCreativeSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/DSPBrandStoreSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/DSPResponsiveEcommerceSettings"}},"type":"object"},"DSPComponentInventoryType":{"enum":["DISPLAY","NATIVE"],"type":"string"},"DSPCreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/DSPAdCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"DSPCreateAddToCartVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/DSPVideoCallToActionPosition"}},"required":["position"],"type":"object"},"DSPCreateAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/DSPProductIdType"}},"required":["productId","productIdType"],"type":"object"},"DSPCreateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"DSPCreateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/DSPAssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"DSPCreateAssetBasedCreativeSettings":{"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/DSPCreateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/DSPCreateVideo"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"DSPCreateAudio":{"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"},"DSPCreateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"DSPCreateAudioCreative":{"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/DSPCreateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"DSPCreateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"DSPCreateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/DSPBrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["url"],"type":"object"},"DSPCreateBrandStoreSettings":{"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/DSPCreateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPCreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"required":["brand","callToActions","headlines","inventoryTypes","language","optimizationGoalKpi","responsiveSizingBehavior","squareImages","tallImages","wideImages"],"type":"object"},"DSPCreateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPCreateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"required":["url"],"type":"object"},"DSPCreateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPCreateClickToUrlVideoCallToActionSettings":{"properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The url to redirect the user via the video CallToAction.","type":"string"}},"required":["deepLinkingBehavior","url"],"type":"object"},"DSPCreateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/DSPCreateAssetBasedCreativeSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/DSPCreateBrandStoreSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/DSPCreateResponsiveEcommerceSettings"}},"type":"object"},"DSPCreateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/DSPCreateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DSPCreateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/DSPCreateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/DSPCreateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/DSPCreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"DSPCreateCreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"DSPCreateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"DSPCreateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/DSPCreateStandardDisplaySettings"}},"type":"object"},"DSPCreateFormatProperties":{"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"},"DSPCreateImage":{"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/DSPCreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"DSPCreateLearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/DSPVideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"DSPCreateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPCreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/DSPCreateVideo"}},"required":["language","videos"],"type":"object"},"DSPCreateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"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/DSPResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"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/DSPCreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPCreateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":20,"minItems":1,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/DSPSupportedThirdPartySellers"}},"required":["inventoryTypes","language","optimizationGoalKpi","products","responsiveSizingBehavior","supportedThirdPartySellers"],"type":"object"},"DSPCreateSize":{"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"},"DSPCreateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/DSPCreateAudio"},"callToActions":{"$ref":"#/components/schemas/DSPCreateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/DSPCreateImage"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"DSPCreateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DSPCreateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"DSPCreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n| CreateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPCreateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPCreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/DSPCreateVideo"}},"required":["language","videos"],"type":"object"},"DSPCreateTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"DSPCreateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/DSPCreateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/DSPCreateThirdPartyVideoSettings"}},"type":"object"},"DSPCreateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"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/DSPCreateCreativeTrackingUrl"},"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/DSPCreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPCreateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPCreateVideo":{"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"}},"required":["assetId","assetVersion"],"type":"object"},"DSPCreateVideoCallToAction":{"oneOf":[{"properties":{"addToCartVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateAddToCartVideoCallToActionSettings"}},"required":["addToCartVideoCallToActionSettings"],"title":"addToCartVideoCallToActionSettings","type":"object"},{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPCreateLearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"DSPCreateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/DSPCreateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/DSPCreateStreamingTvSettings"}},"type":"object"},"DSPCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/DSPAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/DSPComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DSPDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/DSPThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/DSPVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"}]},"DSPCreativeOptimizationGoalKpi":{"enum":["CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE","PURCHASE_RATE"],"type":"string"},"DSPCreativeTrackingUrl":{"properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"],"type":"object"},"DSPDeepLinkingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"DSPDeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `AD_CREATIVES_NOT_RUNNING` |  |\n| `AD_GROUPS_NOT_RUNNING` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INELIGIBLE_GOAL_KPI` | Indicates that the ad group is suspended because the campaign\u0027s goal KPI is not supported. |\n| `AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign is missing conversion tracking selections. |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_START_DATE` |  |\n| `AD_GROUP_POLICING_SUSPENDED` |  |\n| `AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign has an insufficient number of conversion tracking selections. |\n| `AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS` | Indicates that the ad group is suspended because the campaign exceeded the maximum number of conversion tracking selections. |\n| `AD_NOT_APPROVED_FOR_ALL_AD_GROUPS` |  |\n| `AD_NOT_ASSOCIATED_WITH_AD_GROUP` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_POLICING_SUSPENDED` |  |\n| `OTHER` |  |\n","enum":["AD_CREATIVES_NOT_RUNNING","AD_GROUPS_NOT_RUNNING","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INELIGIBLE_GOAL_KPI","AD_GROUP_MISSING_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_PAUSED","AD_GROUP_PENDING_START_DATE","AD_GROUP_POLICING_SUSPENDED","AD_GROUP_TOO_FEW_CONVERSION_TRACKING_SELECTIONS","AD_GROUP_TOO_MANY_CONVERSION_TRACKING_SELECTIONS","AD_NOT_APPROVED_FOR_ALL_AD_GROUPS","AD_NOT_ASSOCIATED_WITH_AD_GROUP","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_POLICING_SUSPENDED","OTHER"],"type":"string"},"DSPDeliveryStatus":{"description":"**DeliveryStatus Enum:**\n\n| DeliveryStatus | Description |\n|------|------|\n| `DELIVERING` | Represents the resource is delivering. For global, DELIVERING status indicates that the resource is delivering in all marketplaces |\n| `LIMITED` | Represents partial delivery status, applicable to global resources that have different delivery status across marketplaces |\n| `NOT_DELIVERING` | Represents the resource is not delivering. For global, NOT_DELIVERING status indicates that the resource is NOT delivering in all marketplaces |\n| `UNAVAILABLE` | Represents unavailable resource status. For global, UNAVAILABLE status indicates that the status is unavailable in all marketplaces |\n","enum":["DELIVERING","LIMITED","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"DSPDisplayCallToAction":{"oneOf":[{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"},{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"}]},"DSPDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/DSPStandardDisplaySettings"}},"type":"object"},"DSPFormatProperties":{"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"},"DSPImage":{"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/DSPFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"DSPLanguageLocale":{"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"},"DSPLearnMoreVideoCallToActionSettings":{"properties":{"position":{"$ref":"#/components/schemas/DSPVideoCallToActionPosition"},"url":{"description":"The url to drive users to learn more via the video CallToAction.","type":"string"}},"required":["position","url"],"type":"object"},"DSPMarketplace":{"description":"A list of country codes representing Amazon marketplaces\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"},"DSPMarketplaceScope":{"enum":["SINGLE_MARKETPLACE"],"type":"string"},"DSPOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"$ref":"#/components/schemas/DSPAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/DSPVideo"}},"required":["language","videos"],"type":"object"},"DSPProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n","enum":["ASIN"],"type":"string"},"DSPPublisherHostedCreativeSource":{"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"},"DSPQueryAdRequest":{"properties":{"adIdFilter":{"$ref":"#/components/schemas/DSPAdAdIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/DSPAdAdProductFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"required":["adProductFilter"],"type":"object"},"DSPResponsiveEcommerceAdVariations":{"enum":["ADD_TO_CART","COUPON","CUSTOMER_REVIEWS","SHOP_NOW"],"type":"string"},"DSPResponsiveEcommerceCreativePropertiesToOptimize":{"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"},"DSPResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"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/DSPResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPSize"},"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/DSPImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPAdvertisedProducts"},"maxItems":20,"minItems":1,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/DSPSupportedThirdPartySellers"}},"required":["inventoryTypes","language","optimizationGoalKpi","products","responsiveSizingBehavior","supportedThirdPartySellers"],"type":"object"},"DSPResponsiveSizingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"DSPSize":{"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"},"DSPStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/DSPAudio"},"callToActions":{"$ref":"#/components/schemas/DSPAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/DSPImage"},"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/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/DSPAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"required":["audio","companionImages","headlines","language"],"type":"object"},"DSPStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DSPDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/DSPImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"}},"required":["adChoicesPosition","creativeSizes","customImages","language"],"type":"object"},"DSPState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**State Enum:**\n\n| State | Description |\n|------|------|\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/DSPDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DSPDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"DSPStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/DSPAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/DSPVideo"}},"required":["language","videos"],"type":"object"},"DSPSupportedThirdPartySellers":{"enum":["ALL","NONE"],"type":"string"},"DSPTag":{"properties":{"key":{"description":"A custom key value pair entered by the advertiser. For ADSP Campaigns and Ad Groups, Amazon creates a COMMENTS key when the Comments field is populated in UI.","type":"string"},"value":{"description":"A custom key value pair entered by the advertiser.","type":"string"}},"required":["key","value"],"type":"object"},"DSPThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/DSPThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/DSPThirdPartyVideoSettings"}},"type":"object"},"DSPThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"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/DSPCreativeTrackingUrl"},"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/DSPSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPUpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/DSPAdUpdate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"DSPUpdateAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/DSPProductIdType"}},"type":"object"},"DSPUpdateAssetBasedCreativeCallToAction":{"oneOf":[{"properties":{"assetBasedCreativeCallToActionSettings":{"$ref":"#/components/schemas/DSPUpdateAssetBasedCreativeCallToActionSettings"}},"required":["assetBasedCreativeCallToActionSettings"],"title":"assetBasedCreativeCallToActionSettings","type":"object"}]},"DSPUpdateAssetBasedCreativeCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for AssetBasedCreative.","items":{"$ref":"#/components/schemas/DSPAssetBasedCreativeCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"DSPUpdateAssetBasedCreativeSettings":{"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/DSPUpdateAssetBasedCreativeCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"maxItems":20,"minItems":0,"type":"array"},"customVideos":{"$ref":"#/components/schemas/DSPUpdateVideo"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":0,"type":"array"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"DSPUpdateAudio":{"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"},"DSPUpdateAudioCallToAction":{"oneOf":[{"properties":{"clickToUrlAudioCallToActionSettings":{"$ref":"#/components/schemas/DSPUpdateClickToUrlAudioCallToActionSettings"}},"required":["clickToUrlAudioCallToActionSettings"],"title":"clickToUrlAudioCallToActionSettings","type":"object"}]},"DSPUpdateAudioCreative":{"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/DSPUpdateStandardAudioExperienceSettings"}},"required":["standardAudioSettings"],"title":"standardAudioSettings","type":"object"}]},"DSPUpdateBrandStoreCallToAction":{"oneOf":[{"properties":{"brandStoreCallToActionSettings":{"$ref":"#/components/schemas/DSPUpdateBrandStoreCallToActionSettings"}},"required":["brandStoreCallToActionSettings"],"title":"brandStoreCallToActionSettings","type":"object"}]},"DSPUpdateBrandStoreCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"callToActionType":{"description":"Type of CallToAction for BrandStore.","items":{"$ref":"#/components/schemas/DSPBrandStoreCallToActionType"},"maxItems":5,"minItems":0,"type":"array"},"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"DSPUpdateBrandStoreSettings":{"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/DSPUpdateBrandStoreCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPUpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"squareImages":{"description":"The square image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"tallImages":{"description":"The tall image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"},"wideImages":{"description":"The wide image(s) to use.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"DSPUpdateClickToAppDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The app that customers are directed to.","type":"string"}},"type":"object"},"DSPUpdateClickToUrlAudioCallToActionSettings":{"properties":{"url":{"description":"The url to redirect the user via the audio CallToAction.","type":"string"}},"type":"object"},"DSPUpdateClickToUrlDisplayCallToActionSettings":{"description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"$ref":"#/components/schemas/DSPDeepLinkingBehavior"},"url":{"description":"The application url that customers are directed to.","type":"string"}},"type":"object"},"DSPUpdateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/DSPUpdateAssetBasedCreativeSettings"},"brandStoreSettings":{"$ref":"#/components/schemas/DSPUpdateBrandStoreSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/DSPUpdateResponsiveEcommerceSettings"}},"type":"object"},"DSPUpdateCreative":{"oneOf":[{"properties":{"audioCreative":{"$ref":"#/components/schemas/DSPUpdateAudioCreative"}},"required":["audioCreative"],"title":"audioCreative","type":"object"},{"properties":{"displayCreative":{"$ref":"#/components/schemas/DSPUpdateDisplayCreative"}},"required":["displayCreative"],"title":"displayCreative","type":"object"},{"properties":{"thirdPartyCreative":{"$ref":"#/components/schemas/DSPUpdateThirdPartyCreative"}},"required":["thirdPartyCreative"],"title":"thirdPartyCreative","type":"object"},{"properties":{"videoCreative":{"$ref":"#/components/schemas/DSPUpdateVideoCreative"}},"required":["videoCreative"],"title":"videoCreative","type":"object"},{"properties":{"componentCreative":{"$ref":"#/components/schemas/DSPUpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"DSPUpdateDisplayCallToAction":{"oneOf":[{"properties":{"clickToUrlDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPUpdateClickToUrlDisplayCallToActionSettings"}},"required":["clickToUrlDisplayCallToActionSettings"],"title":"clickToUrlDisplayCallToActionSettings","type":"object"},{"properties":{"clickToAppDisplayCallToActionSettings":{"$ref":"#/components/schemas/DSPUpdateClickToAppDisplayCallToActionSettings"}},"required":["clickToAppDisplayCallToActionSettings"],"title":"clickToAppDisplayCallToActionSettings","type":"object"}]},"DSPUpdateDisplayCreative":{"properties":{"standardDisplaySettings":{"$ref":"#/components/schemas/DSPUpdateStandardDisplaySettings"}},"type":"object"},"DSPUpdateImage":{"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/DSPCreateFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"DSPUpdateOnlineVideoSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPCreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"$ref":"#/components/schemas/DSPUpdateAdvertisedProducts"},"videos":{"$ref":"#/components/schemas/DSPUpdateVideo"}},"type":"object"},"DSPUpdateResponsiveEcommerceSettings":{"properties":{"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"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/DSPResponsiveEcommerceCreativePropertiesToOptimize"},"maxItems":3,"minItems":0,"type":"array"},"creativeSizes":{"description":"The placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"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/DSPCreateImage"},"maxItems":3,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"inventoryTypes":{"description":"The inventory types this creative should serve on.","items":{"$ref":"#/components/schemas/DSPComponentInventoryType"},"maxItems":2,"minItems":1,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"logos":{"$ref":"#/components/schemas/DSPUpdateImage"},"optimizationGoalKpi":{"$ref":"#/components/schemas/DSPCreativeOptimizationGoalKpi"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":20,"minItems":1,"type":"array"},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/DSPResponsiveEcommerceAdVariations"},"maxItems":5,"minItems":0,"type":"array"},"responsiveSizingBehavior":{"$ref":"#/components/schemas/DSPResponsiveSizingBehavior"},"supportedThirdPartySellers":{"$ref":"#/components/schemas/DSPSupportedThirdPartySellers"}},"type":"object"},"DSPUpdateStandardAudioExperienceSettings":{"properties":{"audio":{"$ref":"#/components/schemas/DSPUpdateAudio"},"callToActions":{"$ref":"#/components/schemas/DSPUpdateAudioCallToAction"},"companionImages":{"$ref":"#/components/schemas/DSPUpdateImage"},"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/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product(s) being advertised.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"DSPUpdateStandardDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"callToAction":{"$ref":"#/components/schemas/DSPUpdateDisplayCallToAction"},"clickTrackingUrls":{"description":"The third party urls to trigger when an click is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"creativeSizes":{"description":"The list of placement sizes this creative should serve on.","items":{"$ref":"#/components/schemas/DSPCreateSize"},"maxItems":20,"minItems":1,"type":"array"},"customImages":{"description":"The custom images to use for the standard display experience.","items":{"$ref":"#/components/schemas/DSPCreateImage"},"maxItems":20,"minItems":1,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"}},"type":"object"},"DSPUpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | The resource is in draft status and has not yet been proposed or enabled. |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["DRAFT","ENABLED","PAUSED"],"type":"string"},"DSPUpdateStreamingTvSettings":{"properties":{"callToActions":{"description":"The call to actions for this video.","items":{"$ref":"#/components/schemas/DSPCreateVideoCallToAction"},"maxItems":10,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"products":{"description":"The product advertised on this video creative.","items":{"$ref":"#/components/schemas/DSPCreateAdvertisedProducts"},"maxItems":20,"minItems":0,"type":"array"},"videos":{"$ref":"#/components/schemas/DSPUpdateVideo"}},"type":"object"},"DSPUpdateThirdPartyCreative":{"properties":{"thirdPartyDisplaySettings":{"$ref":"#/components/schemas/DSPUpdateThirdPartyDisplaySettings"},"thirdPartyVideoSettings":{"$ref":"#/components/schemas/DSPUpdateThirdPartyVideoSettings"}},"type":"object"},"DSPUpdateThirdPartyDisplaySettings":{"properties":{"adChoicesPosition":{"$ref":"#/components/schemas/DSPAdChoicesPosition"},"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/DSPCreateCreativeTrackingUrl"},"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/DSPCreateSize"},"maxItems":20,"minItems":0,"type":"array"},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPUpdateThirdPartyVideoSettings":{"properties":{"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","items":{"$ref":"#/components/schemas/DSPCreateCreativeTrackingUrl"},"maxItems":5,"minItems":0,"type":"array"},"language":{"$ref":"#/components/schemas/DSPLanguageLocale"},"publisherHostedCreativeSource":{"$ref":"#/components/schemas/DSPPublisherHostedCreativeSource"},"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"},"DSPUpdateVideo":{"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"}},"type":"object"},"DSPUpdateVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/DSPUpdateOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/DSPUpdateStreamingTvSettings"}},"type":"object"},"DSPVideo":{"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"}},"required":["assetId","assetVersion"],"type":"object"},"DSPVideoCallToAction":{"oneOf":[{"properties":{"addToCartVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPAddToCartVideoCallToActionSettings"}},"required":["addToCartVideoCallToActionSettings"],"title":"addToCartVideoCallToActionSettings","type":"object"},{"properties":{"clickToUrlVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPClickToUrlVideoCallToActionSettings"}},"required":["clickToUrlVideoCallToActionSettings"],"title":"clickToUrlVideoCallToActionSettings","type":"object"},{"properties":{"learnMoreVideoCallToActionSettings":{"$ref":"#/components/schemas/DSPLearnMoreVideoCallToActionSettings"}},"required":["learnMoreVideoCallToActionSettings"],"title":"learnMoreVideoCallToActionSettings","type":"object"}]},"DSPVideoCallToActionPosition":{"enum":["LEFT","MINIMAL","RIGHT"],"type":"string"},"DSPVideoCreative":{"properties":{"onlineVideoSettings":{"$ref":"#/components/schemas/DSPOnlineVideoSettings"},"streamingTvSettings":{"$ref":"#/components/schemas/DSPStreamingTvSettings"}},"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| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","ASSET_NOT_READY","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":4999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"DSP 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":"DSPCreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdMultiStatusResponse"}}},"description":"DSPCreateAd 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":"DSPQueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPQueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdSuccessResponse"}}},"description":"DSPQueryAd 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":"DSPUpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPUpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPAdMultiStatusResponse"}}},"description":"DSPUpdateAd 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"}]}