{"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"},"SDAdGroup":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"bid":{"$ref":"#/components/schemas/SDAdGroupBid"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creationDateTime":{"description":"The date time that the ad group was created.","format":"date-time","type":"string"},"creativeType":{"$ref":"#/components/schemas/SDCreativeType"},"lastUpdatedDateTime":{"description":"The date time that the ad group 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 group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/SDMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/SDOptimization"},"state":{"$ref":"#/components/schemas/SDState"},"status":{"$ref":"#/components/schemas/SDStatus"}},"required":["adGroupId","adProduct","campaignId","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","name","state"],"type":"object"},"SDAdGroupAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDAdGroupAdProductFilter":{"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"},"SDAdGroupBid":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SDCurrencyCode"},"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"required":["currencyCode"],"type":"object"},"SDAdGroupCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDAdGroupCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"bid":{"$ref":"#/components/schemas/SDCreateAdGroupBid"},"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"creativeType":{"$ref":"#/components/schemas/SDCreativeType"},"marketplaceScope":{"$ref":"#/components/schemas/SDMarketplaceScope"},"marketplaces":{"description":"The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign","items":{"$ref":"#/components/schemas/SDMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/SDCreateOptimization"},"state":{"$ref":"#/components/schemas/SDCreateState"}},"required":["adProduct","campaignId","marketplaceScope","marketplaces","name","state"],"type":"object"},"SDAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/SDKPI"}},"type":"object"},"SDAdGroupMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SDAdGroupMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SDAdGroupMultiStatusSuccess":{"properties":{"adGroup":{"$ref":"#/components/schemas/SDAdGroup"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["adGroup","index"],"type":"object"},"SDAdGroupNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SDAdGroupNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SDAdGroupNameFilterType":{"description":"**AdGroupNameFilterType Enum:**\n| AdGroupNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SDAdGroupStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | 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. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/SDState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDAdGroupSuccessResponse":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SDAdGroup"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SDAdGroupUpdate":{"properties":{"adGroupId":{"description":"The unique identifier of the ad group.","type":"string"},"bid":{"$ref":"#/components/schemas/SDUpdateAdGroupBid"},"name":{"description":"The name of the ad group.","type":"string"},"optimization":{"$ref":"#/components/schemas/SDUpdateOptimization"},"state":{"$ref":"#/components/schemas/SDUpdateState"}},"required":["adGroupId"],"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"},"SDAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"audienceId":{"$ref":"#/components/schemas/SDMarketplaceStringValue"}},"required":["audienceId"],"type":"object"},"SDBackground":{"properties":{"color":{"description":"The color hex code of the background.","type":"string"}},"type":"object"},"SDBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SDBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SDBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/SDRecurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"SDBudgetType":{"enum":["MONETARY"],"type":"string"},"SDBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SDMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SDCampaign":{"properties":{"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SDBudget"},"maxItems":1,"minItems":1,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/SDCostType"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/SDCountryCode"},"maxItems":1,"minItems":0,"type":"array"},"creationDateTime":{"description":"The date time that the campaign was created.","format":"date-time","type":"string"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"The date time that the campaign was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SDMarketplaceScope"},"marketplaces":{"description":"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. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/SDMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SDState"},"status":{"$ref":"#/components/schemas/SDStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SDTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","budgets","campaignId","costType","creationDateTime","lastUpdatedDateTime","marketplaceScope","name","startDateTime","state"],"type":"object"},"SDCampaignAdProductFilter":{"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"},"SDCampaignCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDCampaignCreate":{"properties":{"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SDCreateBudget"},"maxItems":1,"minItems":1,"type":"array"},"costType":{"$ref":"#/components/schemas/SDCostType"},"countries":{"description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"$ref":"#/components/schemas/SDCountryCode"},"maxItems":1,"minItems":0,"type":"array"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SDMarketplaceScope"},"marketplaces":{"description":"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. ADSP campaigns can be created by specifying either countries or marketplaces, but at least one of these attributes must be provided. In ADSP, this field acts as an implicit filter on your inventory targets. For example, if you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties.","items":{"$ref":"#/components/schemas/SDMarketplace"},"maxItems":1,"minItems":0,"type":"array"},"name":{"description":"The name of the campaign.","type":"string"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SDCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SDCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["adProduct","budgets","costType","marketplaceScope","name","startDateTime","state"],"type":"object"},"SDCampaignMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SDCampaignMultiStatusSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SDCampaignMultiStatusSuccess":{"properties":{"campaign":{"$ref":"#/components/schemas/SDCampaign"},"index":{"format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["campaign","index"],"type":"object"},"SDCampaignNameFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SDCampaignNameFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SDCampaignNameFilterType":{"description":"**CampaignNameFilterType Enum:**\n| CampaignNameFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SDCampaignPortfolioIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDCampaignStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | 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. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/SDState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDCampaignSuccessResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SDCampaign"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"SDCampaignUpdate":{"properties":{"budgets":{"description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"$ref":"#/components/schemas/SDCreateBudget"},"maxItems":1,"minItems":1,"type":"array"},"campaignId":{"description":"A unique identifier for a campaign.","type":"string"},"costType":{"$ref":"#/components/schemas/SDCostType"},"endDateTime":{"description":"The end date time for the campaign.","format":"date-time","nullable":true,"type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"portfolioId":{"description":"The ID of the portfolio associated with the campaign.","nullable":true,"type":"string"},"startDateTime":{"description":"The start date time for the campaign.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/SDUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the campaign","items":{"$ref":"#/components/schemas/SDCreateTag"},"maxItems":50,"minItems":0,"type":"array"}},"required":["campaignId"],"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"},"SDContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"SDCostType":{"description":"**CostType Enum:**\n\n| CostType | Description |\n|------|------|\n| `CPC` | Cost per click. |\n| `VCPM` | Cost per thousand views. |\n","enum":["CPC","VCPM"],"type":"string"},"SDCountryCode":{"enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US"],"type":"string"},"SDCreateAdGroupBid":{"properties":{"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"type":"object"},"SDCreateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/SDKPI"}},"type":"object"},"SDCreateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SDAdGroupCreate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"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"},"SDCreateAudienceTarget":{"description":"Target based on a specified audience ID.","properties":{"audienceId":{"$ref":"#/components/schemas/SDCreateMarketplaceStringValue"}},"required":["audienceId"],"type":"object"},"SDCreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/SDBudgetType"},"budgetValue":{"$ref":"#/components/schemas/SDCreateBudgetValue"}},"required":["budgetType","budgetValue"],"type":"object"},"SDCreateBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/SDCreateMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"title":"monetaryBudgetValue","type":"object"}]},"SDCreateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SDCampaignCreate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaigns"],"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"},"SDCreateContentCategoryTarget":{"description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"description":"The content category being targeted.","type":"string"}},"required":["contentCategoryId"],"type":"object"},"SDCreateCreative":{"oneOf":[{"properties":{"componentCreative":{"$ref":"#/components/schemas/SDCreateComponentCreative"}},"required":["componentCreative"],"title":"componentCreative","type":"object"}]},"SDCreateKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/SDKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SDLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SDCreateLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"SDCreateMarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"SDCreateMonetaryBudget":{"properties":{"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["value"],"type":"object"},"SDCreateMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SDCreateMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SDCreateOptimization":{"properties":{"goalSettings":{"$ref":"#/components/schemas/SDCreateAdGroupGoalSettings"}},"type":"object"},"SDCreateProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/SDCreateMarketplaceStringValue"},"event":{"$ref":"#/components/schemas/SDTargetEvent"},"lookback":{"$ref":"#/components/schemas/SDLookback"},"matchType":{"$ref":"#/components/schemas/SDProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"SDCreateProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"SDCreateProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SDCreateProductCategoryRefinement"}},"type":"object"},"SDCreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SDCreateProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SDCreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SDProductMatchType"},"product":{"$ref":"#/components/schemas/SDCreateProductValue"},"productIdType":{"$ref":"#/components/schemas/SDProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SDCreateProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"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\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. |\n","enum":["ENABLED","PAUSED"],"type":"string"},"SDCreateTag":{"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"},"SDCreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"type":"object"},"SDCreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SDCreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SDCreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SDCreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/SDCreateProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/SDCreateAudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SDCreateLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/SDCreateContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SDCreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SDCreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SDTargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SDCreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SDThemeMatchType"}},"required":["matchType"],"type":"object"},"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"},"SDCreativeType":{"description":"**CreativeType Enum:**\n\n| CreativeType | Description |\n|------|------|\n| `IMAGE` | An image creative. |\n| `VIDEO` | A video creative. |\n","enum":["IMAGE","VIDEO"],"type":"string"},"SDCurrencyCode":{"description":"**CurrencyCode Enum:**\n\n| CurrencyCode | Description |\n|------|------|\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `CHF` | Swiss Franc |\n| `CNY` | Chinese Yuan |\n| `DKK` | Danish Krone |\n| `EGP` | Egyptian Pound |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `MXP` | Mexican Peso |\n| `NGN` | Nigerian Naira |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `PLN` | Polish Złoty |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |\n| `ZAR` | South African Rand |\n","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"SDDeleteAdGroupRequest":{"properties":{"adGroupIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroupIds"],"type":"object"},"SDDeleteAdRequest":{"properties":{"adIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adIds"],"type":"object"},"SDDeleteCampaignRequest":{"properties":{"campaignIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"SDDeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIds"],"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"},"SDKPI":{"description":"**KPI Enum:**\n\n| KPI | Description |\n|------|------|\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `LEADS` | Indicates a goal of driving leads. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CONTACTS","LEADS","OTHER","PAGE_VIEWS","PURCHASES","REACH","SEARCH","SIGN_UP","SUBSCRIBE"],"type":"string"},"SDKeywordMatchType":{"description":"**KeywordMatchType Enum:**\n\n| KeywordMatchType | Description |\n|------|------|\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"SDKeywordTarget":{"description":"Targets a specific customer search term.","properties":{"keyword":{"description":"The customer search term or text to target. For valid characters and constraints, [see keyword character constraints](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#keyword-character-constraints).","type":"string"},"matchType":{"$ref":"#/components/schemas/SDKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SDLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SDLanguageLocale":{"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| `en_US` | English (United States). |\n","enum":["en_US"],"type":"string"},"SDLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"},"locationIdResolved":{"description":"A human-readable location text. It\u0027s a read-only field.","type":"string"}},"required":["locationId"],"type":"object"},"SDLookback":{"description":"**Lookback Enum:**\n\n| Lookback | Description |\n|------|------|\n| `DAYS_14` | Two week lookback period. |\n| `DAYS_180` | Six month lookback period. |\n| `DAYS_30` | One month lookback period. |\n| `DAYS_365` | One year lookback period. |\n| `DAYS_60` | Two month lookback period. |\n| `DAYS_7` | One week lookback period. |\n| `DAYS_90` | Three month lookback period. |\n","enum":["DAYS_14","DAYS_180","DAYS_30","DAYS_365","DAYS_60","DAYS_7","DAYS_90"],"type":"string"},"SDMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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"},"SDMarketplaceStringValue":{"properties":{"defaultValue":{"description":"The default value. Either the default value or the marketplace settings should always be specified","type":"string"}},"type":"object"},"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"},"SDMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/SDCurrencyCode"},"ruleValue":{"description":"The monetary amount of the budget when a budget rule is applied.","format":"double","type":"number"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"SDMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/SDMonetaryBudget"}},"required":["monetaryBudget"],"type":"object"},"SDOptimization":{"properties":{"goalSettings":{"$ref":"#/components/schemas/SDAdGroupGoalSettings"}},"type":"object"},"SDProductAudienceMatchType":{"description":"**ProductAudienceMatchType Enum:**\n\n| ProductAudienceMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"SDProductAudienceTarget":{"description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"$ref":"#/components/schemas/SDMarketplaceStringValue"},"event":{"$ref":"#/components/schemas/SDTargetEvent"},"lookback":{"$ref":"#/components/schemas/SDLookback"},"matchType":{"$ref":"#/components/schemas/SDProductAudienceMatchType"}},"required":["asin","event","lookback","matchType"],"type":"object"},"SDProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productAgeRangeIdResolved":{"description":"The resolved age range to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productBrandIdResolved":{"description":"The resolved name of the brand.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productCategoryIdResolved":{"description":"The resolved product category.","type":"string"},"productPriceGreaterThan":{"description":"Refinement to target products with a price greater than the value within the product category.","format":"double","type":"number"},"productPriceLessThan":{"description":"Refinement to target products with a price less than the value within the product category.","format":"double","type":"number"},"productPrimeShippingEligible":{"description":"Target based on if a product is Prime-shipping eligible.","type":"boolean"},"productRatingGreaterThan":{"description":"Refinement to target products with a rating greater than the value within the product category.","format":"double","type":"number"},"productRatingLessThan":{"description":"Refinement to target products with a rating less than the value within the product category.","format":"double","type":"number"}},"type":"object"},"SDProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SDProductCategoryRefinement"}},"type":"object"},"SDProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SDProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"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"},"SDProductMatchType":{"description":"**ProductMatchType Enum:**\n\n| ProductMatchType | Description |\n|------|------|\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"SDProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SDProductMatchType"},"product":{"$ref":"#/components/schemas/SDProductValue"},"productIdType":{"$ref":"#/components/schemas/SDProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SDProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"type":"object"},"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"},"SDQueryAdGroupRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SDAdGroupAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SDAdGroupAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SDAdGroupCampaignIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SDAdGroupNameFilter"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SDAdGroupStateFilter"}},"required":["adProductFilter"],"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"},"SDQueryCampaignRequest":{"properties":{"adProductFilter":{"$ref":"#/components/schemas/SDCampaignAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SDCampaignCampaignIdFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SDCampaignNameFilter"},"nextToken":{"type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/SDCampaignPortfolioIdFilter"},"stateFilter":{"$ref":"#/components/schemas/SDCampaignStateFilter"}},"required":["adProductFilter"],"type":"object"},"SDQueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SDTargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SDTargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SDTargetCampaignIdFilter"},"maxResults":{"default":5000,"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"stateFilter":{"$ref":"#/components/schemas/SDTargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/SDTargetTargetIdFilter"}},"required":["adProductFilter"],"type":"object"},"SDRecurrence":{"enum":["DAILY"],"type":"string"},"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"},"SDTag":{"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"},"SDTarget":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"bid":{"$ref":"#/components/schemas/SDTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"creationDateTime":{"description":"The date time the target was created.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/SDState"},"status":{"$ref":"#/components/schemas/SDStatus"},"targetDetails":{"$ref":"#/components/schemas/SDTargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/SDTargetLevel"},"targetType":{"$ref":"#/components/schemas/SDTargetType"}},"required":["adProduct","creationDateTime","lastUpdatedDateTime","negative","state","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"SDTargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDTargetAdProductFilter":{"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"},"SDTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/SDCurrencyCode"}},"required":["currencyCode"],"type":"object"},"SDTargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDTargetCreate":{"properties":{"adGroupId":{"description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets.","type":"string"},"adProduct":{"$ref":"#/components/schemas/SDAdProduct"},"bid":{"$ref":"#/components/schemas/SDCreateTargetBid"},"campaignId":{"description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets.","type":"string"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"state":{"$ref":"#/components/schemas/SDCreateState"},"targetDetails":{"$ref":"#/components/schemas/SDCreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/SDTargetType"}},"required":["adProduct","negative","state","targetDetails","targetType"],"type":"object"},"SDTargetDetails":{"oneOf":[{"properties":{"audienceTarget":{"$ref":"#/components/schemas/SDAudienceTarget"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"contentCategoryTarget":{"$ref":"#/components/schemas/SDContentCategoryTarget"}},"required":["contentCategoryTarget"],"title":"contentCategoryTarget","type":"object"},{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SDKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SDLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"productAudienceTarget":{"$ref":"#/components/schemas/SDProductAudienceTarget"}},"required":["productAudienceTarget"],"title":"productAudienceTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SDProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SDProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SDThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SDTargetEvent":{"description":"**TargetEvent Enum:**\n\n| TargetEvent | Description |\n|------|------|\n| `PURCHASE` | A product purchase event. |\n| `VIEW` | A product view event. |\n","enum":["PURCHASE","VIEW"],"type":"string"},"SDTargetLevel":{"description":"**TargetLevel Enum:**\n\n| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n","enum":["AD_GROUP"],"type":"string"},"SDTargetMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SDTargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SDTargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/SDTarget"}},"required":["index","target"],"type":"object"},"SDTargetStateFilter":{"properties":{"include":{"description":"**State Enum:**\n| State | 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. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","items":{"$ref":"#/components/schemas/SDState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDTargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SDTarget"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"},"SDTargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SDTargetType":{"description":"**TargetType Enum:**\n\n| TargetType | Description |\n|------|------|\n| `AUDIENCE` | Target based on an audience segment. |\n| `CONTENT_CATEGORY` | Target based on content category. |\n| `KEYWORD` | Target based on customer search terms. |\n| `LOCATION` | Target based on geographic location. |\n| `PRODUCT_AUDIENCE` | Target customers who interacted with a specific product. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `PRODUCT` | Target based on a specific product. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |\n","enum":["AUDIENCE","CONTENT_CATEGORY","KEYWORD","LOCATION","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","THEME"],"type":"string"},"SDTargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/SDUpdateTargetBid"},"state":{"$ref":"#/components/schemas/SDUpdateState"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"SDThemeMatchType":{"description":"**ThemeMatchType Enum:**\n\n| ThemeMatchType | Description |\n|------|------|\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n","enum":["INTERESTED_AUDIENCE"],"type":"string"},"SDThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SDThemeMatchType"}},"required":["matchType"],"type":"object"},"SDUpdateAdGroupBid":{"properties":{"defaultBid":{"description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction.","format":"double","type":"number"}},"type":"object"},"SDUpdateAdGroupGoalSettings":{"properties":{"kpi":{"$ref":"#/components/schemas/SDKPI"}},"type":"object"},"SDUpdateAdGroupRequest":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SDAdGroupUpdate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["adGroups"],"type":"object"},"SDUpdateAdRequest":{"properties":{"ads":{"items":{"$ref":"#/components/schemas/SDAdUpdate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"},"SDUpdateAssetBasedCreativeSettings":{"type":"object"},"SDUpdateCampaignRequest":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SDCampaignUpdate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaigns"],"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"}]},"SDUpdateOptimization":{"properties":{"goalSettings":{"$ref":"#/components/schemas/SDUpdateAdGroupGoalSettings"}},"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\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. |\n","enum":["ENABLED","PAUSED"],"type":"string"},"SDUpdateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"type":"object"},"SDUpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SDTargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"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 Advertising API","title":"Amazon Ads API SD Merged","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/adGroups":{"post":{"description":"Create ad groups\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDCreateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCreateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdGroupMultiStatusResponse"}}},"description":"SDCreateAdGroup 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":["AdGroups"]}},"/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\", \"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/create/campaigns":{"post":{"description":"Create campaigns\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDCreateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCreateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCampaignMultiStatusResponse"}}},"description":"SDCreateCampaign 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":["Campaigns"]}},"/adsApi/v1/create/targets":{"post":{"description":"Create target\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDCreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCreateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDTargetMultiStatusResponse"}}},"description":"SDCreateTarget 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":["Targets"]}},"/adsApi/v1/delete/adGroups":{"post":{"description":"Delete ad groups\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":"SDDeleteAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDDeleteAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdGroupMultiStatusResponse"}}},"description":"SDDeleteAdGroup 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":["AdGroups"]}},"/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/delete/campaigns":{"post":{"description":"Delete campaigns\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":"SDDeleteCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDDeleteCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCampaignMultiStatusResponse"}}},"description":"SDDeleteCampaign 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":["Campaigns"]}},"/adsApi/v1/delete/targets":{"post":{"description":"Delete target\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDDeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDDeleteTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDTargetMultiStatusResponse"}}},"description":"SDDeleteTarget 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":["Targets"]}},"/adsApi/v1/query/adGroups":{"post":{"description":"List ad groups\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_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"SDQueryAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDQueryAdGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdGroupSuccessResponse"}}},"description":"SDQueryAdGroup 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":["AdGroups"]}},"/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\", \"creatives_view\", \"creatives_edit\", \n\"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/query/campaigns":{"post":{"description":"Query campaign\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_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\"]","operationId":"SDQueryCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDQueryCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCampaignSuccessResponse"}}},"description":"SDQueryCampaign 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":["Campaigns"]}},"/adsApi/v1/query/targets":{"post":{"description":"List target\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_campaign_view\", \"campaign_view\", \n\"advertiser_campaign_view\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDQueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDQueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDTargetSuccessResponse"}}},"description":"SDQueryTarget 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":["Targets"]}},"/adsApi/v1/update/adGroups":{"post":{"description":"Update ad groups\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDUpdateAdGroup","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDUpdateAdGroupRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAdGroupMultiStatusResponse"}}},"description":"SDUpdateAdGroup 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":["AdGroups"]}},"/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\", \"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"]}},"/adsApi/v1/update/campaigns":{"post":{"description":"Update campaign\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\", \"campaign_edit\", \"dsp_campaign_edit\"]","operationId":"SDUpdateCampaign","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDUpdateCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDCampaignMultiStatusResponse"}}},"description":"SDUpdateCampaign 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":["Campaigns"]}},"/adsApi/v1/update/targets":{"post":{"description":"Update target\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":"SDUpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDUpdateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDTargetMultiStatusResponse"}}},"description":"SDUpdateTarget 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":["Targets"]}}},"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"}]}