{"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| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `DATE_CANNOT_BE_IN_PAST` | Update the date to be in the future. |\n| `DATE_CANNOT_BE_NULL` | Update the date. |\n| `DATE_TOO_SOON` | Update the date to be further in the future. |\n| `DUPLICATE_FIELD_VALUE_FOUND` | Multiple resources share the non-unique field values. Remove the non-unique field value. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `DURATION_TOO_SHORT` | Update the length to be within the required range. |\n| `FEATURE_DISCONTINUED` | Feature has been discontinued. |\n| `FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_SIZE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_CANNOT_EDIT` | Field value cannot be edited. |\n| `FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_CONTAINS_INVALID_CHARACTERS` | Remove the invalid characters and try again. |\n| `FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT` | Update the value to be within the required range. |\n| `FIELD_VALUE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_INVALID` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_IS_OUT_OF_RANGE` | Update the value to be within the required range. |\n| `FIELD_VALUE_MISMATCH` | Mismatch among resource field values. |\n| `FIELD_VALUE_MUST_BE_EMPTY_OR_NULL` | Update the request with the required information for this resource. |\n| `FIELD_VALUE_NOT_FOUND` | Resource specified in the field value not found. Try again with valid value. |\n| `FIELD_VALUE_NOT_UNIQUE` | Resource field value conflicts with existing resource. Try again with an unique field value. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO` | The campaign is associated with a global campaign. Portfolio association cannot be updated on a child campaign. Please perform operation on the global campaign. |\n| `GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE` | The campaign is associated with a global campaign. The state on child campaign cannot be set to archived. Please perform operation on global campaign. |\n| `GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT` | The campaign is associated with a global campaign. Only one ad group can be created under this campaign. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `PAYMENT_ISSUE` | Payment failed. |\n| `PRODUCT_INELIGIBLE` | Product is not eligible for advertising. Try again with a valid product. |\n| `RESOURCE_DOES_NOT_BELONG_TO_PARENT` | Resource does not belong to the specified parent. Try again with a valid parent ID. |\n| `RESOURCE_ID_NOT_FOUND` | Resource ID not found. Try again with valid ID. |\n| `RESOURCE_IS_EMPTY` | Update the request with the required information for this resource. |\n| `RESOURCE_IS_IN_TERMINAL_STATE` | Resource is in terminal state. |\n| `RESOURCE_IS_NULL` | Update the request with the required information for this resource. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `TOTAL_RESOURCE_LIMIT_EXCEEDED` | Too many resources. Remove resources and try again. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `UNSUPPORTED_MARKETPLACE` | Marketplace not supported. Try again with a supported marketplace. |\n","enum":["ACTION_NOT_SUPPORTED","ACTIVE_RESOURCE_LIMIT_EXCEEDED","ARCHIVED_PARENT_CANNOT_CREATE","ARCHIVED_PARENT_CANNOT_EDIT","ARCHIVED_RESOURCE_CANNOT_EDIT","AUTOCREATED_ENTITY_CANNOT_EDIT","BAD_REQUEST","CONFLICT","CONTENT_TOO_LARGE","DATE_CANNOT_BE_IN_PAST","DATE_CANNOT_BE_NULL","DATE_TOO_SOON","DUPLICATE_FIELD_VALUE_FOUND","DUPLICATE_RESOURCE_ID_FOUND","DURATION_TOO_SHORT","FEATURE_DISCONTINUED","FIELD_SIZE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_SIZE_IS_BELOW_MINIMUM_LIMIT","FIELD_SIZE_IS_OUT_OF_RANGE","FIELD_VALUE_CANNOT_EDIT","FIELD_VALUE_CONTAINS_BLOCKLISTED_WORDS","FIELD_VALUE_CONTAINS_INVALID_CHARACTERS","FIELD_VALUE_IS_ABOVE_MAXIMUM_LIMIT","FIELD_VALUE_IS_BELOW_MINIMUM_LIMIT","FIELD_VALUE_IS_EMPTY","FIELD_VALUE_IS_INVALID","FIELD_VALUE_IS_NULL","FIELD_VALUE_IS_OUT_OF_RANGE","FIELD_VALUE_MISMATCH","FIELD_VALUE_MUST_BE_EMPTY_OR_NULL","FIELD_VALUE_NOT_FOUND","FIELD_VALUE_NOT_UNIQUE","FORBIDDEN","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_PORTFOLIO","GLOBAL_ATTRIBUTE_UPDATE_RESTRICTED_STATE","GLOBAL_CAMPAIGN_SINGLE_ADGROUP_LIMIT","INTERNAL_ERROR","NOT_FOUND","PAYMENT_ISSUE","PRODUCT_INELIGIBLE","RESOURCE_DOES_NOT_BELONG_TO_PARENT","RESOURCE_ID_NOT_FOUND","RESOURCE_IS_EMPTY","RESOURCE_IS_IN_TERMINAL_STATE","RESOURCE_IS_NULL","TOO_MANY_REQUESTS","TOTAL_RESOURCE_LIMIT_EXCEEDED","UNAUTHORIZED","UNSUPPORTED_MARKETPLACE"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"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"},"SPAdProduct":{"description":"**AdProduct Enum:**\n\n| AdProduct | Description |\n|------|------|\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |\n","enum":["SPONSORED_PRODUCTS"],"type":"string"},"SPCreateKeywordTarget":{"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/SPKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SPLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SPCreateLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"}},"required":["locationId"],"type":"object"},"SPCreateProductCategoryRefinement":{"properties":{"productAgeRangeId":{"description":"The age range ID to target.","type":"string"},"productBrandId":{"description":"The brand ID to target.","type":"string"},"productCategoryId":{"description":"The product category ID to target.","type":"string"},"productGenreId":{"description":"The product genre ID to target.","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"},"SPCreateProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPCreateProductCategoryRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"SPCreateProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPCreateProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SPCreateProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SPProductMatchType"},"product":{"$ref":"#/components/schemas/SPCreateProductValue"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"}},"required":["matchType","product","productIdType"],"type":"object"},"SPCreateProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"required":["productId"],"type":"object"},"SPCreateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**CreateState Enum:**\n| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"],"type":"string"},"SPCreateTag":{"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"},"SPCreateTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"}},"type":"object"},"SPCreateTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SPCreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SPCreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SPCreateProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SPCreateLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SPCreateThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SPCreateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SPTargetCreate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"SPCreateThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SPThemeMatchType"}},"required":["matchType"],"type":"object"},"SPCurrencyCode":{"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"},"SPDeleteTargetRequest":{"properties":{"targetIds":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIds"],"type":"object"},"SPDeliveryReason":{"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_OUT_OF_POSTPAY_CREDIT_LIMIT` | Indicates that a postpay advertiser is out of credit limit for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET` | Indicates that a postpay advertiser is out of monthly budget for all Sponsored Ads campaigns. |\n| `ADVERTISER_OUT_OF_PREPAY_BALANCE` | Indicates that a prepay advertiser is out of prepay balance for all Sponsored Ads campaigns. |\n| `ADVERTISER_PAUSED` |  |\n| `ADVERTISER_PAYMENT_FAILURE` |  |\n| `ADVERTISER_POLICING_PENDING_REVIEW` |  |\n| `ADVERTISER_POLICING_SUSPENDED` |  |\n| `AD_ARCHIVED` |  |\n| `AD_CREATION_FAILED` |  |\n| `AD_CREATION_IN_PROGRESS` |  |\n| `AD_EXTENSION_ARCHIVED` |  |\n| `AD_EXTENSION_PAUSED` |  |\n| `AD_EXTENSION_POLICING_PENDING_REVIEW` |  |\n| `AD_EXTENSION_POLICING_SUSPENDED` |  |\n| `AD_GROUP_ARCHIVED` |  |\n| `AD_GROUP_INCOMPLETE` |  |\n| `AD_GROUP_LOW_BID` |  |\n| `AD_GROUP_PAUSED` |  |\n| `AD_GROUP_PENDING_REVIEW` |  |\n| `AD_GROUP_POLICING_PENDING_REVIEW` |  |\n| `AD_GROUP_REJECTED` |  |\n| `AD_INELIGIBLE` |  |\n| `AD_MISSING_DECORATION` |  |\n| `AD_MISSING_IMAGE` |  |\n| `AD_NOT_DELIVERING` |  |\n| `AD_PAUSED` |  |\n| `AD_POLICING_PENDING_REVIEW` |  |\n| `AD_POLICING_SUSPENDED` |  |\n| `BRAND_INELIGIBLE` |  |\n| `CAMPAIGN_ARCHIVED` |  |\n| `CAMPAIGN_END_DATE_REACHED` |  |\n| `CAMPAIGN_INCOMPLETE` |  |\n| `CAMPAIGN_OUT_OF_BUDGET` |  |\n| `CAMPAIGN_PAUSED` |  |\n| `CAMPAIGN_PENDING_REVIEW` |  |\n| `CAMPAIGN_PENDING_START_DATE` |  |\n| `CAMPAIGN_REJECTED` |  |\n| `CREATIVE_MISSING_ASSET` |  |\n| `CREATIVE_PENDING_REVIEW` |  |\n| `CREATIVE_REJECTED` |  |\n| `LANDING_PAGE_INELIGIBLE` |  |\n| `LANDING_PAGE_NOT_AVAILABLE` |  |\n| `MODERATION_ADULT_NOVELTY_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION` |  |\n| `MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_NUDITY_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION` |  |\n| `MODERATION_CONTENT_SMOKING_POLICY_VIOLATION` |  |\n| `MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION` |  |\n| `MODERATION_ERROR_404` |  |\n| `MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION` |  |\n| `MODERATION_HFSS_PRODUCT_POLICY_VIOLATION` |  |\n| `MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION` |  |\n| `MODERATION_NOT_COMPLIANT_TO_AD_POLICY` |  |\n| `MODERATION_SMOKING_RELATED_POLICY_VIOLATION` |  |\n| `NOT_BUYABLE` |  |\n| `NOT_IN_BUYBOX` |  |\n| `NOT_IN_POLICY` |  |\n| `NO_INVENTORY` |  |\n| `NO_PURCHASABLE_OFFER` |  |\n| `OTHER` |  |\n| `OUT_OF_REWARD_BUDGET` |  |\n| `OUT_OF_STOCK` |  |\n| `PIR_RULE_EXCLUDED` |  |\n| `PORTFOLIO_ARCHIVED` |  |\n| `PORTFOLIO_END_DATE_REACHED` |  |\n| `PORTFOLIO_OUT_OF_BUDGET` |  |\n| `PORTFOLIO_PAUSED` |  |\n| `PORTFOLIO_PENDING_START_DATE` |  |\n| `SECURITY_SCAN_PENDING_REVIEW` |  |\n| `SECURITY_SCAN_REJECTED` |  |\n| `SPEND_LIMIT_EXCEEDED` |  |\n| `STATUS_UNAVAILABLE` |  |\n| `TARGET_ARCHIVED` |  |\n| `TARGET_BLOCKED` |  |\n| `TARGET_PAUSED` |  |\n| `TARGET_POLICING_SUSPENDED` |  |\n","enum":["ADVERTISER_ARCHIVED","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_OUT_OF_POSTPAY_CREDIT_LIMIT","ADVERTISER_OUT_OF_POSTPAY_MONTHLY_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_IN_PROGRESS","AD_EXTENSION_ARCHIVED","AD_EXTENSION_PAUSED","AD_EXTENSION_POLICING_PENDING_REVIEW","AD_EXTENSION_POLICING_SUSPENDED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_PENDING_REVIEW","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_REJECTED","AD_INELIGIBLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_DELIVERING","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","BRAND_INELIGIBLE","CAMPAIGN_ARCHIVED","CAMPAIGN_END_DATE_REACHED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_REVIEW","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_REJECTED","CREATIVE_MISSING_ASSET","CREATIVE_PENDING_REVIEW","CREATIVE_REJECTED","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MODERATION_ADULT_NOVELTY_POLICY_VIOLATION","MODERATION_ADULT_PRODUCT_POLICY_VIOLATION","MODERATION_ADULT_SOFTLINES_POLICY_VIOLATION","MODERATION_CLAIM_WEIGHTLOSS_POLICY_VIOLATION","MODERATION_CONTENT_NUDITY_POLICY_VIOLATION","MODERATION_CONTENT_PROVOCATIVE_POLICY_VIOLATION","MODERATION_CONTENT_SMOKING_POLICY_VIOLATION","MODERATION_CRITICAL_EVENTS_POLICY_VIOLATION","MODERATION_ERROR_404","MODERATION_GRAPHICAL_SEXUAL_IMAGES_POLICY_VIOLATION","MODERATION_HFSS_PRODUCT_POLICY_VIOLATION","MODERATION_LANGUAGE_OFFENSIVE_POLICY_VIOLATION","MODERATION_NOT_COMPLIANT_TO_AD_POLICY","MODERATION_SMOKING_RELATED_POLICY_VIOLATION","NOT_BUYABLE","NOT_IN_BUYBOX","NOT_IN_POLICY","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_REWARD_BUDGET","OUT_OF_STOCK","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_END_DATE_REACHED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SPEND_LIMIT_EXCEEDED","STATUS_UNAVAILABLE","TARGET_ARCHIVED","TARGET_BLOCKED","TARGET_PAUSED","TARGET_POLICING_SUSPENDED"],"type":"string"},"SPDeliveryStatus":{"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"},"SPKeywordMatchType":{"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"},"SPKeywordTarget":{"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/SPKeywordMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"$ref":"#/components/schemas/SPLanguageLocale"}},"required":["keyword","matchType"],"type":"object"},"SPLanguageLocale":{"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| `zh_CN` | Chinese (China). |\n","enum":["zh_CN"],"type":"string"},"SPLocationTarget":{"description":"Target based on geographic location.","properties":{"locationId":{"description":"The ID of the geographic location to target.","type":"string"}},"required":["locationId"],"type":"object"},"SPMarketplace":{"description":"A list of country codes representing Amazon marketplaces\n\n\n\n\n\n","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"SPMarketplaceScope":{"enum":["SINGLE_MARKETPLACE"],"type":"string"},"SPMatchType":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","enum":["BROAD","EXACT","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PHRASE","PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_SIMILAR","PRODUCT_SUBSTITUTES"],"type":"string"},"SPProductCategoryRefinement":{"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"},"productGenreId":{"description":"The product genre ID to target.","type":"string"},"productGenreIdResolved":{"description":"The resolved product genre to target.","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"},"SPProductCategoryRefinementValue":{"properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPProductCategoryRefinement"}},"required":["productCategoryRefinement"],"type":"object"},"SPProductCategoryTarget":{"description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"$ref":"#/components/schemas/SPProductCategoryRefinementValue"}},"required":["productCategoryRefinement"],"type":"object"},"SPProductIdType":{"description":"**ProductIdType Enum:**\n\n| ProductIdType | Description |\n|------|------|\n| `ASIN` | ASIN identifier type. |\n| `RETAILER_OFFER` | Retailer offer identifier type. Used for Retail Ad Service products. |\n| `SKU` | SKU identifier type. |\n","enum":["ASIN","RETAILER_OFFER","SKU"],"type":"string"},"SPProductMatchType":{"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"},"SPProductTarget":{"description":"Targets a specific product.","properties":{"matchType":{"$ref":"#/components/schemas/SPProductMatchType"},"product":{"$ref":"#/components/schemas/SPProductValue"},"productIdType":{"$ref":"#/components/schemas/SPProductIdType"},"retailerId":{"description":"The identifier of retailer whose catalog contains this product","type":"string"}},"required":["matchType","product","productIdType"],"type":"object"},"SPProductValue":{"properties":{"productId":{"description":"The product identifier. Either the product id or the marketplace settings should always be specified","type":"string"}},"required":["productId"],"type":"object"},"SPQueryTargetRequest":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SPTargetAdGroupIdFilter"},"adProductFilter":{"$ref":"#/components/schemas/SPTargetAdProductFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SPTargetCampaignIdFilter"},"keywordFilter":{"$ref":"#/components/schemas/SPTargetKeywordFilter"},"matchTypeFilter":{"$ref":"#/components/schemas/SPTargetMatchTypeFilter"},"maxResults":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"negativeFilter":{"$ref":"#/components/schemas/SPTargetNegativeFilter"},"nextToken":{"type":"string"},"productIdFilter":{"$ref":"#/components/schemas/SPTargetProductIdFilter"},"retailerIdFilter":{"$ref":"#/components/schemas/SPTargetRetailerIdFilter"},"retailerScopeFilter":{"$ref":"#/components/schemas/SPTargetRetailerScopeFilter"},"stateFilter":{"$ref":"#/components/schemas/SPTargetStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/SPTargetTargetIdFilter"},"targetTypeFilter":{"$ref":"#/components/schemas/SPTargetTargetTypeFilter"}},"required":["adProductFilter"],"type":"object"},"SPRetailerScope":{"description":"**RetailerScope Enum:**\n\n| RetailerScope | Description |\n|------|------|\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |\n","enum":["AMAZON","OTHER_RETAILERS"],"type":"string"},"SPState":{"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"},"SPStatus":{"properties":{"deliveryReasons":{"description":"This is the list of reasons behind the delivery status.","items":{"$ref":"#/components/schemas/SPDeliveryReason"},"maxItems":50,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/SPDeliveryStatus"}},"required":["deliveryStatus"],"type":"object"},"SPTag":{"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"},"SPTarget":{"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/SPAdProduct"},"bid":{"$ref":"#/components/schemas/SPTargetBid"},"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"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"lastUpdatedDateTime":{"description":"The date time the target was last updated.","format":"date-time","type":"string"},"marketplaceScope":{"$ref":"#/components/schemas/SPMarketplaceScope"},"marketplaces":{"description":"The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group","items":{"$ref":"#/components/schemas/SPMarketplace"},"maxItems":1,"minItems":1,"type":"array"},"negative":{"description":"Indicates whether the target is negative or not.","type":"boolean"},"retailerScope":{"$ref":"#/components/schemas/SPRetailerScope"},"state":{"$ref":"#/components/schemas/SPState"},"status":{"$ref":"#/components/schemas/SPStatus"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/SPTargetDetails"},"targetId":{"description":"A unique identifier for the target.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/SPTargetLevel"},"targetType":{"$ref":"#/components/schemas/SPTargetType"}},"required":["adProduct","creationDateTime","lastUpdatedDateTime","marketplaceScope","marketplaces","negative","state","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"SPTargetAdGroupIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetAdProductFilter":{"properties":{"include":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `SPONSORED_PRODUCTS` | Sponsored Products ad product. |","items":{"$ref":"#/components/schemas/SPAdProduct"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetBid":{"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","type":"number"},"currencyCode":{"$ref":"#/components/schemas/SPCurrencyCode"}},"required":["currencyCode"],"type":"object"},"SPTargetCampaignIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetCreate":{"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/SPAdProduct"},"bid":{"$ref":"#/components/schemas/SPCreateTargetBid"},"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/SPCreateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetDetails":{"$ref":"#/components/schemas/SPCreateTargetDetails"},"targetType":{"$ref":"#/components/schemas/SPTargetType"}},"required":["adProduct","negative","state","targetDetails","targetType"],"type":"object"},"SPTargetDetails":{"oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SPKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/SPLocationTarget"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/SPProductCategoryTarget"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SPProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/SPThemeTarget"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"SPTargetKeywordFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPTargetKeywordFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPTargetKeywordFilterType":{"description":"**TargetKeywordFilterType Enum:**\n| TargetKeywordFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPTargetLevel":{"description":"**TargetLevel Enum:**\n\n| TargetLevel | Description |\n|------|------|\n| `AD_GROUP` | Target applied at the ad group level. |\n| `CAMPAIGN` | Target applied at the campaign level. |\n","enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"SPTargetMatchTypeFilter":{"properties":{"include":{"description":"**MatchType Enum:**\n| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `BROAD` | Broad match search terms. This expands matching on user intent beyond PHRASE.  |\n| `EXACT` | Exact match search terms. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `PHRASE` | Phrase match search terms. This expands matching on user intent beyond EXACT. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |","items":{"$ref":"#/components/schemas/SPMatchType"},"maxItems":10,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SPTargetMultiStatusSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPTargetMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"target":{"$ref":"#/components/schemas/SPTarget"}},"required":["index","target"],"type":"object"},"SPTargetNegativeFilter":{"properties":{"include":{"items":{"type":"boolean"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetProductIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SPTargetProductIdFilterType"}},"required":["include","queryTermMatchType"],"type":"object"},"SPTargetProductIdFilterType":{"description":"**TargetProductIdFilterType Enum:**\n| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SPTargetRetailerIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetRetailerScopeFilter":{"properties":{"include":{"description":"**RetailerScope Enum:**\n| RetailerScope | Description |\n| --- | --- |\n| `AMAZON` | Ads served on Amazon-owned retail properties. |\n| `OTHER_RETAILERS` | Ads served on external retailer partner properties. |","items":{"$ref":"#/components/schemas/SPRetailerScope"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetStateFilter":{"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/SPState"},"maxItems":3,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetSuccessResponse":{"properties":{"nextToken":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SPTarget"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SPTargetTargetIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetTargetTypeFilter":{"properties":{"include":{"description":"**TargetType Enum:**\n| TargetType | Description |\n| --- | --- |\n| `KEYWORD` | Target based on customer search terms. |\n| `PRODUCT` | Target based on a specific product. |\n| `PRODUCT_CATEGORY` | Target based on a product category. |\n| `LOCATION` | Target based on geographic location. |\n| `THEME` | Target based on a keyword theme. These were formerly known as Auto Targets for Sponsored Products. |","items":{"$ref":"#/components/schemas/SPTargetType"},"maxItems":4,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"SPTargetType":{"description":"**TargetType Enum:**\n\n| TargetType | Description |\n|------|------|\n| `KEYWORD` | Target based on customer search terms. |\n| `LOCATION` | Target based on geographic location. |\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":["KEYWORD","LOCATION","PRODUCT","PRODUCT_CATEGORY","THEME"],"type":"string"},"SPTargetUpdate":{"properties":{"bid":{"$ref":"#/components/schemas/SPUpdateTargetBid"},"state":{"$ref":"#/components/schemas/SPUpdateState"},"tags":{"description":"Open ended labels with a key value pair applied to the target","items":{"$ref":"#/components/schemas/SPCreateTag"},"maxItems":50,"minItems":0,"type":"array"},"targetId":{"description":"A unique identifier for the target.","type":"string"}},"required":["targetId"],"type":"object"},"SPThemeMatchType":{"description":"**ThemeMatchType Enum:**\n\n| ThemeMatchType | Description |\n|------|------|\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you\u0027re advertising. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n","enum":["KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"],"type":"string"},"SPThemeTarget":{"description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"$ref":"#/components/schemas/SPThemeMatchType"}},"required":["matchType"],"type":"object"},"SPUpdateState":{"description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n**UpdateState Enum:**\n| UpdateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"],"type":"string"},"SPUpdateTargetBid":{"nullable":true,"properties":{"bid":{"description":"The maximum bid for a target.","format":"double","nullable":true,"type":"number"}},"type":"object"},"SPUpdateTargetRequest":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/SPTargetUpdate"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"SP Targets API","version":"3.0"},"openapi":"3.0.1","paths":{"/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":"SPCreateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPCreateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPCreateTarget 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/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":"SPDeleteTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPDeleteTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPDeleteTarget 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/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":"SPQueryTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPQueryTargetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetSuccessResponse"}}},"description":"SPQueryTarget 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/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**Note:** For Amazon DSP, `state` supports only ENABLED and ARCHIVED; PAUSED is not a valid state for DSP targets.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"SPUpdateTarget","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPUpdateTargetRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetMultiStatusResponse"}}},"description":"SPUpdateTarget 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"}]}