{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"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"},"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| `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| `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","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","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"},"SDAd":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adId":{"description":"The identifier of the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"adType":{"$ref":"#/components/schemas/SDAdType"},"campaignId":{"description":"The campaign associated with the ad. It\u0027s a read-only field.","type":"string"},"creationDateTime":{"description":"The date time that the ad was created.","format":"date-time","type":"string"},"creative":{"$ref":"#/components/schemas/SDCreative"},"lastUpdatedDateTime":{"description":"The date time that the ad was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SDMarketplaceScope"},"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/SDMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/SDState"},"status":{"$ref":"#/components/schemas/SDStatus"}},"required":["adGroupId","adId","adProduct","adType","campaignId","creationDateTime","creative","lastUpdatedDateTime","marketplaceScope","marketplaces","state"],"type":"object"},"SDAdAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |","items":{"$ref":"#/components/schemas/SDAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDAdCreate":{"properties":{"adGroupId":{"description":"The ad group associated with the ad.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"adType":{"$ref":"#/components/schemas/SDAdType"},"creative":{"$ref":"#/components/schemas/SDCreateCreative"},"name":{"description":"The name of the ad.","type":"string"},"state":{"$ref":"#/components/schemas/SDCreateState"}},"required":["adGroupId","adProduct","adType","creative","state"],"type":"object"},"SDAdMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SDAdMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SDAdMultiStatusSuccess":{"properties":{"ad":{"$ref":"#/components/schemas/SDAd"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["ad","index"],"type":"object"},"SDAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `SPONSORED_DISPLAY` | Sponsored Display ad product. |\n","enum":["SPONSORED_DISPLAY"],"type":"string"},"SDAdSuccessResponse":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SDAd"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SDAdType":{"description":"**AdType Enum:**\n\n| AdType | Description |\n|------|------|\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n","enum":["COMPONENT"],"type":"string"},"SDAdUpdate":{"properties":{"adId":{"description":"The identifier of the ad.","type":"string"},"creative":{"$ref":"#/components/schemas/SDUpdateCreative"},"state":{"$ref":"#/components/schemas/SDUpdateState"}},"required":["adId"],"type":"object"},"SDAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SDProductIdType"}},"required":["productId","productIdType"],"type":"object"},"SDAssetBasedCreativeSettings":{"properties":{"backgrounds":{"description":"The background which is displayed on the ad.","items":{"$ref":"#/components/schemas/SDBackground"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"hasTermsAndConditions":{"description":"Indicates that the ad promotes a free product or service and has qualifying terms and conditions applicable to the customer. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those.","type":"boolean"},"headlines":{"description":"The headline(s) to use for the Asset Based Creative experience.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/SDImage"},"maxItems":3,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SDComponentLandingPage"},"logos":{"description":"The logos to use for the Asset Based Creative experience.","items":{"$ref":"#/components/schemas/SDImage"},"maxItems":1,"minItems":0,"type":"array"},"moderationStatus":{"$ref":"#/components/schemas/SDCreativeStatus"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["headlines","landingPage","untranslatedHeadlines"],"type":"object"},"SDBackground":{"properties":{"color":{"description":"The color hex code of the background.","type":"string"}},"type":"object"},"SDComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/SDAssetBasedCreativeSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SDProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/SDResponsiveEcommerceSettings"}},"type":"object"},"SDComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDComponentLandingPageType":{"description":"**ComponentLandingPageType Enum:**\n\n| ComponentLandingPageType | Description |\n|------|------|\n| `OFF_AMAZON_LINK` | An off-Amazon landing page. |\n","enum":["OFF_AMAZON_LINK"],"type":"string"},"SDCreateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SDAdCreate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SDCreateAdvertisedProducts":{"properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"$ref":"#/components/schemas/SDProductIdType"}},"required":["productId","productIdType"],"type":"object"},"SDCreateAssetBasedCreativeSettings":{"properties":{"landingPage":{"$ref":"#/components/schemas/SDCreateComponentLandingPage"}},"required":["landingPage"],"type":"object"},"SDCreateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/SDCreateAssetBasedCreativeSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SDCreateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/SDCreateResponsiveEcommerceSettings"}},"type":"object"},"SDCreateComponentLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDComponentLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDCreateCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SDCreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SDCreateProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"landingPage":{"$ref":"#/components/schemas/SDCreateVideoLandingPage"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/SDCreateAdvertisedProducts"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"SDCreateResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDCreateResponsiveEcommerceSettings":{"properties":{"landingPage":{"$ref":"#/components/schemas/SDCreateResponsiveEcommerceLandingPage"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/SDCreateAdvertisedProducts"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"SDCreateState":{"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| `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":["ENABLED","PAUSED"],"type":"string"},"SDCreateVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDVideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SDComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SDCreativeStatus":{"properties":{"moderationStatus":{"$ref":"#/components/schemas/SDModerationStatus"}},"required":["moderationStatus"],"type":"object"},"SDDeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"SDDeliveryReason":{"description":"**DeliveryReason Enum:**\n\n| DeliveryReason | Description |\n|------|------|\n| `ADVERTISER_ARCHIVED` |  |\n| `ADVERTISER_OUT_OF_BUDGET` | Indicates that an advertiser is out of budget for Sponsored Products campaigns for sellers. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `AD_ARCHIVED` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_ENDED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_PAUSED` |  |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `OUT_OF_STOCK` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","AD_ARCHIVED","AD_GROUP_ARCHIVED","AD_GROUP_ENDED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_PAUSED","AD_POLICING_PENDING_REVIEW","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_START_DATE","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","OUT_OF_STOCK","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE"],"type":"string"},"SDDeliveryStatus":{"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| `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","NOT_DELIVERING","UNAVAILABLE"],"type":"string"},"SDFormatProperties":{"properties":{"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"},"SDImage":{"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/SDFormatProperties"},"maxItems":10,"minItems":0,"type":"array"}},"required":["assetId","assetVersion"],"type":"object"},"SDMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US"],"type":"string"},"SDMarketplaceScope":{"enum":["SINGLE_MARKETPLACE"],"type":"string"},"SDModerationStatus":{"description":"**ModerationStatus Enum:**\n\n| ModerationStatus | Description |\n|------|------|\n| `PUBLISHED` | The creative passed moderation and is serving. |\n| `REJECTED_BY_MODERATION` | The creative was rejected during the moderation process. |\n| `SUBMITTED_FOR_MODERATION` | The creative has been submitted, but has not yet been reviewed. |\n","enum":["PUBLISHED","REJECTED_BY_MODERATION","SUBMITTED_FOR_MODERATION"],"type":"string"},"SDProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","SKU"],"type":"string"},"SDProductVideoSettings":{"description":"An ad with a creative that includes a video.","properties":{"brandLogos":{"description":"The brand logo image assets to be used in the ad.","items":{"$ref":"#/components/schemas/SDImage"},"maxItems":1,"minItems":0,"type":"array"},"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline submitted as part of the ad creative. During your campaign, Amazon will optimize amongst the headlines you provide to match customer intent.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SDVideoLandingPage"},"moderationStatus":{"$ref":"#/components/schemas/SDCreativeStatus"},"products":{"description":"The products featured in the video ad.","items":{"$ref":"#/components/schemas/SDAdvertisedProducts"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedVideos":{"description":"The original video assets submitted as part of the creative.","items":{"$ref":"#/components/schemas/SDVideo"},"maxItems":2,"minItems":1,"type":"array"},"videos":{"description":"The video assets used in the ad.","items":{"$ref":"#/components/schemas/SDVideo"},"maxItems":2,"minItems":1,"type":"array"}},"required":["untranslatedVideos","videos"],"type":"object"},"SDQueryAdRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SDAdAdProductFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"required":["adProductFilter"],"type":"object"},"SDResponsiveEcommerceLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDResponsiveEcommerceLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDResponsiveEcommerceLandingPageType":{"description":"**ResponsiveEcommerceLandingPageType Enum:**\n\n| ResponsiveEcommerceLandingPageType | Description |\n|------|------|\n| `MOMENT` | A moment landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["MOMENT","STORE"],"type":"string"},"SDResponsiveEcommerceSettings":{"properties":{"enableCreativeAutoTranslation":{"description":"If set to true and the headline and/or video are not in the marketplace\u0027s default language, Amazon will attempt to translate them to the marketplace\u0027s default language. If Amazon is unable to translate them, the ad will be rejected by moderation.","type":"boolean"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","items":{"$ref":"#/components/schemas/SDImage"},"maxItems":3,"minItems":0,"type":"array"},"landingPage":{"$ref":"#/components/schemas/SDResponsiveEcommerceLandingPage"},"logos":{"$ref":"#/components/schemas/SDImage"},"moderationStatus":{"$ref":"#/components/schemas/SDCreativeStatus"},"products":{"description":"The products advertised for the Responsive eCommerce experience.","items":{"$ref":"#/components/schemas/SDAdvertisedProducts"},"maxItems":1,"minItems":0,"type":"array"},"untranslatedHeadlines":{"description":"The headline entered by the advertiser.","type":"string"}},"type":"object"},"SDState":{"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| `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","ENABLED","PAUSED"],"type":"string"},"SDStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/SDDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/SDDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"SDUpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SDAdUpdate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SDUpdateAssetBasedCreativeSettings":{"type":"object"},"SDUpdateComponentCreative":{"properties":{"assetBasedCreativeSettings":{"$ref":"#/components/schemas/SDUpdateAssetBasedCreativeSettings"},"productVideoSettings":{"$ref":"#/components/schemas/SDUpdateProductVideoSettings"},"responsiveEcommerceSettings":{"$ref":"#/components/schemas/SDUpdateResponsiveEcommerceSettings"}},"type":"object"},"SDUpdateCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SDUpdateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SDUpdateProductVideoSettings":{"description":"An ad with a creative that includes a video.","type":"object"},"SDUpdateResponsiveEcommerceSettings":{"type":"object"},"SDUpdateState":{"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| `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":["ENABLED","PAUSED"],"type":"string"},"SDVideo":{"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"},"SDVideoLandingPage":{"properties":{"landingPageType":{"$ref":"#/components/schemas/SDVideoLandingPageType"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"],"type":"object"},"SDVideoLandingPageType":{"description":"**VideoLandingPageType Enum:**\n\n| VideoLandingPageType | Description |\n|------|------|\n| `MOMENT` | A moment landing page. |\n| `STORE` | A brand Store landing page. |\n","enum":["MOMENT","STORE"],"type":"string"},"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":"SD 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":"SDCreateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCreateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdMultiStatusResponse"}}},"description":"SDCreateAd 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["Ads"]}},"/adsApi/v1/delete/ads":{"post":{"description":"Delete ads\n\n**Note:** Batch size limits are specific to each ad product. Refer to the ad-product-specific documentation for applicable limits.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"SDDeleteAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDDeleteAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdMultiStatusResponse"}}},"description":"SDDeleteAd 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":"SDQueryAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDQueryAdRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdSuccessResponse"}}},"description":"SDQueryAd 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":"SDUpdateAd","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDUpdateAdRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdMultiStatusResponse"}}},"description":"SDUpdateAd 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"}]}