{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessDeniedException":{"description":"Returns information about an AccessDeniedException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"AdGroup":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"asins":{"description":"The list of ad ASINs in the ad group.","items":{"pattern":"[a-zA-Z0-9]{10}","type":"string"},"maxItems":50,"minItems":1,"type":"array"},"targetingExpressions":{"description":"The list of targeting expressions. Maximum of 100 per request.","items":{"$ref":"#/components/schemas/TargetingExpression"},"maxItems":100,"minItems":1,"type":"array"}},"required":["asins","targetingExpressions"]},"AdGroupBasedRequest":{"allOf":[{"$ref":"#/components/schemas/RecommendationOptions"}],"properties":{"adGroupId":{"description":"The identifier of the ad group","type":"string"},"bidsEnabled":{"default":"true","description":"Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true.","type":"boolean"},"campaignId":{"description":"The identifier of the campaign","type":"string"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for an existing ad group.","enum":["KEYWORDS_FOR_ADGROUP"],"type":"string"}}},"AdGroupKeywordTargetRankRecommendationRequest":{"allOf":[{"$ref":"#/components/schemas/KeywordTargetRankRecommendationRequest"}],"description":"This request type is used to retrieve recommended keyword targets for an existing ad group. Set the recommendationType to KEYWORDS_FOR_ADGROUP to use this request type.","properties":{"adGroupId":{"description":"The identifier of the ad group","type":"string"},"campaignId":{"description":"The identifier of the campaign","type":"string"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for an existing ad group.","enum":["KEYWORDS_FOR_ADGROUP"],"type":"string"}},"required":["adGroupId","campaignId","recommendationType"]},"AdGroupThemeBasedBidRecommendationRequest":{"example":{"adGroupId":"EFGH5678","campaignId":"ABCD1234","recommendationType":"BIDS_FOR_EXISTING_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_EXISTING_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionList"}},"required":["adGroupId","campaignId","recommendationType","targetingExpressions"],"type":"object"},"AdGroupThemeBasedBidRecommendationRequestV4":{"example":{"adGroupId":"EFGH5678","campaignId":"ABCD1234","recommendationType":"BIDS_FOR_EXISTING_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_EXISTING_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionListV4"}},"required":["adGroupId","campaignId","recommendationType","targetingExpressions"],"type":"object"},"AdGroupThemeBasedBidRecommendationRequestV5":{"example":{"adGroupId":"EFGH5678","campaignId":"ABCD1234","includeAnalysis":"true","recommendationType":"BIDS_FOR_EXISTING_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"includeAnalysis":{"default":"false","description":"Flag to include new bid analyzer data.","type":"boolean"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_EXISTING_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionListV4"}},"required":["adGroupId","campaignId","recommendationType","targetingExpressions"],"type":"object"},"Adjustment":{"properties":{"placementAdjustment":{"$ref":"#/components/schemas/PlacementAdjustment"}}},"AgeRange":{"properties":{"id":{"description":"Id of Age Range. This field is REQUIRED if the Age Range object is being used as an input. Use the GetRefinementsForCategory to retrieve Age Range Node IDs.","type":"string"},"name":{"description":"Name of Age Range. This field is OPTIONAL if the Age Range object is being used as an input.","type":"string"}},"type":"object"},"AgeRangeLoP":{"properties":{"id":{"description":"Id of Age Range. Use the POST /sp/targets/category/{categoryId}/refinements endpoint to retrieve Age Range Node IDs.","type":"string"},"name":{"description":"Name of Age Range.","type":"string"},"translatedName":{"description":"Translated name of Age Range based off locale sent in request.","type":"string"}},"type":"object"},"AgeRanges":{"description":"List of Age Ranges. Use the GetRefinementsForCategory to retrieve Age Ranges. Age Ranges are only available for categories related to children\u0027s toys and games.","items":{"$ref":"#/components/schemas/AgeRange"},"type":"array"},"AgeRangesLoP":{"description":"List of Age Ranges in a language of preference (LoP). Use the POST /sp/targets/category/{categoryId}/refinements endpoint to retrieve Age Ranges. Age Ranges are only available for categories related to children\u0027s toys and games.","items":{"$ref":"#/components/schemas/AgeRangeLoP","maxItems":15,"minItems":0},"type":"array"},"AsinsBasedRequest":{"allOf":[{"$ref":"#/components/schemas/RecommendationOptions"}],"properties":{"biddingStrategy":{"default":"LEGACY_FOR_SALES","description":"The bid recommendations returned will depend on the bidding strategy. \u003cbr\u003e LEGACY_FOR_SALES - Dynamic Bids (Down only) \u003cbr\u003e AUTO_FOR_SALES - Dynamic Bids (Up or down) \u003cbr\u003e MANUAL - Fixed Bids","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"type":"string"},"bidsEnabled":{"default":"true","description":"Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true.","type":"boolean"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for a list of ASINs.","enum":["KEYWORDS_FOR_ASINS"],"type":"string"}}},"AsinsKeywordTargetRankRecommendationRequest":{"allOf":[{"$ref":"#/components/schemas/KeywordTargetRankRecommendationRequest"}],"description":"This request type is used to retrieve recommended keyword targets for ASINs. Set the recommendationType to KEYWORDS_FOR_ASINS to use this request type.","properties":{"asins":{"description":"An array list of Asins","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for a list of ASINs.","enum":["KEYWORDS_FOR_ASINS"],"type":"string"}},"required":["asins","recommendationType"]},"AsinsThemeBasedBidRecommendationRequest":{"example":{"asins":["asin1","asin2"],"bidding":{"adjustments":[{"percentage":"100","predicate":"PLACEMENT_TOP"},{"percentage":"75","predicate":"PLACEMENT_REST_OF_SEARCH"},{"percentage":"50","predicate":"PLACEMENT_PRODUCT_PAGE"}],"strategy":"AUTO_FOR_SALES"},"recommendationType":"BIDS_FOR_NEW_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"asins":{"description":"The list of ad ASINs in the ad group.","items":{"type":"string"},"maxItems":50,"type":"array"},"bidding":{"description":"Bidding control configuration for the campaign.","properties":{"adjustments":{"description":"Placement adjustment configuration for the campaign.","items":{"$ref":"#/components/schemas/PlacementAdjustment"},"maxItems":3,"type":"array"},"strategy":{"$ref":"#/components/schemas/BiddingStrategy"}},"required":["strategy"],"type":"object"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_NEW_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionList"}},"required":["asins","bidding","recommendationType","targetingExpressions"],"type":"object"},"AsinsThemeBasedBidRecommendationRequestV4":{"example":{"asins":["asin1","asin2"],"bidding":{"adjustments":[{"percentage":"100","predicate":"PLACEMENT_TOP"},{"percentage":"75","predicate":"PLACEMENT_REST_OF_SEARCH"},{"percentage":"50","predicate":"PLACEMENT_PRODUCT_PAGE"}],"strategy":"AUTO_FOR_SALES"},"productDetailsList":[{"asin":"asin1","globalStoreSetting":{"catalogSourceCountryCode":"US"}},{"asin":"asin2","globalStoreSetting":{"catalogSourceCountryCode":"UK"}}],"recommendationType":"BIDS_FOR_NEW_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"asins":{"description":"The list of ad ASINs in the ad group.","items":{"type":"string"},"maxItems":50,"type":"array"},"bidding":{"description":"Bidding control configuration for the campaign.","properties":{"adjustments":{"description":"Placement adjustment configuration for the campaign.","items":{"$ref":"#/components/schemas/PlacementAdjustment"},"maxItems":3,"type":"array"},"strategy":{"$ref":"#/components/schemas/BiddingStrategy"}},"required":["strategy"],"type":"object"},"productDetailsList":{"description":"The list of products in the request, required for GlobalStore ASINs.","items":{"$ref":"#/components/schemas/ProductDetails"},"maxItems":50,"type":"array"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_NEW_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionListV4"}},"required":["asins","bidding","recommendationType","targetingExpressions"],"type":"object"},"AsinsThemeBasedBidRecommendationRequestV5":{"example":{"asins":["asin1","asin2"],"bidding":{"adjustments":[{"percentage":"100","predicate":"PLACEMENT_TOP"},{"percentage":"75","predicate":"PLACEMENT_REST_OF_SEARCH"},{"percentage":"50","predicate":"PLACEMENT_PRODUCT_PAGE"}],"strategy":"AUTO_FOR_SALES"},"includeAnalysis":"true","productDetailsList":[{"asin":"asin1","globalStoreSetting":{"catalogSourceCountryCode":"US"}},{"asin":"asin2","globalStoreSetting":{"catalogSourceCountryCode":"UK"}}],"recommendationType":"BIDS_FOR_NEW_AD_GROUP","targetingExpressions":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}]},"properties":{"asins":{"description":"The list of ad ASINs in the ad group.","items":{"type":"string"},"maxItems":50,"type":"array"},"bidding":{"description":"Bidding control configuration for the campaign.","properties":{"adjustments":{"description":"Placement adjustment configuration for the campaign.","items":{"$ref":"#/components/schemas/PlacementAdjustment"},"maxItems":3,"type":"array"},"strategy":{"$ref":"#/components/schemas/BiddingStrategy"}},"required":["strategy"],"type":"object"},"includeAnalysis":{"default":"false","description":"Flag to include new bid analyzer data.","type":"boolean"},"productDetailsList":{"description":"The list of products in the request, required for GlobalStore ASINs.","items":{"$ref":"#/components/schemas/ProductDetails"},"maxItems":50,"type":"array"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_NEW_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/TargetingExpressionListV4"}},"required":["asins","bidding","recommendationType","targetingExpressions"],"type":"object"},"AssociatedBudgetRuleResponse":{"properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The budget rule identifier.","type":"string"}},"type":"object"},"AssociatedCampaign":{"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"campaignName":{"description":"The campaign name.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status for this campaign. Read-only.","type":"string"}},"required":["campaignId","campaignName","ruleStatus"],"type":"object"},"AudienceSegment":{"properties":{"audienceId":{"description":"Unique identifier for the audience segment.","type":"string"},"audienceSegmentType":{"description":"Type of audience segment.","enum":["BEHAVIOR_DYNAMIC","SPONSORED_ADS_AMC"],"type":"string"}},"required":["audienceId","audienceSegmentType"],"type":"object"},"BadRequestException":{"description":"Returns information about a BadRequestException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"Benchmark":{"description":"Forecasted impact metrics for next 7 days or during special days.","properties":{"benchmarkStatus":{"description":"Specifies the processing status of the benchmark. Success - If all fields in values property (impressions, clicks, conversions) have all non-null values. Failed - If all fields in values property have all null values. Partial - If some of the fields (impressions, clicks, or conversions) in values property have null values.","enum":["failed","partial","success"],"type":"string"},"values":{"$ref":"#/components/schemas/Values"}}},"BidAnalyses":{"items":{"$ref":"#/components/schemas/BidAnalysis"},"maxItems":10,"minItems":0,"type":"array"},"BidAnalysesPerPlacement":{"properties":{"ALL":{"$ref":"#/components/schemas/BidAnalyses"},"PLACEMENT_PRODUCT_PAGE":{"$ref":"#/components/schemas/BidAnalyses"},"PLACEMENT_REST_OF_SEARCH":{"$ref":"#/components/schemas/BidAnalyses"},"PLACEMENT_TOP":{"$ref":"#/components/schemas/BidAnalyses"}},"required":["ALL","PLACEMENT_PRODUCT_PAGE","PLACEMENT_REST_OF_SEARCH","PLACEMENT_TOP"],"type":"object"},"BidAnalysesPerTargetingExpression":{"properties":{"bidAnalyses":{"$ref":"#/components/schemas/BidAnalysesPerPlacement"},"targetingExpression":{"$ref":"#/components/schemas/TargetingExpressionV4"}},"required":["bidAnalyses","targetingExpression"],"type":"object"},"BidAnalysis":{"properties":{"bid":{"format":"double","minimum":0,"type":"number"},"impactMetrics":{"$ref":"#/components/schemas/BidAnalysisImpactMetrics"},"type":{"description":"The type of bids in bid analyses. \u003cbr\u003e`SUGGESTED_UPPER` - The upper bound for the suggested bid. \u003cbr\u003e`SUGGESTED_LOWER` - The lower bound for the suggested bid. \u003cbr\u003e`SUGGESTED` - The suggested bid value. \u003cbr\u003e\u0027ALTERNATIVE\u0027 - The alternative bids that is included in the bid analyses.","enum":["ALTERNATIVE","SUGGESTED","SUGGESTED_LOWER","SUGGESTED_UPPER"],"type":"string"}},"required":["bid","impactMetrics","type"],"type":"object"},"BidAnalysisImpactMetrics":{"properties":{"estimatedImpressionAvg":{"description":"Number indicating the average of the estimated impressions","type":"integer"},"estimatedImpressionLower":{"description":"Number indicating a lower bound of the estimated impressions","type":"integer"},"estimatedImpressionUpper":{"description":"Number indicating an upper bound of the estimated impressions","type":"integer"}},"required":["estimatedImpressionAvg","estimatedImpressionLower","estimatedImpressionUpper"],"type":"object"},"BidPlacementAdjustment":{"description":"Specifies bid adjustments based on the placement location. Use `PLACEMENT_TOP` for the top of the search page. Use `PLACEMENT_REST_OF_SEARCH` for the rest of the search page. Use `PLACEMENT_PRODUCT_PAGE` for a product page.","example":{"percentage":"100","predicate":"PLACEMENT_TOP"},"properties":{"percentage":{"maximum":900,"minimum":0,"type":"integer"},"predicate":{"enum":["PLACEMENT_PRODUCT_PAGE","PLACEMENT_REST_OF_SEARCH","PLACEMENT_TOP"],"type":"string"}},"type":"object"},"BidRecommendationError":{"properties":{"code":{"description":"A machine-readable error code.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"],"type":"object"},"BidRecommendationPerTargetingExpression":{"example":{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},"properties":{"bidValues":{"items":{"$ref":"#/components/schemas/BidValue"},"maxItems":3,"type":"array"},"targetingExpression":{"$ref":"#/components/schemas/TargetingExpression"}},"required":["bidValues","targetingExpression"],"type":"object"},"BidRecommendationPerTargetingExpressionV4":{"example":{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},"properties":{"bidValues":{"items":{"$ref":"#/components/schemas/BidValue"},"maxItems":3,"type":"array"},"targetingExpression":{"$ref":"#/components/schemas/TargetingExpressionV4"}},"required":["bidValues","targetingExpression"],"type":"object"},"BidRecommendationPerTargetingExpressionV5":{"example":{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"targetingExpression":{"type":"CLOSE_MATCH"}},"properties":{"bidValues":{"items":{"$ref":"#/components/schemas/BidValue"},"maxItems":3,"type":"array"},"suggestedBidImpactMetrics":{"nullable":true,"properties":{"estimatedImpressionLower":{"type":"integer"},"estimatedImpressionUpper":{"type":"integer"}}},"targetingExpression":{"$ref":"#/components/schemas/TargetingExpressionV4"}},"required":["bidValues","targetingExpression"],"type":"object"},"BidSuggestion":{"description":"Suggested bid range in major and minor currency units (example: dollars and cents).","properties":{"bidRecId":{"description":"The bid recommendation id","type":"string"},"rangeEnd":{"description":"The bid range end","format":"double","type":"number"},"rangeStart":{"description":"The bid range start","format":"double","type":"number"},"suggested":{"description":"The suggested bid","format":"double","type":"number"}}},"BidValue":{"description":"Bid value of the bid recommendations.","example":{"suggestedBid":"1.2"},"properties":{"suggestedBid":{"description":"The suggested bid.","format":"double","minimum":0,"type":"number"}},"required":["suggestedBid"],"type":"object"},"BidValues":{"description":"Suggested bid range","properties":{"rangeEnd":{"description":"The bid range end","format":"double","type":"number"},"rangeStart":{"description":"The bid range start","format":"double","type":"number"},"suggested":{"description":"The suggested bid","format":"double","type":"number"}}},"Bidding":{"description":"The bidding control configuration for the new campaign.","properties":{"adjustments":{"description":"Placement adjustment configuration for the campaign.","items":{"$ref":"#/components/schemas/Adjustment"},"maxItems":2,"minItems":0,"type":"array"},"strategy":{"description":"The bidding strategy selected for the campaign. Use LEGACY_FOR_SALES to lower your bid in real time when your ad may be less likely to convert to a sale. Use AUTO_FOR_SALES to increase your bid in real time when your ad may be more likely to convert to a sale or lower your bid when less likely to convert to a sale. Use MANUAL to use your exact bid along with any manual adjustments.","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"type":"string"}},"required":["strategy"]},"BiddingStrategy":{"description":"The bidding strategy selected for the campaign. Use `LEGACY_FOR_SALES` to lower your bid in real time when your ad may be less likely to convert to a sale. Use `AUTO_FOR_SALES` to increase your bid in real time when your ad may be more likely to convert to a sale or lower your bid when less likely to convert to a sale. Use `MANUAL` to use your exact bid along with any manual adjustments.","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"example":"AUTO_FOR_SALES","type":"string"},"BiddingStrategyRecommendation":{"description":"Contains suggested recommendation for the campaign bidding strategy.","properties":{"action":{"description":"Type of suggested action.","enum":["UPDATE"],"type":"string"},"suggestedBiddingStrategy":{"description":"The suggested bidding strategy value for the campaign.\n| Value | Strategy name | Description |\n|----------------|---------------|-------------|\n| `LEGACY_FOR_SALES` | Dynamic bids - down only | Lowers your bids in real time when your ad may be less likely to convert to a sale. Campaigns created before the release of the bidding controls feature used this setting by default. |\n| `AUTO_FOR_SALES` | Dynamic bids - up and down | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `MANUAL` | Fixed bid | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL"],"type":"string"}},"type":"object"},"Brand":{"properties":{"id":{"description":"Id of brand. This field is REQUIRED if the Brand object is being used as an input. Use the GetRefinementsForCategory to retrieve Brand Node IDs.","type":"string"},"name":{"description":"Name of brand. This field is OPTIONAL if the Brand object is being used as an input.","type":"string"}},"type":"object"},"BrandLoP":{"properties":{"id":{"description":"Id of brand.","type":"string"},"name":{"description":"Name of brand.","type":"string"}},"type":"object"},"Brands":{"description":"List of Brands.","items":{"$ref":"#/components/schemas/Brand"},"type":"array"},"BrandsLoP":{"description":"List of Brands.","items":{"$ref":"#/components/schemas/BrandLoP"},"type":"array"},"BudgetChangeType":{"description":"The value by which to update the budget of the budget rule.","enum":["PERCENT"],"type":"string"},"BudgetRecommendation":{"description":"Contains suggested recommendation for the campaign budget.","properties":{"action":{"description":"Type of suggested action.","enum":["DECREASE","INCREASE"],"type":"string"},"suggestedBudget":{"description":"The suggested budget value for the campaign.","format":"double","type":"number"}},"type":"object"},"BudgetRecommendationError":{"properties":{"Error":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"},"campaignId":{"description":"encrypted campaignId","type":"string"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based","type":"integer"}},"required":["Error","campaignId","index"],"type":"object"},"BudgetRecommendationForExistingCampaign":{"properties":{"budgetRuleRecommendation":{"$ref":"#/components/schemas/BudgetRuleRecommendation"},"campaignId":{"description":"encrypted campaignId","type":"string"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based","type":"integer"},"sevenDaysMissedOpportunities":{"$ref":"#/components/schemas/SevenDaysMissedOpportunities"},"suggestedBudget":{"description":"recommended budget for the campaign.","type":"number"}},"required":["budgetRuleRecommendation","campaignId","index","sevenDaysMissedOpportunities","suggestedBudget"],"type":"object"},"BudgetRecommendationNewCampaignsErrorMessage":{"type":"string"},"BudgetRecommendationNewCampaignsException":{"properties":{"message":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsErrorMessage"}},"type":"object"},"BudgetRecommendationRequest":{"properties":{"campaignIds":{"description":"List of campaigns.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"},"BudgetRecommendationResponse":{"example":{"budgetRecommendationsErrorResults":[{"Error":{"code":"400","details":"Bad Request."},"campaignId":"A1N2ZCAWZZAX89","index":2}],"budgetRecommendationsSuccessResults":[{"campaignId":"A3REPY26ZX1BSY","index":1,"sevenDaysMissedOpportunities":{"endDate":"20200807","estimatedMissedClicksLower":3,"estimatedMissedClicksUpper":7,"estimatedMissedImpressionsLower":1,"estimatedMissedImpressionsUpper":5,"estimatedMissedSalesLower":105.5,"estimatedMissedSalesUpper":130.5,"percentTimeInBudget":80,"startDate":"20200801"},"suggestedBudget":3},{"budgetRuleRecommendation":{"ruleId":"123","ruleName":"sample rule","suggestedBudgetIncreasePercent":5},"campaignId":"A7X89CAWZZAX89","index":3,"sevenDaysMissedOpportunities":{"endDate":"20200807","estimatedMissedClicksLower":1,"estimatedMissedClicksUpper":3,"estimatedMissedImpressionsLower":3,"estimatedMissedImpressionsUpper":8,"estimatedMissedSalesLower":78.5,"estimatedMissedSalesUpper":98.5,"percentTimeInBudget":65.2,"startDate":"20200801"},"suggestedBudget":"-1"}]},"properties":{"budgetRecommendationsErrorResults":{"description":"List of errors that occured when generating bduget recommendation.","items":{"$ref":"#/components/schemas/BudgetRecommendationError"},"type":"array"},"budgetRecommendationsSuccessResults":{"description":"List of successful budget recomendation for campagins.","items":{"$ref":"#/components/schemas/BudgetRecommendationForExistingCampaign"},"type":"array"}},"required":["budgetRecommendationsErrorResults","budgetRecommendationsSuccessResults"],"type":"object"},"BudgetRuleError":{"description":"The Error Response Object.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"BudgetRuleRecommendation":{"properties":{"ruleId":{"description":"rule id for the recomemendation","type":"string"},"ruleName":{"description":"rule name for the recomemendation","type":"string"},"suggestedBudgetIncreasePercent":{"description":"suggested increase percent","type":"number"}},"type":"object"},"BudgetRuleResponse":{"properties":{"associatedCampaignIds":{"items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"},"type":"array"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"}},"type":"object"},"BudgetRulesRelations":{"properties":{"budgetRuleId":{"description":"The rule identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"}},"required":["budgetRuleId","campaignId"],"type":"object"},"BudgetUsageCampaign":{"properties":{"budget":{"description":"Budget amount of resource requested","type":"number"},"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"campaignId":{"description":"ID of requested resource","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"usageUpdatedTimestamp":{"description":"Last evaluation time for budget usage","format":"date-time","type":"string"}},"type":"object"},"BudgetUsageCampaignBatchError":{"properties":{"campaignId":{"description":"ID of requested resource","type":"string"},"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"}},"type":"object"},"BudgetUsageCampaignRequest":{"properties":{"campaignIds":{"description":"A list of campaign IDs","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"BudgetUsageCampaignResponse":{"properties":{"error":{"description":"List of budget usage percentages that failed to pull","items":{"$ref":"#/components/schemas/BudgetUsageCampaignBatchError"},"type":"array"},"success":{"description":"List of budget usage percentages that were successfully pulled","items":{"$ref":"#/components/schemas/BudgetUsageCampaign"},"type":"array"}},"type":"object"},"BudgetUsageError":{"description":"The Error Response Object.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"BulkBudgetRulesAssociationRequest":{"properties":{"budgetRulesAssociations":{"description":"A list of budget rule campaign details.","items":{"$ref":"#/components/schemas/BudgetRulesRelations"},"maxItems":50,"type":"array"}},"type":"object"},"BulkBudgetRulesAssociationResponse":{"properties":{"budgetRulesAssociations":{"properties":{"errorList":{"items":{"$ref":"#/components/schemas/BulkBudgetRulesRelationsResponse"},"type":"array"},"successList":{"items":{"$ref":"#/components/schemas/BulkBudgetRulesRelationsResponse"},"type":"array"}},"type":"object"}},"type":"object"},"BulkBudgetRulesDisAssociationRequest":{"properties":{"budgetRulesDisAssociations":{"description":"A list of budget rule campaign details.","items":{"$ref":"#/components/schemas/BudgetRulesRelations"},"maxItems":50,"type":"array"}},"type":"object"},"BulkBudgetRulesDisAssociationResponse":{"properties":{"budgetRulesDisAssociations":{"properties":{"errorList":{"items":{"$ref":"#/components/schemas/BulkBudgetRulesRelationsResponse"},"type":"array"},"successList":{"items":{"$ref":"#/components/schemas/BulkBudgetRulesRelationsResponse"},"type":"array"}},"type":"object"}},"type":"object"},"BulkBudgetRulesRelationsResponse":{"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"index":{"description":"The index of the request in the bulk request.","type":"integer"},"ruleId":{"description":"The budget rule identifier.","type":"string"}},"type":"object"},"Campaign":{"properties":{"campaignId":{"description":"The identifier of the campaign.","type":"string"},"recommendationType":{"$ref":"#/components/schemas/RecommendationType"}},"required":["campaignId","recommendationType"],"type":"object"},"CampaignOptimizationRule":{"properties":{"campaignIds":{"items":{"$ref":"#/components/schemas/RuleCampaignId"},"maxItems":100,"type":"array"},"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"createdDate":{"$ref":"#/components/schemas/RuleCreationDate"},"recurrence":{"$ref":"#/components/schemas/RecurrenceType"},"ruleAction":{"$ref":"#/components/schemas/RuleAction"},"ruleCondition":{"$ref":"#/components/schemas/RuleConditionList"},"ruleName":{"$ref":"#/components/schemas/RuleName"},"ruleStatus":{"$ref":"#/components/schemas/RuleStatus"},"ruleType":{"$ref":"#/components/schemas/RuleType"}},"required":["campaignOptimizationId"],"type":"object"},"CampaignOptimizationRuleError":{"description":"The Error Response Object.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"CampaignRecommendation":{"description":"This object contains a set of recommendations for a campaign across bid, budget, targeting.","properties":{"biddingStrategyRecommendation":{"$ref":"#/components/schemas/BiddingStrategyRecommendation"},"budgetRecommendation":{"$ref":"#/components/schemas/BudgetRecommendation"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"keywordTargetingRecommendations":{"items":{"$ref":"#/components/schemas/KeywordTargetingRecommendation"},"maxItems":50,"minItems":0,"type":"array"},"placementBiddingRecommendations":{"items":{"$ref":"#/components/schemas/PlacementBiddingRecommendation"},"maxItems":50,"minItems":0,"type":"array"},"sevenDaysEstimatedOpportunities":{"$ref":"#/components/schemas/SevenDaysEstimatedOpportunities"},"targetingGroupBidRecommendations":{"items":{"$ref":"#/components/schemas/TargetingGroupBidRecommendation"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"CategoryItem":{"properties":{"canBeTargeted":{"description":"A flag which indicates if the current node may be targeted","type":"boolean"},"id":{"description":"The category id of the current node","type":"string"},"name":{"description":"The name of the category","type":"string"},"parent":{"description":"The category id of the parent node","type":"string"},"path":{"description":"The path of the category, which contains the current category and all parent categories","type":"string"}},"type":"object"},"CategoryItemWithAsinCounts":{"properties":{"asinCounts":{"$ref":"#/components/schemas/IntegerRange","description":"An integer range between min and max"},"categoryPath":{"description":"The path of the category, which contains the current category and all parent categories","type":"string"},"id":{"description":"The category id of the current node","type":"string"},"name":{"description":"The name of the category","type":"string"},"parentCategoryId":{"description":"The category id of the parent node","type":"string"}},"type":"object"},"CategoryItemWithAsinCountsLoP":{"properties":{"asinCounts":{"$ref":"#/components/schemas/IntegerRange","description":"The number of asins belonging to the category."},"categoryPath":{"description":"The path of the category, which contains the current category and all parent categories","type":"string"},"id":{"description":"The category id of the current node","type":"string"},"name":{"description":"The name of the category","type":"string"},"parentCategoryId":{"description":"The category id of the parent node","type":"string"},"translatedCategoryPath":{"description":"The translated path of the category, which contains the current category and all parent categories.","type":"string"},"translatedName":{"description":"The translated name of the category.","type":"string"}},"type":"object"},"CategoryRecommendations":{"description":"Response object for the GetCategoryRecommendationsForAsins API.","properties":{"categories":{"description":"List of category recommendations","items":{"$ref":"#/components/schemas/CategoryItem"},"type":"array"}},"type":"object"},"CategoryRecommendationsWithAsinCounts":{"description":"Response object for the GetCategoryRecommendationsForAsins API.","properties":{"categories":{"description":"List of category recommendations","items":{"$ref":"#/components/schemas/CategoryItemWithAsinCounts"},"type":"array"}},"type":"object"},"CategoryRecommendationsWithAsinCountsLoP":{"description":"Response object for the GetCategoryRecommendationsForAsins API.","properties":{"categories":{"description":"List of category recommendations","items":{"$ref":"#/components/schemas/CategoryItemWithAsinCountsLoP","maxItems":50,"minItems":0},"type":"array"}},"type":"object"},"Clicks":{"description":"Clicks benchmark.","properties":{"lower":{"description":"lower bound.","type":"integer"},"upper":{"description":"upper bound.","type":"integer"}}},"ComparisonOperator":{"description":"The comparison operator.","enum":["EQUAL_TO","GREATER_THAN","GREATER_THAN_OR_EQUAL_TO","LESS_THAN","LESS_THAN_OR_EQUAL_TO"],"type":"string"},"Conversions":{"description":"Conversions benchmark.","properties":{"lower":{"description":"lower bound.","type":"integer"},"upper":{"description":"upper bound.","type":"integer"}}},"CountryCodes":{"description":"A list of country codes. Supported country codes:\n| Country Code |  Country            |\n|-------------|----------------------|\n| US          | United States        |\n| CA          | Canada               |\n| MX          | Mexico               |\n| BR          | Brazil               |\n| UK          | United Kingdom       |\n| DE          | Germany              |\n| FR          | France               |\n| ES          | Spain                |\n| IT          | Italy                |\n| IN          | India                |\n| AE          | United Arab Emirates |\n| SA          | Saudi Arabia         |\n| NL          | Netherlands          |\n| PL          | Poland               |\n| BE          | Belgium              |\n| SE          | Sweden               |\n| TR          | Turkey               |\n| EG          | Egypt                |\n| JP          | Japan                |\n| AU          | Australia            |\n| SG          | Singapore            |","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array","uniqueItems":true},"CountryKeyword":{"properties":{"bid":{"description":"The bid value for the keyword, in minor currency units (example: cents). The default value will be the suggested bid.","format":"double","type":"number"},"userSelectedKeyword":{"description":"Flag that tells if keyword was selected by the user or was recommended by KRS","type":"boolean"},"value":{"description":"The keyword value","type":"string"}}},"CountryTarget":{"properties":{"countryKeywords":{"additionalProperties":{"$ref":"#/components/schemas/CountryKeyword"},"description":"Map represents the same keyword in a different countries and locales. Key is a 2-letter country code, value is a keyword object with value and bid fields","type":"object"},"matchType":{"description":"Keyword match type. The default value will be BROAD.","enum":["BROAD","EXACT","PHRASE"],"type":"string"}},"type":"object"},"CreateAssociatedBudgetRulesRequest":{"properties":{"budgetRuleIds":{"description":"A list of budget rule identifiers.","items":{"type":"string"},"maxItems":25,"type":"array"}},"type":"object"},"CreateAssociatedBudgetRulesResponse":{"properties":{"responses":{"items":{"$ref":"#/components/schemas/AssociatedBudgetRuleResponse"},"type":"array"}},"type":"object"},"CreateBudgetRulesResponse":{"properties":{"responses":{"items":{"$ref":"#/components/schemas/BudgetRuleResponse"},"type":"array"}},"type":"object"},"CreateSPBudgetRulesRequest":{"properties":{"budgetRulesDetails":{"description":"A list of budget rule details.","items":{"$ref":"#/components/schemas/SPBudgetRuleDetails"},"maxItems":25,"type":"array"}},"type":"object"},"CreateSPCampaignOptimizationRulesRequest":{"example":{"campaignIds":["1223785","123784"],"recurrence":"DAILY","ruleAction":"ADOPT","ruleCondition":[{"comparisonOperator":"GREATER_THAN","metricName":"ROAS","threshold":"4"}],"ruleName":"RuleROAS4","ruleType":"BID"},"properties":{"campaignIds":{"description":"A list of campaign ids","items":{"$ref":"#/components/schemas/RuleCampaignId"},"maxItems":20,"type":"array"},"recurrence":{"$ref":"#/components/schemas/RecurrenceType"},"ruleAction":{"$ref":"#/components/schemas/RuleAction"},"ruleCondition":{"$ref":"#/components/schemas/RuleConditionList"},"ruleName":{"$ref":"#/components/schemas/RuleName"},"ruleType":{"$ref":"#/components/schemas/RuleType"}},"required":["campaignIds","recurrence","ruleAction","ruleType"],"type":"object"},"CreateSPCampaignOptimizationRulesResponse":{"properties":{"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"}},"type":"object"},"DateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}},"required":["startDate"],"type":"object"},"DayOfWeek":{"description":"The day of the week.","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"type":"string"},"DeleteSPCampaignOptimizationRuleResponse":{"properties":{"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"}},"type":"object"},"DisassociateAssociatedBudgetRuleResponse":{"type":"object"},"EventTypeRuleDuration":{"description":"Object representing event type rule duration.","properties":{"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}},"required":["eventId"],"type":"object"},"ForecastEstimates":{"properties":{"endDate":{"description":"End date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","type":"string"},"estimatedAdSpendLower":{"description":"Lower estimated ad spend for the campaign.","format":"double","type":"number"},"estimatedAdSpendUpper":{"description":"Upper estimated ad spend for the campaign.","format":"double","type":"number"},"estimatedIncrementalClicksLower":{"description":"Lower bound of the estimated incremental clicks that could be gained if all optimizations are made.","type":"integer"},"estimatedIncrementalClicksUpper":{"description":"Upper bound of the estimated incremental clicks that could be gained if all optimizations are made.","type":"integer"},"estimatedIncrementalConversionsLower":{"description":"Lower estimated incremental number of conversions for the campaign.","type":"integer"},"estimatedIncrementalConversionsUpper":{"description":"Upper estimated incremental number of conversions for the campaign.","type":"integer"},"estimatedIncrementalImpressionsLower":{"description":"Lower estimated incremental number of impressions for the campaign.","type":"integer"},"estimatedIncrementalImpressionsUpper":{"description":"Upper estimated incremental number of impressions for the campaign.","type":"integer"},"estimatedIncrementalSalesLower":{"description":"Lower estimated incremental sales for the campaign.","format":"double","type":"number"},"estimatedIncrementalSalesUpper":{"description":"Upper estimated incremental sales for the campaign.","format":"double","type":"number"},"startDate":{"description":"Start date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","type":"string"}}},"Genre":{"properties":{"id":{"description":"Id of Genre. This field is REQUIRED if the Genre object is being used as an input. Use the GetRefinementsForCategory to retrieve Genre Node IDs.","type":"string"},"name":{"description":"Name of Genre. This field is OPTIONAL if the Genre object is being used as an input.","type":"string"}},"type":"object"},"GenreLoP":{"properties":{"id":{"description":"Id of Genre. Use the POST /sp/targets/category/{categoryId}/refinements endpoint to retrieve Genre Node IDs.","type":"string"},"name":{"description":"Name of Genre.","type":"string"},"translatedName":{"description":"Translated name of the Genre based off locale send in the query parameter.","type":"string"}},"type":"object"},"Genres":{"description":"List of Genres. Use the GetRefinementsForCategory to retrieve Genre Node IDs. Genres are only available for categories related to books.","items":{"$ref":"#/components/schemas/Genre"},"type":"array"},"GenresLoP":{"description":"List of Genres in a language of preference (LoP). Use the POST /sp/targets/category/{categoryId}/refinements endpoint to retrieve Genre Node IDs. Genres are only available for categories related to books.","items":{"$ref":"#/components/schemas/GenreLoP","maxItems":300,"minItems":0},"type":"array"},"GetCampaignRecommendationsRequestV2":{"properties":{"campaigns":{"description":"List of campaigns with specific recommendation types requested.","items":{"$ref":"#/components/schemas/Campaign"},"maxItems":10,"minItems":1,"type":"array"},"maxResults":{"default":"1","description":"Optional. Limits the number of items to return in the response.","maximum":5,"minimum":1,"type":"integer"},"nextToken":{"description":"Optional. Token to retrieve subsequent page of results.","type":"string"}},"required":["campaigns"],"type":"object"},"GetCampaignRecommendationsResponse":{"properties":{"nextToken":{"description":"An identifier to fetch next set of campaign recommendations records in the result set if available. This will be null when at the end of result set.","example":"MTAxNTExtY5NDE\u003d","type":"string"},"recommendations":{"description":"List of campaign recommendations.","items":{"$ref":"#/components/schemas/CampaignRecommendation"},"maxItems":50,"minItems":0,"type":"array"}},"required":["recommendations"],"type":"object"},"GetCampaignRecommendationsResponseV2":{"properties":{"nextToken":{"description":"An identifier to fetch next set of recommendations records in the result set if available. This will be null when at the end of result set.","example":"MTAxNTExtY5NDE\u003d","nullable":true,"type":"string"},"recommendations":{"description":"List of recommendations.","items":{"$ref":"#/components/schemas/Recommendation"},"maxItems":50,"minItems":0,"type":"array"}},"required":["recommendations"],"type":"object"},"GetCategoryRecommendationsForAsinsRequest":{"description":"Request object to retrieve Category Recommendations based on the input ASINs.","properties":{"asins":{"description":"List of input ASINs. This API does not check if the ASINs are valid ASINs.","items":{"type":"string"},"maxItems":10000,"type":"array"},"includeAncestor":{"description":"Enable this if you would like to retrieve categories which are ancestor nodes of the original recommended categories. This may increase the number of categories returned, but decrease the relevancy of those categories.","type":"boolean"}},"type":"object"},"GetProductRecommendationsRequest":{"description":"Request structure to get ASIN recommendations for a set of input ASINs.","properties":{"adAsins":{"description":"List of input ASINs.","items":{"example":"BX20002121","maxLength":10,"minLength":10,"type":"string"},"type":"array"},"count":{"description":"Count of objects requested in the response. The count will be applied on the objects returned under `recommendations` array in response body.  \u003cul\u003e \u003cli\u003eRequesting `application/vnd.spproductrecommendationresponse.themes.v3+json` mediatype applies the count on `ThemeRecommendation` objects.If no count value is passed a default of `5` is assumed. The API will return a maximum of `10` themes irrespective of how large the count is set. \u003c/li\u003e \u003cli\u003eRequesting `application/vnd.spproductrecommendationresponse.asins.v3+json` mediatype applies count on the `ProductRecommendation` objects in response body.If no count value is passed a default of `100` is assumed. The API will return a maximum of `1000` recommendations irrespective of how large the count is set. \u003c/li\u003e \u003c/ul\u003e Please refer the response Schemas for more info.","example":"5","minimum":1,"type":"integer"},"cursor":{"description":"A optional cursor value that can be used to fetch next or previous set of records.","example":"MTAxNTwNzI5NDE\u003d","type":"string"},"locale":{"description":"Theme names and descriptions will be provided in the language for your supported locale. Available options are en_US (U.S. English), en_GB (UK English), zh_CN (Chinese), es_ES (Spanish), jp_JP (Japanese), de_DE (German), fr_FR (French), it_IT(Italian). If locale is not provided or unsupported, the theme names and descriptions will be returned in U.S. English (en_US).","example":"en_US","type":"string"}},"required":["adAsins"],"type":"object"},"GetSPBudgetRuleResponse":{"properties":{"budgetRule":{"$ref":"#/components/schemas/SPBudgetRule"}},"type":"object"},"GetSPBudgetRulesForAdvertiserResponse":{"properties":{"budgetRulesForAdvertiserResponse":{"description":"A list of rules created by the advertiser.","items":{"$ref":"#/components/schemas/SPBudgetRule"},"maxItems":30,"minItems":0,"type":"array"},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}},"type":"object"},"GetSPCampaignOptimizationRuleResponse":{"properties":{"CampaignOptimizationRule":{"$ref":"#/components/schemas/CampaignOptimizationRule"}},"type":"object"},"GetTargetableAsinCountsRequest":{"properties":{"ageRanges":{"$ref":"#/components/schemas/AgeRanges"},"brands":{"$ref":"#/components/schemas/Brands"},"category":{"description":"The category node id. Please use the GetTargetableCategories API or GetCategoryRecommendationsForASINs API to retrieve category IDs.","type":"string"},"genres":{"$ref":"#/components/schemas/Genres"},"isPrimeShipping":{"description":"Indicates if products have prime shipping","type":"boolean"},"priceRange":{"$ref":"#/components/schemas/PriceRange"},"ratingRange":{"$ref":"#/components/schemas/RatingRange"}},"required":["category"],"type":"object"},"GlobalRankedKeywordTargetsForAdGroupRequest":{"allOf":[{"$ref":"#/components/schemas/AdGroupBasedRequest"}],"description":"This request type is used to retrieve recommended keyword targets for an existing ad group. Set the recommendationType to KEYWORDS_FOR_ADGROUP to use this request type.","properties":{"targets":{"description":"A list of targets that need to be ranked","items":{"$ref":"#/components/schemas/CountryTarget"},"maxItems":100,"minItems":0,"type":"array"}},"required":["adGroupId","campaignId","recommendationType"]},"GlobalRankedKeywordTargetsForAsinsRequest":{"allOf":[{"$ref":"#/components/schemas/AsinsBasedRequest"}],"description":"This request type is used to retrieve recommended keyword targets for ASINs. Set the recommendationType to KEYWORDS_FOR_ASINS to use this request type.","properties":{"products":{"description":"It represents an array list of countryProducts. CountryProducts is a map representing same product in a different marketplaces. Key is a 2-letter country code, value is a product.","items":{"additionalProperties":{"$ref":"#/components/schemas/ProductDetails","type":"object"},"type":"object"},"maxItems":50,"minItems":0,"type":"array"},"targets":{"description":"An array list of countryTargets. CountryTarget is an object with CountryKeywords map representing same keyword in a different locales. Key is a 2-letter country code, value is a keyword object.","items":{"$ref":"#/components/schemas/CountryTarget"},"maxItems":100,"minItems":0,"type":"array"}},"required":["recommendationType"]},"GlobalRankedTargetWithThemedBidsResponse":{"properties":{"countryCodes":{"additionalProperties":{"$ref":"#/components/schemas/RankedTargetWithThemedBidsResponse"},"type":"object"}},"type":"object"},"ImpactMetric":{"description":"The impact metrics are given in the same order of suggested bids. \u003cbr\u003e Note: This object is nullable","nullable":true,"properties":{"values":{"items":{"$ref":"#/components/schemas/RangeMetricValue"},"type":"array"}},"type":"object"},"ImpactMetrics":{"description":"For the CONVERSION_OPPORTUNITIES theme, the impact metrics are weekly clicks and orders received for similar products. For other event-based themes, the impact metrics are clicks and orders received for similar products during the event days. \u003cbr\u003e Note: This object is nullable","nullable":true,"properties":{"clicks":{"$ref":"#/components/schemas/ImpactMetric"},"orders":{"$ref":"#/components/schemas/ImpactMetric"}},"type":"object"},"Impressions":{"description":"Impressions benchmark.","properties":{"lower":{"description":"lower bound.","type":"integer"},"upper":{"description":"upper bound.","type":"integer"}}},"InitialBudgetRecommendationRequest":{"properties":{"adGroups":{"description":"The ad group information for this new campaign.","items":{"$ref":"#/components/schemas/AdGroup"},"maxItems":1,"minItems":1,"type":"array"},"bidding":{"$ref":"#/components/schemas/Bidding"},"endDate":{"description":"The end date of the campaign in YYYYMMDD format.","type":"string"},"startDate":{"description":"The start date of the campaign in YYYYMMDD format.","type":"string"},"targetingType":{"description":"Specifies the targeting type.","enum":["auto","manual"],"type":"string"}},"required":["adGroups","bidding","targetingType"],"type":"object"},"InitialBudgetRecommendationResponse":{"properties":{"benchmark":{"$ref":"#/components/schemas/Benchmark"},"dailyBudget":{"description":"Recommended daily budget for the new campaign. Note: value -1 means we don’t have enough information to provide a recommendation.","type":"number"},"recommendationId":{"description":"Unique identifier for each recommendation.","type":"string"},"specialEvents":{"description":"A list of special events around the start and end date of the campaign.","items":{"$ref":"#/components/schemas/SpecialEvent"},"maxItems":5,"minItems":0,"type":"array"}},"required":["benchmark","dailyBudget","specialEvents"],"type":"object"},"IntegerRange":{"properties":{"max":{"format":"int32","type":"integer"},"min":{"format":"int32","type":"integer"}},"type":"object"},"InternalServerException":{"description":"Returns information about an InternalServerException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"KeywordBidInfo":{"properties":{"bid":{"description":"The bid value for the keyword, in minor currency units (example: cents). The default value will be the suggested bid.","format":"Double","type":"number"},"matchType":{"description":"Keyword match type. The default value will be BROAD.","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"rank":{"description":"The keyword target rank","type":"number"},"suggestedBid":{"$ref":"#/components/schemas/BidSuggestion"}},"type":"object"},"KeywordGroup":{"description":"Keyword group. Represents a high level keyword targeting intent. e.g. the keyword group \"gift\" can target relevant search queries containing the word gift","properties":{"description":{"description":"Detailed Keyword group description.","type":"string"},"id":{"description":"Unique Identifier for the keyword group. To be passed during targeting clause creation.","type":"string"},"impactSummary":{"description":"Summary of impacts.","type":"string"},"sampleKeywords":{"description":"Sample keywords that match the group.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"text":{"description":"Keyword group text. Can be used for display purposes.","type":"string"}},"required":["id","text"],"type":"object"},"KeywordGroupsRecommendationsRequest":{"description":"Keyword groups request.","properties":{"asins":{"description":"List of ASINs.","items":{"description":"ASIN.","maxLength":32,"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"countryCode":{"description":"The country code representing the origin country of the input ASIN list, it will be used for generating keyword group recommendations.","type":"string"},"nextToken":{"description":"If the last response included this field then there are more items to retrieve.","type":"string"}},"required":["asins"],"type":"object"},"KeywordGroupsRecommendationsResponse":{"description":"Keyword group recommendations response.","properties":{"countryCode":{"description":"The country code representing the origin country of the input ASIN list, used for generating keyword group recommendations.","type":"string"},"keywordGroups":{"description":"Keyword group recommendations for input list of ASINs.","items":{"$ref":"#/components/schemas/KeywordGroup"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"description":"If present then there is more data to retrieve. To retrieve, resend request with token.","type":"string"}},"required":["keywordGroups"],"type":"object"},"KeywordTarget":{"properties":{"bid":{"description":"The bid value for the keyword, in minor currency units (example: cents). The default value will be the suggested bid.","format":"double","type":"number"},"keyword":{"description":"The keyword value","type":"string"},"matchType":{"description":"Keyword match type. The default value will be BROAD.","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"userSelectedKeyword":{"description":"Flag that tells if keyword was selected by the user or was recommended by KRS","type":"boolean"}}},"KeywordTargetRankRecommendationRequest":{"allOf":[{"$ref":"#/components/schemas/RecommendationOptions"}],"properties":{"targets":{"description":"A list of targets that need to be ranked","items":{"allOf":[{"$ref":"#/components/schemas/KeywordTarget"}]},"maxItems":100,"minItems":0,"type":"array"}}},"KeywordTargetResponse":{"allOf":[{"$ref":"#/components/schemas/KeywordTarget"}],"properties":{"rank":{"description":"The keyword target rank","type":"number"},"suggestedBid":{"allOf":[{"$ref":"#/components/schemas/BidSuggestion"}]},"translation":{"description":"The translation of keyword if a locale is passed in","type":"string"}}},"KeywordTargetingRecommendation":{"description":"Contains suggested recommendation for the keyword targeting.","properties":{"action":{"description":"Type of action for the keyword targeting.","enum":["ADD","DECREASE","INCREASE","REMOVE","UPDATE"],"type":"string"},"adGroupId":{"description":"The ad group identifier.","type":"string"},"keywordId":{"description":"The identifier of the keyword targeting.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"description":"Keyword match type. | Value | Description | | --- | --- | | `BROAD` | Use BROAD to broadly match your keyword targeting ads with search queries.| | `EXACT` | Use EXACT to exactly match your keyword targeting ads with search queries.| | `PHRASE` | Use PHRASE to match your keyword targeting ads with search phrases.| | `GROUP` | Use GROUP to match your keyword targeting ads with keyword group. |","enum":["BROAD","EXACT","GROUP","PHRASE"],"type":"string"},"suggestedBid":{"description":"The suggested bid value associated with this keyword targeting clause.","format":"double","type":"number"}},"type":"object"},"MultiCountryAdGroupThemeBasedBidRecommendationRequest":{"example":{"adGroupId":"EFGH5678","campaignId":"ABCD1234","countryCodes":["UK","US"],"includeAnalysis":"true","recommendationType":"BIDS_FOR_EXISTING_AD_GROUP","targetingExpressions":[{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}]},"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"countryCodes":{"$ref":"#/components/schemas/CountryCodes"},"includeAnalysis":{"default":"false","description":"Flag to include new bid analyzer data.","type":"boolean"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_EXISTING_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/MultiCountryTargetingExpressionList"}},"required":["adGroupId","campaignId","recommendationType","targetingExpressions"],"type":"object"},"MultiCountryAsinsThemeBasedBidRecommendationRequest":{"example":{"bidding":{"adjustments":[{"percentage":"100","predicate":"PLACEMENT_TOP"},{"percentage":"75","predicate":"PLACEMENT_REST_OF_SEARCH"},{"percentage":"50","predicate":"PLACEMENT_PRODUCT_PAGE"}],"strategy":"AUTO_FOR_SALES"},"countryCodes":["UK","US"],"includeAnalysis":"true","products":[{"US":{"asin":"asin1"}},{"UK":{"asin":"asin2","globalStoreSetting":{"catalogSourceCountryCode":"DE"}}}],"recommendationType":"BIDS_FOR_NEW_AD_GROUP","targetingExpressions":[{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}]},"properties":{"bidding":{"description":"Bidding control configuration for the campaign.","properties":{"adjustments":{"description":"Placement adjustment configuration for the campaign.","items":{"$ref":"#/components/schemas/BidPlacementAdjustment"},"maxItems":3,"minItems":1,"type":"array"},"strategy":{"$ref":"#/components/schemas/BiddingStrategy"}},"required":["strategy"],"type":"object"},"countryCodes":{"$ref":"#/components/schemas/CountryCodes"},"includeAnalysis":{"default":"false","description":"Flag to include new bid analyzer data.","type":"boolean"},"products":{"description":"This represents the list of products in the request.","items":{"$ref":"#/components/schemas/MultiCountryProduct"},"maxItems":50,"minItems":1,"type":"array"},"recommendationType":{"description":"The bid recommendation type.","enum":["BIDS_FOR_NEW_AD_GROUP"],"type":"string"},"targetingExpressions":{"$ref":"#/components/schemas/MultiCountryTargetingExpressionList"}},"required":["bidding","countryCodes","recommendationType","targetingExpressions"],"type":"object"},"MultiCountryBidAnalysesPerTargetingExpression":{"example":{"countryBidAnalyses":{"UK":{"PLACEMENT_TOP":[{"bid":"0.25","impactMetrics":{"estimatedImpressionAvg":"1000","estimatedImpressionLower":"800","estimatedImpressionUpper":"1200"},"type":"SUGGESTED_LOWER"},{"bid":"0.35","impactMetrics":{"estimatedImpressionAvg":"1400","estimatedImpressionLower":"1200","estimatedImpressionUpper":"1600"},"type":"SUGGESTED"}]},"US":{"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.3","impactMetrics":{"estimatedImpressionAvg":"1000","estimatedImpressionLower":"800","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"}],"PLACEMENT_TOP":[{"bid":"0.35","impactMetrics":{"estimatedImpressionAvg":"1250","estimatedImpressionLower":"1000","estimatedImpressionUpper":"1500"},"type":"SUGGESTED_LOWER"},{"bid":"0.45","impactMetrics":{"estimatedImpressionAvg":"1750","estimatedImpressionLower":"1500","estimatedImpressionUpper":"2000"},"type":"SUGGESTED"},{"bid":"0.55","impactMetrics":{"estimatedImpressionAvg":"2250","estimatedImpressionLower":"2000","estimatedImpressionUpper":"2500"},"type":"SUGGESTED_UPPER"}]}},"expression":{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}},"properties":{"countryBidAnalyses":{"additionalProperties":{"$ref":"#/components/schemas/BidAnalysesPerPlacement"}},"expression":{"$ref":"#/components/schemas/MultiCountryTargetingExpression"}},"required":["countrySuggestedBids","expression"],"type":"object"},"MultiCountryBidRecommendationError":{"properties":{"code":{"description":"Machine readable error code.","type":"string"},"countryCodes":{"description":"Countries where error have occurred","items":{"type":"string"},"type":"array"},"message":{"description":"Human readable 1 liner error message","type":"string"}},"type":"object"},"MultiCountryBidRecommendationPerTargetingExpression":{"example":{"countrySuggestedBids":{"UK":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"US":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}]},"expression":{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}},"properties":{"countrySuggestedBids":{"additionalProperties":{"$ref":"#/components/schemas/SuggestedBidValues"}},"expression":{"$ref":"#/components/schemas/MultiCountryTargetingExpression"}},"required":["countrySuggestedBids","expression"],"type":"object"},"MultiCountryProduct":{"additionalProperties":{"$ref":"#/components/schemas/ProductDetails","description":"Product value","type":"object"},"description":"This field provides the details for multi country product.","type":"object"},"MultiCountryTargetingExpression":{"description":"The targeting expression. The `type` property specifies the targeting option. Use `CLOSE_MATCH` to match your auto targeting ads closely to the specified value. Use `LOOSE_MATCH` to match your auto targeting ads broadly to the specified value. Use `SUBSTITUTES` to display your auto targeting ads along with substitutable products. Use `COMPLEMENTS` to display your auto targeting ads along with affiliated products. Use `KEYWORD_BROAD_MATCH` to broadly match your keyword targeting ads with search queries. Use `KEYWORD_EXACT_MATCH` to exactly match your keyword targeting ads with search queries. Use `KEYWORD_PHRASE_MATCH` to match your keyword targeting ads with search phrases. your keyword targeting ads with search phrases. Use `PAT_ASIN` to match your product attribute targeting ads with product ASIN. Use `PAT_CATEGORY` to match your product attribute targeting ads with product category. Use `PAT_CATEGORY_REFINEMENT` to match your product attribute targeting ads with product attribute, including brand, price, rating, prime shipping eligible, age range and genre. Use `KEYWORD_GROUP` to match your keyword targeting ads with keyword group.","example":{"type":"CLOSE_MATCH"},"properties":{"countryValues":{"additionalProperties":{"description":"The expression value","type":"string"}},"type":{"$ref":"#/components/schemas/MultiCountryTargetingExpressionType"}},"required":["type"],"type":"object"},"MultiCountryTargetingExpressionList":{"description":"The list of targeting expressions. Maximum of 100 per request per country, use pagination for more if needed.","example":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}],"items":{"$ref":"#/components/schemas/MultiCountryTargetingExpression"},"maxItems":100,"type":"array"},"MultiCountryTargetingExpressionType":{"enum":["CLOSE_MATCH","COMPLEMENTS","KEYWORD_BROAD_MATCH","KEYWORD_EXACT_MATCH","KEYWORD_GROUP","KEYWORD_PHRASE_MATCH","LOOSE_MATCH","PAT_ASIN","PAT_CATEGORY","PAT_CATEGORY_REFINEMENT","SUBSTITUTES"],"type":"string"},"MultiCountryThemeBasedBidRecommendation":{"example":{"bidRecommendationsForTargetingExpressions":[{"countrySuggestedBids":{"UK":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"US":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}]},"expression":{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},"properties":{"bidAnalysesForTargetingExpressions":{"description":"The bid analyses for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/MultiCountryBidAnalysesPerTargetingExpression"},"type":"array"},"bidRecommendationsForTargetingExpressions":{"description":"The bid recommendations for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/MultiCountryBidRecommendationPerTargetingExpression"},"type":"array"},"theme":{"$ref":"#/components/schemas/Theme"}},"required":["bidRecommendationsForTargetingExpressions","theme"],"type":"object"},"MultiCountryThemeBasedBidRecommendationCompleteFailureResponse":{"example":{"errors":[{"code":"001","countryCodes":["US"],"message":"Some error occurred."}]},"properties":{"errors":{"description":"List of errors occurred while processing multi country request.","items":{"$ref":"#/components/schemas/MultiCountryBidRecommendationError"},"type":"array"}},"required":["errors"],"type":"object"},"MultiCountryThemeBasedBidRecommendationResponse":{"description":"A list of multi country bid recommendation themes and associated bid recommendations.","example":{"bidRecommendations":[{"bidRecommendationsForTargetingExpressions":[{"countrySuggestedBids":{"UK":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"US":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}]},"expression":{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},{"bidRecommendationsForTargetingExpressions":[{"countrySuggestedBids":{"UK":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"US":[{"suggestedBid":"1.2"},{"suggestedBid":"1.2"},{"suggestedBid":"2"}]},"expression":{"countryValues":{"UK":"Sample2","US":"Sample1"},"type":"KEYWORD_BROAD_MATCH"}}],"theme":"PRIME_DAY"}]},"properties":{"bidRecommendations":{"items":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendation"},"maxItems":2,"minItems":0,"type":"array"},"errors":{"description":"List of errors occurred while processing multi country request.","items":{"$ref":"#/components/schemas/MultiCountryBidRecommendationError"},"type":"array"}},"required":["bidRecommendations"],"type":"object"},"OptimizationRulesAPISwaggerActionDetails":{"description":"Details of a rule action.","example":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"20"},"properties":{"actionOperator":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleActionOperator"},"actionUnit":{"enum":["PERCENT"],"type":"string"},"value":{"description":"An integer between 1 \u0026 100, representing the percent increase on base bid.","format":"double","type":"number"}},"required":["actionOperator","actionUnit","value"],"type":"object"},"OptimizationRulesAPISwaggerActionType":{"description":"The action taken when the optimization rule is enabled. Defaults to ADOPT.","enum":["ADOPT"],"type":"string"},"OptimizationRulesAPISwaggerAssociateOptimizationRulesToCampaignRequest":{"description":"Request body for create campaign to optimization rules association. Maximum 100 rules can be associated to each campaign.","properties":{"optimizationRuleIds":{"description":"An array of rule identifiers.","example":["750fe03c-9884-4a72-a540-3b87521018d9","7bf484ff-381c-4703-82ec-66b9eb732705","ed1d58dd-662b-4639-9ee2-85ff1386b946"],"items":{"type":"string"},"maxItems":25,"minItems":1,"type":"array"}},"required":["optimizationRuleIds"],"type":"object"},"OptimizationRulesAPISwaggerAssociateOptimizationRulesToCampaignResponse":{"description":"Response object for create campaign to optimization rules association.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"responses":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSingleOptimizationRuleAssociationResponse"},"maxItems":25,"minItems":1,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerCampaignFilter":{"description":"Filter on campaigns. This filter only returns associated Bid and Targeting rules, and it does not return budget rules.","properties":{"campaignId":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"}},"type":"object"},"OptimizationRulesAPISwaggerComparisonOperator":{"description":"The comparison operator.","enum":["EQUAL_TO","GREATER_THAN","GREATER_THAN_OR_EQUAL_TO","LESS_THAN","LESS_THAN_OR_EQUAL_TO"],"type":"string"},"OptimizationRulesAPISwaggerCreateOptimizationRulesRequest":{"description":"Request object for creating one or multiple optimization rules.","properties":{"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleId"},"maxItems":1,"minItems":1,"type":"array"}},"required":["optimizationRules"],"type":"object"},"OptimizationRulesAPISwaggerCreateOptimizationRulesRequestV2":{"description":"Request object for creating one or multiple optimization rules.  Budget rules are not supported for this operation.","properties":{"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleIdV2"},"maxItems":300,"minItems":1,"type":"array"}},"required":["optimizationRules"],"type":"object"},"OptimizationRulesAPISwaggerCreateOptimizationRulesResponseV2":{"allOf":[{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesResponseV2"}],"description":"Response object for CreateOptimizationRules API.","type":"object"},"OptimizationRulesAPISwaggerDayOfTheWeek":{"description":"Day of the week.","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"],"example":"FRIDAY","type":"string"},"OptimizationRulesAPISwaggerDuration":{"description":"The duration of an optimization rule based on special events (example: Prime Day) or custom date ranges.","properties":{"endTime":{"description":"Time of optimization rule completion in ISO 8061.","type":"string"},"eventId":{"description":"Identifier for the event during which the rule is applied.","type":"string"},"eventName":{"description":"Name of the event during which the rule is applied.","type":"string"},"startTime":{"description":"Time of optimization rule creation in ISO 8061. Not Required only when eventId present.","type":"string"}},"type":"object"},"OptimizationRulesAPISwaggerEntityFieldFilter":{"description":"Filter type and value pair.","example":{"filterType":"EXACT_MATCH","values":["29aeb716-2ba7-4fae-9f9a-3e8306e0ca0f","c735308f-fd6c-49a6-b2a8-e53f354265bc"]},"properties":{"filterType":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerFilterType"},"values":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerExpressionType":{"description":"The expression types of targets for the rule.","enum":["BROAD","EXACT","EXPANDED","PHRASE"],"type":"string"},"OptimizationRulesAPISwaggerFilterType":{"description":"Types of filter used for search.","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"OptimizationRulesAPISwaggerOptimizationRule":{"allOf":[{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleId"},{"properties":{"optimizationRuleId":{"description":"The rule identifier.","type":"string"}},"type":"object"}]},"OptimizationRulesAPISwaggerOptimizationRuleFilter":{"description":"Filter on optimization rules.","properties":{"optimizationRuleId":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleSubCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"}},"type":"object"},"OptimizationRulesAPISwaggerOptimizationRuleFilterV2":{"description":"Filter on optimization rules.","properties":{"optimizationRuleId":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleName":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleStatus":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"},"ruleSubCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerEntityFieldFilter"}},"type":"object"},"OptimizationRulesAPISwaggerOptimizationRuleV2":{"allOf":[{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleIdV2"},{"properties":{"optimizationRuleId":{"description":"The rule identifier.","type":"string"}},"type":"object"}]},"OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleId":{"example":{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"50"},"actionType":"ADOPT"},"optimizationRuleId":"7bf484ff-381c-4703-82ec-66b9eb732705","recurrence":{"daysOfWeek":["SATURDAY","SUNDAY"],"duration":{"endTime":"2023-11-30T23:59:59Z","startTime":"2022-11-01T00:00:00Z"},"timesOfDay":[{"endTime":"24:00","startTime":"21:00"}],"type":"WEEKLY"},"ruleCategory":"BID","ruleName":"increase_bids_by_50%_on_weekend_nights","ruleSubCategory":"SCHEDULE"},"properties":{"action":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleAction"},"conditions":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleCondition"},"maxItems":1,"minItems":0,"type":"array"},"recurrence":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleRecurrence"},"ruleCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleCategory"},"ruleName":{"description":"The rule name.","type":"string"},"ruleSubCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleSubCategory"},"status":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleStatus"}},"required":["action","recurrence","ruleCategory","ruleSubCategory"],"type":"object"},"OptimizationRulesAPISwaggerOptimizationRuleWithoutRuleIdV2":{"example":{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"50"},"actionType":"ADOPT"},"optimizationRuleId":"7bf484ff-381c-4703-82ec-66b9eb732705","recurrence":{"daysOfWeek":["SATURDAY","SUNDAY"],"duration":{"endTime":"2023-11-30T23:59:59Z","startTime":"2022-11-01T00:00:00Z"},"timesOfDay":[{"endTime":"24:00","startTime":"21:00"}],"type":"WEEKLY"},"ruleCategory":"BID","ruleName":"increase_bids_by_50%_on_weekend_nights","ruleSubCategory":"SCHEDULE"},"properties":{"action":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleAction"},"conditions":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleConditionV2"},"maxItems":10,"minItems":1,"type":"array"},"recurrence":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleRecurrence"},"ruleCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleCategoryV2"},"ruleName":{"description":"The rule name.","type":"string"},"ruleSubCategory":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleSubCategoryV2"},"status":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleStatus"},"targeting":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleTargeting"},"maxItems":1,"minItems":1,"type":"array"}},"required":["ruleCategory","ruleName","ruleSubCategory","status"],"type":"object"},"OptimizationRulesAPISwaggerOptimizationRulesError":{"description":"Error response object.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"OptimizationRulesAPISwaggerOptimizationRulesResponse":{"description":"Response object for CreateOptimizationRules and UpdateOptimizationRules API.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"responses":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSingleOptimizationRuleResponse"},"maxItems":25,"minItems":1,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerOptimizationRulesResponseV2":{"description":"Response object for CreateOptimizationRules and UpdateOptimizationRules API.","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"responses":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSingleOptimizationRuleResponseV2"},"maxItems":300,"minItems":1,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerRangeTypeRuleCriteria":{"description":"Represents the range of rule attribute value. NOT SUPPORTED right now","properties":{"maxValue":{"format":"double","type":"number"},"minValue":{"format":"double","type":"number"}},"required":["maxValue","minValue"],"type":"object"},"OptimizationRulesAPISwaggerRuleAction":{"description":"Action to be taken by the rule.","example":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"50"},"actionType":"ADOPT"},"properties":{"actionDetails":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerActionDetails"},"actionType":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerActionType"}},"required":["actionDetails","actionType"],"type":"object"},"OptimizationRulesAPISwaggerRuleActionOperator":{"description":"The action operation for the rule.","enum":["INCREMENT"],"type":"string"},"OptimizationRulesAPISwaggerRuleAttribute":{"description":"The attribute of the rule.","enum":["ROAS"],"type":"string"},"OptimizationRulesAPISwaggerRuleAttributeV2":{"description":"The attribute of the rule.","enum":["ACOS","CLICKS","CPC","CTR","CVR","IMPRESSIONS","ORDERS","ROAS","SALES","SPEND"],"type":"string"},"OptimizationRulesAPISwaggerRuleCategory":{"description":"The type of the optimization rule.","enum":["BID"],"type":"string"},"OptimizationRulesAPISwaggerRuleCategoryV2":{"description":"The type of the optimization rule.","enum":["BID","BUDGET","TARGETING"],"type":"string"},"OptimizationRulesAPISwaggerRuleCondition":{"properties":{"attributeName":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleAttribute"},"criteria":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleCriteria"}},"type":"object"},"OptimizationRulesAPISwaggerRuleConditionV2":{"properties":{"attributeName":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleAttributeV2"},"criteria":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleCriteria","description":"Only Value Type Criteria is supported right now."}},"type":"object"},"OptimizationRulesAPISwaggerRuleCriteria":{"oneOf":[{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRangeTypeRuleCriteria"},{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerValueTypeRuleCriteria"}]},"OptimizationRulesAPISwaggerRuleRecurrence":{"description":"The recurrence of the optimization rule application.","properties":{"daysOfWeek":{"description":"A list of days of the week.","items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerDayOfTheWeek"},"maxItems":7,"minItems":0,"type":"array"},"duration":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerDuration"},"timesOfDay":{"description":"List of times of the day.","items":{"description":"List of times of the day.","properties":{"endTime":{"description":"Time of the day in HH:00.","pattern":"^\\d{2}:00$","type":"string"},"startTime":{"description":"Time of the day in HH:00.","pattern":"^\\d{2}:00$","type":"string"}},"required":["endTime","startTime"],"type":"object"},"maxItems":1,"minItems":0,"type":"array"},"type":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerRuleRecurrenceType"}},"required":["duration","type"],"type":"object"},"OptimizationRulesAPISwaggerRuleRecurrenceType":{"description":"The frequency of the optimization rule application.","enum":["DAILY","WEEKLY"],"type":"string"},"OptimizationRulesAPISwaggerRuleStatus":{"description":"The status of a rule. Only ENABLED and PAUSED are accepted in requests.","enum":["ENABLED","ENDED","PAUSED","SCHEDULED"],"type":"string"},"OptimizationRulesAPISwaggerRuleSubCategory":{"description":"The sub-category of the optimization rule.","enum":["SCHEDULE"],"type":"string"},"OptimizationRulesAPISwaggerRuleSubCategoryV2":{"description":"The sub-category of the optimization rule.","enum":["PERFORMANCE","SCHEDULE"],"type":"string"},"OptimizationRulesAPISwaggerRuleTargeting":{"properties":{"expressionTypes":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerExpressionType"},"maxItems":3,"minItems":1,"type":"array"},"lookbackDays":{"description":"The number of days of data to look back on for the rule.","maximum":65,"minimum":3,"type":"integer"},"targetingType":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerTargetingType"}},"required":["expressionTypes","lookbackDays","targetingType"],"type":"object"},"OptimizationRulesAPISwaggerSearchOptimizationRulesRequest":{"description":"Request object for searching or getting optimization rules.","properties":{"campaignFilter":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerCampaignFilter"},"nextToken":{"type":"string"},"optimizationRuleFilter":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleFilter"},"pageSize":{"type":"number"}},"type":"object"},"OptimizationRulesAPISwaggerSearchOptimizationRulesRequestV2":{"description":"Request object for searching or getting optimization rules.","properties":{"campaignFilter":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerCampaignFilter"},"maxResults":{"description":"The maximum number of optimization rules to fetch.","maximum":300,"minimum":1,"type":"number"},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the field is empty, the first page of results will be returned.","type":"string"},"optimizationRuleFilter":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleFilterV2"},"sortBy":{"description":"Sort conditions applied to the response.","items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSortableField"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerSearchOptimizationRulesResponse":{"properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"nextToken":{"type":"string"},"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRule"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerSearchOptimizationRulesResponseV2":{"properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"nextToken":{"type":"string"},"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleV2"},"maxItems":300,"minItems":0,"type":"array"}},"type":"object"},"OptimizationRulesAPISwaggerSingleOptimizationRuleAssociationResponse":{"description":"Response object for operations involving associating a single optimization rule.","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful.","type":"string"},"optimizationRuleId":{"description":"The rule identifier.","type":"string"}},"type":"object"},"OptimizationRulesAPISwaggerSingleOptimizationRuleResponse":{"description":"Response object for operations involving a single optimization rule.","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful.","type":"string"},"optimizationRule":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRule"}},"type":"object"},"OptimizationRulesAPISwaggerSingleOptimizationRuleResponseV2":{"description":"Response object for operations involving a single optimization rule.","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful.","type":"string"},"optimizationRule":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleV2"}},"type":"object"},"OptimizationRulesAPISwaggerSortableField":{"description":"Name of the field to sort the response in ascending order.","enum":["NAME"],"type":"string"},"OptimizationRulesAPISwaggerTargetingType":{"description":"The type of targets for the rule.","enum":["KEYWORD","PRODUCT"],"type":"string"},"OptimizationRulesAPISwaggerUpdateOptimizationRulesRequest":{"description":"Request object for updating one or multiple optimization rules.","properties":{"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRule"},"maxItems":25,"minItems":1,"type":"array"}},"required":["optimizationRules"],"type":"object"},"OptimizationRulesAPISwaggerUpdateOptimizationRulesRequestV2":{"description":"Request object for updating one or multiple optimization rules. Budget rules are not supported for this operation.","properties":{"optimizationRules":{"items":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRuleV2"},"maxItems":300,"minItems":1,"type":"array"}},"required":["optimizationRules"],"type":"object"},"OptimizationRulesAPISwaggerUpdateOptimizationRulesResponseV2":{"allOf":[{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesResponseV2"}],"description":"Response object for UpdateOptimizationRules API.","type":"object"},"OptimizationRulesAPISwaggerValueTypeRuleCriteria":{"description":"Represents a criteria by comparing with the rule attribute value.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerComparisonOperator"},"value":{"format":"double","type":"number"}},"required":["comparisonOperator","value"],"type":"object"},"PerformanceMeasureCondition":{"properties":{"comparisonOperator":{"$ref":"#/components/schemas/ComparisonOperator"},"metricName":{"$ref":"#/components/schemas/PerformanceMetric"},"threshold":{"description":"The performance threshold value.","format":"double","type":"number"}},"required":["comparisonOperator","metricName","threshold"],"type":"object"},"PerformanceMetric":{"description":"The advertising performance metric.","enum":["ACOS","CTR","CVR","ROAS"],"type":"string"},"PlacementAdjustment":{"description":"Specifies bid adjustments based on the placement location. Use `PLACEMENT_TOP` for the top of the search page. Use `PLACEMENT_REST_OF_SEARCH` for the rest of the search page. Use `PLACEMENT_PRODUCT_PAGE` for a product page.","example":{"percentage":"100","predicate":"PLACEMENT_TOP"},"properties":{"percentage":{"maximum":900,"minimum":0,"type":"integer"},"predicate":{"enum":["PLACEMENT_PRODUCT_PAGE","PLACEMENT_REST_OF_SEARCH","PLACEMENT_TOP"],"type":"string"}},"type":"object"},"PlacementBiddingRecommendation":{"description":"Contains suggested recommendation for a placement bid adjustment.","properties":{"action":{"description":"Type of suggested action.","enum":["ADD","DECREASE","INCREASE","REMOVE"],"type":"string"},"incrementalImpressionsLowerPercent":{"description":"Lower bound of the estimated incremental impressions that could be gained if this optimization used","type":"integer"},"incrementalImpressionsUpperPercent":{"description":"Upper bound of the estimated incremental impressions that could be gained if this optimization used","type":"integer"},"placementType":{"description":"The placement type.","enum":["PLACEMENT_PRODUCT_PAGE","PLACEMENT_REST_OF_SEARCH","PLACEMENT_TOP"],"type":"string"},"suggestedBidAdjustment":{"description":"The suggested bid adjustment percent value for this placement type.","format":"integer","type":"number"}},"type":"object"},"PriceRange":{"description":"A range of prices. We use this to retrieve the number of targetable ASINs that falls within this price range.","properties":{"max":{"format":"double","type":"number"},"min":{"format":"double","type":"number"}},"type":"object"},"ProductDetails":{"properties":{"asin":{"description":"The identifier of the product.","type":"string"},"globalStoreSetting":{"description":"This denotes the fields related to [GlobalStore Program](https://sellercentral.amazon.com/help/hub/reference/external/202139180).","properties":{"catalogSourceCountryCode":{"description":"Country code of source marketplace where seller has listed the product. Possible source country codes include US, UK, DE, JP, and AE.","type":"string"}},"type":"object"}},"type":"object"},"ProductDetailsList":{"description":"The list of products in the request.","items":{"$ref":"#/components/schemas/ProductDetails"},"maxItems":50,"minItems":0,"type":"array"},"ProductRecommendation":{"description":"Recommended asin and related information.","properties":{"recommendedAsin":{"description":"Recommended ASIN","example":"BX20002121","maxLength":10,"minLength":10,"type":"string"},"themes":{"description":"List of themes associated with this recommended ASIN.","items":{"example":"Top Converting ASINs","type":"string"},"type":"array"}},"type":"object"},"ProductRecommendationsByASIN":{"description":"Product recommendations supplemented with relevant information.","properties":{"nextCursor":{"description":"An identifier to fetch next set of `ProductRecommendation` records in the result set if available. This will be null when at the end of result set.","example":"MTAxNTExOTQ1MjAwNzI5NDE\u003d","type":"string"},"previousCursor":{"description":"Optional parameter that links to the previous result set served. This parameter will be null on the first request.","example":"TQ1MjAwNzI5NDE\u003d","type":"string"},"recommendations":{"description":"An array of `ProductRecommendation` objects.","items":{"$ref":"#/components/schemas/ProductRecommendation"},"type":"array"}},"type":"object"},"ProductRecommendationsByTheme":{"description":"Product recommendations grouped by theme attribute.","properties":{"nextCursor":{"description":"An identifier to fetch next set of `ThemeRecommendation` records in the result set if available. This will be null when at the end of result set.","example":"MTAxNTExOzI5NDE\u003d","type":"string"},"previousCursor":{"description":"Optional parameter that links to the previous result set served to the requester.","example":"OTQ1wNzI5NDE\u003d","type":"string"},"recommendations":{"description":"An array of `ThemeRecommendation` objects","items":{"$ref":"#/components/schemas/ThemeRecommendation"},"type":"array"}},"type":"object"},"RangeMetricValue":{"description":"Describes lower and upper bounds of the range. \u003cbr\u003e Note: This object is nullable","properties":{"lower":{"type":"integer"},"upper":{"type":"integer"}},"type":"object"},"RankedKeywordTargetsForAdGroupRequest":{"allOf":[{"$ref":"#/components/schemas/KeywordTargetRankRecommendationRequest"}],"description":"This request type is used to retrieve recommended keyword targets for an existing ad group. Set the recommendationType to KEYWORDS_FOR_ADGROUP to use this request type.","properties":{"adGroupId":{"description":"The identifier of the ad group","type":"string"},"bidsEnabled":{"default":"true","description":"Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true.","type":"boolean"},"campaignId":{"description":"The identifier of the campaign","type":"string"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for an existing ad group.","enum":["KEYWORDS_FOR_ADGROUP"],"type":"string"}},"required":["adGroupId","campaignId","recommendationType"]},"RankedKeywordTargetsForAsinsRequest":{"allOf":[{"$ref":"#/components/schemas/KeywordTargetRankRecommendationRequest"}],"description":"This request type is used to retrieve recommended keyword targets for ASINs. Set the recommendationType to KEYWORDS_FOR_ASINS to use this request type.","properties":{"asins":{"description":"An array list of Asins","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"biddingStrategy":{"default":"LEGACY_FOR_SALES","description":"The bid recommendations returned will depend on the bidding strategy. \u003cbr\u003e LEGACY_FOR_SALES - Dynamic Bids (Down only) \u003cbr\u003e AUTO_FOR_SALES - Dynamic Bids (Up or down) \u003cbr\u003e MANUAL - Fixed Bids","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"type":"string"},"bidsEnabled":{"default":"true","description":"Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true.","type":"boolean"},"productDetailsList":{"$ref":"#/components/schemas/ProductDetailsList"},"recommendationType":{"description":"The recommendationType to retrieve recommended keyword targets for a list of ASINs.","enum":["KEYWORDS_FOR_ASINS"],"type":"string"}},"required":["asins","recommendationType"]},"RankedTargetResponse":{"properties":{"keywordTargetList":{"description":"A list of ranked keyword targets","items":{"allOf":[{"$ref":"#/components/schemas/RecKeywordTarget"}]},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"RankedTargetWithThemedBids":{"properties":{"bidInfo":{"description":"A list of keyword bid info","items":{"allOf":[{"$ref":"#/components/schemas/ThemedBid"}]},"maxItems":15,"minItems":0,"type":"array"},"keyword":{"description":"The keyword value","type":"string"},"recId":{"description":"The recommended keyword target id","type":"string"},"searchTermImpressionRank":{"description":"The account-level ad-attributed impression rank for the search-term/keyword. Provides [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 30 days. It tells an advertiser how many advertisers had higher share of ad impressions. This information is only available for keywords the advertiser targeted with ad impressions.","type":"number"},"searchTermImpressionShare":{"description":"The account-level ad-attributed impression share for the search-term/keyword. Provides percentage share of all ad impressions the advertiser has for the keyword in the last 30 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords. This information is only available for keywords the advertiser targeted with ad impressions.","format":"Double","type":"number"},"translation":{"description":"The translation of keyword if a locale is passed in","type":"string"},"userSelectedKeyword":{"description":"Flag that tells if keyword was selected by the user or was recommended by KRS","type":"boolean"}},"type":"object"},"RankedTargetWithThemedBidsList":{"items":{"$ref":"#/components/schemas/RankedTargetWithThemedBids"},"maxItems":200,"minItems":0,"type":"array"},"RankedTargetWithThemedBidsResponse":{"properties":{"impactMetrics":{"description":"A list of impact metrics which anticipates the number of clicks and orders you will receive if you target all targeting expressions using the low, medium, and high suggested bid.","items":{"$ref":"#/components/schemas/ImpactMetrics"},"maxItems":5,"minItems":0,"type":"array"},"keywordTargetList":{"$ref":"#/components/schemas/RankedTargetWithThemedBidsList"}},"type":"object"},"RatingRange":{"description":"Rating range is restricted to integers between 0 and 5, inclusive. Min must be less than or equal to max. We use this to retrieve the number of targetable ASINs that falls within this rating range.","properties":{"max":{"format":"int32","type":"integer"},"min":{"format":"int32","type":"integer"}},"type":"object"},"RecKeywordTarget":{"properties":{"bidInfo":{"description":"A list of keyword bid info","items":{"allOf":[{"$ref":"#/components/schemas/KeywordBidInfo"}]},"maxItems":3,"minItems":0,"type":"array"},"keyword":{"description":"The keyword value","type":"string"},"recId":{"description":"The recommended keyword target id","type":"string"},"searchTermImpressionRank":{"description":"The account-level ad-attributed impression rank for the search-term/keyword. Provides [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 30 days. It tells an advertiser how many advertisers had higher share of ad impressions. This information is only available for keywords the advertiser targeted with ad impressions.","type":"number"},"searchTermImpressionShare":{"description":"The account-level ad-attributed impression share for the search-term/keyword. Provides percentage share of all ad impressions the advertiser has for the keyword in the last 30 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords. This information is only available for keywords the advertiser targeted with ad impressions.","format":"Double","type":"number"},"translation":{"description":"The translation of keyword if a locale is passed in","type":"string"},"userSelectedKeyword":{"description":"Flag that tells if keyword was selected by the user or was recommended by KRS","type":"boolean"}},"type":"object"},"Recommendation":{"properties":{"campaignId":{"description":"The identifier of the campaign.","type":"string"},"forecastEstimates":{"$ref":"#/components/schemas/ForecastEstimates"},"recommendationDetails":{"$ref":"#/components/schemas/RecommendationDetails"},"recommendationType":{"$ref":"#/components/schemas/RecommendationType"}},"required":["campaignId","recommendationDetails","recommendationType"],"type":"object"},"RecommendationDetails":{"anyOf":[{"required":["shopperCohortBiddingRecommendation"]},{"required":["budgetRecommendation"]},{"required":["biddingStrategyRecommendation"]},{"required":["targetingGroupBidRecommendations"]},{"required":["keywordTargetingRecommendations"]},{"required":["placementBiddingRecommendations"]}],"description":"Contains one or more recommendation details of different types.","properties":{"biddingStrategyRecommendation":{"$ref":"#/components/schemas/BiddingStrategyRecommendation"},"budgetRecommendation":{"$ref":"#/components/schemas/BudgetRecommendation"},"keywordTargetingRecommendations":{"description":"List of keyword targeting recommendations.","items":{"$ref":"#/components/schemas/KeywordTargetingRecommendation"},"maxItems":10,"minItems":1,"type":"array"},"placementBiddingRecommendations":{"description":"List of placement bid recommendations.","items":{"$ref":"#/components/schemas/PlacementBiddingRecommendation"},"maxItems":10,"minItems":1,"type":"array"},"shopperCohortBiddingRecommendation":{"$ref":"#/components/schemas/ShopperCohortBiddingRecommendation"},"targetingGroupBidRecommendations":{"description":"List of targeting group bid recommendations.","items":{"$ref":"#/components/schemas/TargetingGroupBidRecommendation"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"},"RecommendationOptions":{"properties":{"locale":{"description":"Translations are for readability and do not affect the targeting of ads. Supported marketplace to locale mappings can be found at the \u003ca href\u003d\u0027https://advertising.amazon.com/API/docs/en-us/localization/#/Keyword%20Localization\u0027\u003ePOST /keywords/localize\u003c/a\u003e endpoint. Note: Translations will be null if locale is unsupported.","enum":["ar_EG","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SA","en_SG","en_US","es_ES","es_MX","fr_FR","it_IT","ja_JP","nl_NL","pl_PL","pt_BR","sv_SE","tr_TR","zh_CN"],"type":"string"},"maxRecommendations":{"default":"200","description":"The max size of recommended target. Set it to 0 if you only want to rank user-defined keywords.","maximum":200,"minimum":0,"type":"number"},"sortDimension":{"description":"The ranking metric value. Supported values: CLICKS, CONVERSIONS, DEFAULT. DEFAULT will be applied if no value passed in.","enum":["CLICKS","CONVERSIONS","DEFAULT"],"type":"string"}}},"RecommendationType":{"description":"Type of recommendations requested.\n| Value | Description |\n| --- | --- |\n| `BIDDING_STRATEGY`  | Recommendation for the campaign bidding strategy. |\n| `KEYWORD`           | Recommendations related to campaign keywords targeting. |\n| `KEYWORD_GROUP`     | Recommendation related to Keyword groups. Keyword Groups is a new control for Amazon Ads Sponsored Products keyword-based campaigns that enables advertisers to reach relevant audiences through a collection of keywords. |\n| `BUDGET_STRATEGY`   | Recommendation for the campaign budget.|\n| `PLACEMENT_BIDDING` | Bid recommendations for campaign placements such as top of search, rest of search etc. |\n| `SHOPPER_COHORT`    | Bid adjustment recommendations for the shopper cohorts (audiences) attached to the campaign.|","enum":["BIDDING_STRATEGY","BUDGET_STRATEGY","KEYWORD","KEYWORD_GROUP","PLACEMENT_BIDDING","SHOPPER_COHORT"],"type":"string"},"Recurrence":{"properties":{"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","items":{"$ref":"#/components/schemas/DayOfWeek"},"type":"array"},"intraDaySchedule":{"description":"List of objects representing start and end time of desired intra-day budget rule window","items":{"$ref":"#/components/schemas/timeOfDay"},"maxItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/RecurrenceType"}},"type":"object"},"RecurrenceType":{"description":"The frequency of the rule application.","enum":["DAILY"],"type":"string"},"Refinements":{"description":"Response object for the GetRefinementsForCategory API, containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.","properties":{"ageRanges":{"$ref":"#/components/schemas/AgeRanges"},"brands":{"$ref":"#/components/schemas/Brands"},"genres":{"$ref":"#/components/schemas/Genres"}},"type":"object"},"RefinementsLoP":{"description":"Response object for the POST /sp/targets/category/{categoryId}/refinements endpoint, containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.","properties":{"ageRanges":{"$ref":"#/components/schemas/AgeRangesLoP"},"brands":{"$ref":"#/components/schemas/BrandsLoP"},"genres":{"$ref":"#/components/schemas/GenresLoP"}},"type":"object"},"RuleAction":{"description":"The action taken when the campaign optimization rule is enabled. Defaults to adopt","enum":["ADOPT"],"type":"string"},"RuleCampaignId":{"description":"campaignId","type":"string"},"RuleCondition":{"properties":{"comparisonOperator":{"$ref":"#/components/schemas/ComparisonOperator"},"metricName":{"$ref":"#/components/schemas/RuleConditionMetric"},"threshold":{"description":"The performance threshold value.","format":"double","type":"number"}},"required":["comparisonOperator","metricName","threshold"],"type":"object"},"RuleConditionList":{"items":{"$ref":"#/components/schemas/RuleCondition"},"maxItems":3,"type":"array"},"RuleConditionMetric":{"description":"The advertising performance metric. ROAS is the only supported metric.","enum":["AVERAGE_BID","ROAS"],"type":"string"},"RuleCreationDate":{"description":"Time of campaign optimization rule creation in ISO 8061. Read-only.","type":"string"},"RuleDuration":{"properties":{"dateRangeTypeRuleDuration":{"$ref":"#/components/schemas/DateRangeTypeRuleDuration"},"eventTypeRuleDuration":{"$ref":"#/components/schemas/EventTypeRuleDuration"}},"type":"object"},"RuleName":{"description":"The campaign optimization rule name.","maxLength":355,"type":"string"},"RuleNotification":{"properties":{"campaignId":{"$ref":"#/components/schemas/RuleCampaignId"},"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"notificationString":{"description":"Explains why the rule state is disabled","type":"string"},"ruleState":{"$ref":"#/components/schemas/RuleState"}},"type":"object"},"RuleNotificationError":{"properties":{"Error":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"},"campaignId":{"$ref":"#/components/schemas/RuleCampaignId"}},"type":"object"},"RuleRecommendation":{"properties":{"campaignId":{"$ref":"#/components/schemas/RuleCampaignId"},"performanceMetrics":{"$ref":"#/components/schemas/RuleRecommendationMetrics"},"performanceMetricsExists":{"description":"If true, performance metrics for the campaign are available in performanceMetrics response field.","type":"boolean"}},"type":"object"},"RuleRecommendationError":{"properties":{"Error":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"},"campaignId":{"$ref":"#/components/schemas/RuleCampaignId"}},"type":"object"},"RuleRecommendationMetrics":{"description":"Performance Metrics supported by the rule recommendation","properties":{"roas":{"description":"return on ad spend value","format":"double","type":"number"}},"type":"object"},"RuleState":{"description":"The campaign optimization rule state.","enum":["DISABLED","ENABLED"],"type":"string"},"RuleStatus":{"description":"The campaign optimization rule status. Read-Only","enum":["ACTIVE","ARCHIVED"],"type":"string"},"RuleType":{"description":"The type of the campaign optimization rule. Only Support BID as of now","enum":["BID","KEYWORD","PRODUCT"],"type":"string"},"SPBudgetRule":{"properties":{"createdDate":{"description":"Epoch time of budget rule creation. Read-only.","format":"int64","type":"number"},"lastUpdatedDate":{"description":"Epoch time of budget rule update. Read-only.","format":"int64","type":"number"},"ruleDetails":{"$ref":"#/components/schemas/SPBudgetRuleDetails"},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleState":{"$ref":"#/components/schemas/state"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}},"required":["ruleId"],"type":"object"},"SPBudgetRuleDetails":{"description":"Object representing details of a budget rule for SP campaign","properties":{"budgetIncreaseBy":{"$ref":"#/components/schemas/budgetIncreaseBy"},"duration":{"$ref":"#/components/schemas/RuleDuration"},"name":{"description":"The budget rule name. Required to be unique within a campaign.","maxLength":355,"type":"string"},"performanceMeasureCondition":{"$ref":"#/components/schemas/PerformanceMeasureCondition"},"recurrence":{"$ref":"#/components/schemas/Recurrence"},"ruleType":{"$ref":"#/components/schemas/SPRuleType"}},"type":"object"},"SPBudgetRulesRecommendationError":{"description":"The Error Response Object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SPBudgetRulesRecommendationEvent":{"properties":{"endDate":{"description":"The end date in YYYYMMDD format.","type":"string"},"eventId":{"description":"The event identifier.","type":"string"},"eventName":{"description":"The event name.","type":"string"},"startDate":{"description":"The start date in YYYYMMDD format.","type":"string"},"suggestedBudgetIncreasePercent":{"description":"The suggested budget increase expressed as a percent.","type":"number"}},"type":"object"},"SPBudgetRulesRecommendationEventRequest":{"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"}},"required":["campaignId"],"type":"object"},"SPBudgetRulesRecommendationEventResponse":{"description":"Special events with date range and suggested budget increase.","properties":{"recommendedBudgetRuleEvents":{"description":"A list of recommended special events with date range and suggested budget increase.","items":{"$ref":"#/components/schemas/SPBudgetRulesRecommendationEvent"},"type":"array"}},"type":"object"},"SPCampaignBudgetRule":{"properties":{"createdDate":{"description":"Epoch time of budget rule creation. Read-only.","format":"int64","type":"number"},"lastUpdatedDate":{"description":"Epoch time of budget rule update. Read-only.","format":"int64","type":"number"},"ruleDetails":{"$ref":"#/components/schemas/SPBudgetRuleDetails"},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleState":{"$ref":"#/components/schemas/state"},"ruleStatus":{"description":"The budget rule evaluation status. Read-only.","type":"string"}},"required":["ruleId"],"type":"object"},"SPCampaignOptimizationNotificationAPIRequest":{"properties":{"campaignIds":{"description":"A list of campaign ids","items":{"$ref":"#/components/schemas/RuleCampaignId"},"maxItems":100,"type":"array"}},"required":["campaignIds"],"type":"object"},"SPCampaignOptimizationNotificationAPIResponse":{"properties":{"CampaignOptimizationNotifications":{"description":"List of successful campaign optimization notifications for campaigns.","items":{"$ref":"#/components/schemas/RuleNotification"},"maxItems":100,"type":"array"},"CampaignOptimizationRecommendationsError":{"description":"List of errors that occured when generating campaign optimization notifications.","items":{"$ref":"#/components/schemas/RuleNotificationError"},"maxItems":100,"type":"array"}},"type":"object"},"SPCampaignOptimizationRecommendationAPIResponse":{"properties":{"CampaignOptimizationRecommendations":{"description":"List of campaigns eligible for optimization rule.","items":{"$ref":"#/components/schemas/RuleRecommendation"},"maxItems":100,"type":"array"},"CampaignOptimizationRecommendationsError":{"description":"List of campaigns not eligible for optimization rule.","items":{"$ref":"#/components/schemas/RuleRecommendationError"},"maxItems":100,"type":"array"}},"type":"object"},"SPCampaignOptimizationRecommendationsAPIRequest":{"properties":{"campaignIds":{"description":"A list of campaign ids","items":{"$ref":"#/components/schemas/RuleCampaignId"},"maxItems":100,"type":"array"},"requirePerformanceMetrics":{"default":"true","description":"If set to false, eligible campaigns without a recommendation for performanceMetrics are also provided in response.Check performanceMetricsExists response field to know if performanceMetrics is available for eligible campaign.","type":"boolean"}},"required":["campaignIds"],"type":"object"},"SPGetAllRuleEventRequest":{"properties":{},"type":"object"},"SPGetAllRuleEventResponse":{"description":"All Special individual and grouped events with date range.","properties":{"events":{"description":"A list of individual events with date range.","items":{"$ref":"#/components/schemas/SPIndividualEvent"},"type":"array"},"groupedEvents":{"description":"A list of grouped events with date range.","items":{"$ref":"#/components/schemas/SPGroupedEvent"},"type":"array"}},"type":"object"},"SPGetAssociatedCampaignsResponse":{"properties":{"associatedCampaigns":{"description":"A list of campaigns that are associated to this budget rule.","items":{"$ref":"#/components/schemas/AssociatedCampaign"},"maxItems":30,"minItems":0,"type":"array"},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}},"type":"object"},"SPGetRuleEventError":{"description":"The Error Response Object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SPGroupedEvent":{"properties":{"endDate":{"description":"The end date in ISO-8601 format.","format":"date-time","type":"string"},"groupedEventId":{"description":"The grouped event identifier.","type":"string"},"groupedEventName":{"description":"The grouped event name.","type":"string"},"startDate":{"description":"The start date in ISO-8601 format.","format":"date-time","type":"string"}},"type":"object"},"SPIndividualEvent":{"properties":{"endDate":{"description":"The end date in ISO-8601 format.","format":"date-time","type":"string"},"eventId":{"description":"The event identifier.","type":"string"},"eventName":{"description":"The event name.","type":"string"},"startDate":{"description":"The start date in ISO-8601 format.","format":"date-time","type":"string"}},"type":"object"},"SPKeywordGroupsException":{"description":"Custom Exception message.","properties":{"details":{"description":"Human Readable message.","maxLength":64,"type":"string"},"errors":{"items":{"properties":{"errorCode":{"description":"Error Code. For informational purpose only.","enum":["DEPENDENCY_FAILURE","INTERNAL_ERROR","INVALID_REQUEST","NOT_FOUND","NOT_IMPLEMENTED","RATE_EXCEEDED","TIMEOUT","UNAUTHENTICATED","UNAUTHORIZED","UNAVAILABLE","UNSUPPORTED_MEDIA"],"maxLength":24,"type":"string"},"errorId":{"description":"ID to indicate the granular error. Rely only on this to programmatically handle errors.","type":"integer"},"errorMessage":{"description":"human readable error message for each error.","maxLength":255,"type":"string"}},"type":"object"},"maxItems":25,"minItems":1,"type":"array"},"httpStatusCode":{"description":"http status code.","maxLength":4,"type":"string"},"requestId":{"maxLength":32,"type":"string"}},"type":"object"},"SPListAssociatedBudgetRulesResponse":{"properties":{"associatedRules":{"description":"A list of associated budget rules.","items":{"$ref":"#/components/schemas/SPCampaignBudgetRule"},"type":"array"}},"type":"object"},"SPRuleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","enum":["PERFORMANCE","SCHEDULE"],"type":"string"},"SPTORBudgetRecommendationError":{"example":{"code":"200","details":"success"},"properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SPTargetingCountryErrors":{"description":"The Error Response Object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"countryCodes":{"description":"List of country codes this error returned for.","items":{"type":"string"},"type":"array"},"message":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SPTargetingError":{"description":"The Error Response Object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SearchBrandsRequest":{"description":"Request object for SearchBrands API.","properties":{"keyword":{"type":"string"}},"required":["keyword"],"type":"object"},"SevenDaysEstimatedOpportunities":{"properties":{"endDate":{"description":"End date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","type":"string"},"estimatedIncrementalClicksLower":{"description":"Lower bound of the estimated incremental clicks that could be gained if all optimizations are made.","type":"integer"},"estimatedIncrementalClicksUpper":{"description":"Upper bound of the estimated incremental clicks that could be gained if all optimizations are made.","type":"integer"},"startDate":{"description":"Start date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","type":"string"}}},"SevenDaysMissedOpportunities":{"properties":{"endDate":{"description":"End date of the date range for which missed opportunity metrics are provided (YYYYMMDD). Local time","type":"string"},"estimatedMissedClicksLower":{"description":"Lower bound estimate of the additional clicks the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period.","type":"integer"},"estimatedMissedClicksUpper":{"description":"Upper bound estimate of the additional clicks the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period.","type":"integer"},"estimatedMissedImpressionsLower":{"description":"Lower bound estimate of the additional impressions the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period.","type":"integer"},"estimatedMissedImpressionsUpper":{"description":"Upper bound estimate of the additional impressions the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period.","type":"integer"},"estimatedMissedSalesLower":{"description":"Lower bound estimate of the additional sales the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period. Provided in local currency.","type":"number"},"estimatedMissedSalesUpper":{"description":"Upper bound estimate of the additional sales the campaign might have generated if it had not run out of budget during the {startDate} to {endDate} period. Provided in local currency.","type":"number"},"percentTimeInBudget":{"description":"percentage of time the campaign is active with a budget. Provided as a decimal ranging from 0 to 1 (e.g. 0.76 means the campaign was in budget for 76% of the time between the startDate and endDate period)","type":"number"},"startDate":{"description":"Starting date of the date range for which missed opportunity metrics are provided (YYYYMMDD). Local time","type":"string"}},"type":"object"},"ShopperCohortBiddingRecommendation":{"properties":{"action":{"description":"Recommended action for shopper cohort bidding.","enum":["ADD","REMOVE","UPDATE"],"type":"string"},"audienceSegments":{"description":"List of audience segments for this recommendation.","items":{"$ref":"#/components/schemas/AudienceSegment"},"maxItems":10,"minItems":1,"type":"array"},"percentage":{"description":"Bid adjustment percentage (basis points, e.g., 900 \u003d 9%).","maximum":900,"minimum":0,"type":"integer"},"shopperCohortType":{"description":"Type of shopper cohort.","enum":["AUDIENCE_SEGMENT"],"type":"string"}},"required":["action","audienceSegments","percentage","shopperCohortType"],"type":"object"},"SpecialEvent":{"properties":{"benchmark":{"$ref":"#/components/schemas/Benchmark"},"budgetModifier":{"description":"Deprecated. The factor used to boost the recommended budget.","type":"number"},"dailyBudget":{"description":"Recommended daily budget for the new campaign during the special event period.","type":"number"},"endDate":{"description":"The end date of the special event in YYYYMMDD format.","type":"string"},"eventKey":{"description":"The key of the special event.","type":"string"},"eventName":{"description":"The name of the special event.","type":"string"},"startDate":{"description":"The start date of the special event in YYYYMMDD format.","type":"string"}}},"SponsoredProductsAccessDeniedErrorCode":{"enum":["ACCESS_DENIED"],"type":"string"},"SponsoredProductsAccessDeniedExceptionCode":{"enum":["ACCESS_DENIED"],"type":"string"},"SponsoredProductsAccessDeniedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsAdEligibilityError":{"description":"Errors related to ad eligibility","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsAdEligibilityErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsAdEligibilityErrorReason":{"enum":["AD_INELIGIBLE"],"type":"string"},"SponsoredProductsAdGroup":{"properties":{"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"defaultBid":{"description":"A bid value for use when no bid is specified for keywords in the ad group. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","type":"number"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsAdGroupExtendedData"},"globalAdGroupId":{"description":"The global adGroup identifier that manages this marketplace adGroup.","type":"string"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"}},"required":["adGroupId","campaignId","defaultBid","name","state"],"type":"object"},"SponsoredProductsAdGroupAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsAdGroupAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsAdGroupAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsAdGroupAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsAdGroupExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsAdGroupServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the AdGroup","items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsAdGroupFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationError"},"type":"array"},"index":{"description":"the index of the adGroup in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsAdGroupMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsAdGroupMutationErrorSelector":{"properties":{"applicableMarketplacesError":{"$ref":"#/components/schemas/SponsoredProductsApplicableMarketplacesError"},"biddingError":{"$ref":"#/components/schemas/SponsoredProductsBiddingError"},"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsAdGroupMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsAdGroupServingStatus":{"enum":["ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_STATUS_ENABLED","ENDED","OTHER","PENDING_REVIEW","PENDING_START_DATE","PORTFOLIO_ARCHIVED","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED","REJECTED"],"type":"string"},"SponsoredProductsAdGroupServingStatusDetail":{"properties":{"helpUrl":{"description":"A URL with additional information about the status identifier.","type":"string"},"message":{"description":"A human-readable description of the status identifier specified in the name field.","type":"string"},"name":{"$ref":"#/components/schemas/SponsoredProductsAdGroupServingStatusReason"}},"type":"object"},"SponsoredProductsAdGroupServingStatusReason":{"enum":["ADVERTISER_ARCHIVED_DETAIL","ADVERTISER_EXCEED_SPENDS_LIMIT_DETAIL","ADVERTISER_OUT_OF_BUDGET_DETAIL","ADVERTISER_PAUSED_DETAIL","ADVERTISER_PAYMENT_FAILURE_DETAIL","ADVERTISER_POLICING_PENDING_REVIEW_DETAIL","ADVERTISER_POLICING_SUSPENDED_DETAIL","AD_GROUP_ARCHIVED_DETAIL","AD_GROUP_INCOMPLETE_DETAIL","AD_GROUP_LOW_BID_DETAIL","AD_GROUP_PAUSED_DETAIL","AD_GROUP_POLICING_CREATIVE_REJECTED_DETAIL","AD_GROUP_POLICING_PENDING_REVIEW_DETAIL","AD_GROUP_STATUS_ENABLED_DETAIL","CAMPAIGN_ARCHIVED_DETAIL","CAMPAIGN_INCOMPLETE_DETAIL","CAMPAIGN_OUT_OF_BUDGET_DETAIL","CAMPAIGN_PAUSED_DETAIL","CAMPAIGN_STATUS_ENABLED_DETAIL","ENDED_DETAIL","OTHER","PENDING_REVIEW_DETAIL","PENDING_START_DATE_DETAIL","PORTFOLIO_ARCHIVED_DETAIL","PORTFOLIO_ENDED_DETAIL","PORTFOLIO_OUT_OF_BUDGET_DETAIL","PORTFOLIO_PAUSED_DETAIL","PORTFOLIO_PENDING_START_DATE_DETAIL","PORTFOLIO_STATUS_ENABLED_DETAIL","REJECTED_DETAIL"],"type":"string"},"SponsoredProductsAdGroupSuccessResponseItem":{"properties":{"adGroup":{"$ref":"#/components/schemas/SponsoredProductsAdGroup"},"adGroupId":{"description":"the adGroup ID","type":"string"},"index":{"description":"the index of the adGroup in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsAdServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_STATUS_ENABLED","AD_ARCHIVED","AD_CREATION_FAILED","AD_CREATION_OFFLINE_FAILED","AD_CREATION_OFFLINE_IN_PROGRESS","AD_CREATION_OFFLINE_PENDING","AD_ELIGIBLE","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","AD_INELIGIBLE","AD_LANDING_PAGE_NOT_AVAILABLE","AD_MISSING_DECORATION","AD_MISSING_IMAGE","AD_NOT_BUYABLE","AD_NOT_IN_BUYBOX","AD_NO_PURCHASABLE_OFFER","AD_OUT_OF_STOCK","AD_PAUSED","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_STATUS_LIVE","CAMPAIGN_ADS_NOT_DELIVERING","CAMPAIGN_ARCHIVED","CAMPAIGN_ENDED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_PENDING_START_DATE","CAMPAIGN_STATUS_ENABLED","ELIGIBLE","ENDED","INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE","MISSING_DECORATION","MISSING_IMAGE","NOT_BUYABLE","NOT_IN_BUYBOX","NO_INVENTORY","NO_PURCHASABLE_OFFER","OTHER","OUT_OF_STOCK","PENDING_REVIEW","PENDING_START_DATE","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED","REJECTED","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","STATUS_UNAVAILABLE","TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_BLOCKED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_POLICING_SUSPENDED","TARGETING_CLAUSE_STATUS_LIVE"],"type":"string"},"SponsoredProductsAdServingStatusDetail":{"properties":{"helpUrl":{"description":"A URL with additional information about the status identifier.","type":"string"},"message":{"description":"A human-readable description of the status identifier specified in the name field.","type":"string"},"name":{"$ref":"#/components/schemas/SponsoredProductsAdServingStatusReason"}},"type":"object"},"SponsoredProductsAdServingStatusReason":{"enum":["ACCOUNT_OUT_OF_BUDGET_DETAIL","ADULT_PRODUCT","ADVERTISER_ACCOUNT_OUT_OF_BUDGET_DETAIL","ADVERTISER_ARCHIVED_DETAIL","ADVERTISER_EXCEED_SPENDS_LIMIT_DETAIL","ADVERTISER_OUT_OF_BUDGET_DETAIL","ADVERTISER_PAUSED_DETAIL","ADVERTISER_PAYMENT_FAILURE_DETAIL","ADVERTISER_POLICING_PENDING_REVIEW_DETAIL","ADVERTISER_POLICING_SUSPENDED_DETAIL","ADVERTISER_STATUS_ENABLED_DETAIL","AD_ARCHIVED_DETAIL","AD_CREATION_OFFLINE_FAILED","AD_CREATION_OFFLINE_IN_PROGRESS","AD_CREATION_OFFLINE_PENDING","AD_GROUP_ARCHIVED_DETAIL","AD_GROUP_INCOMPLETE_DETAIL","AD_GROUP_LOW_BID_DETAIL","AD_GROUP_PAUSED_DETAIL","AD_GROUP_POLICING_CREATIVE_REJECTED_DETAIL","AD_GROUP_POLICING_PENDING_REVIEW_DETAIL","AD_GROUP_STATUS_ENABLED_DETAIL","AD_PAUSED_DETAIL","AD_POLICING_PENDING_REVIEW","AD_POLICING_PENDING_REVIEW_DETAIL","AD_POLICING_SUSPENDED_DETAIL","AD_STATUS_LIVE_DETAIL","ASIN_QUARANTINED","BRAND_REMOVED","CAMPAIGN_ADS_NOT_DELIVERING_DETAIL","CAMPAIGN_ARCHIVED_DETAIL","CAMPAIGN_INCOMPLETE_DETAIL","CAMPAIGN_OUT_OF_BUDGET_DETAIL","CAMPAIGN_PAUSED_DETAIL","CAMPAIGN_STATUS_ENABLED_DETAIL","CBA_NOT_SUPPORTED","CLOSED_GL","CP_INELIGIBLE","CP_INELIGIBLE_ASIN","CP_INELIGIBLE_UNKNOWN","CP_INELIGIBLE_VENDOR","ELIGIBLE_DETAIL","ENDED_DETAIL","INELIGIBLE_CONDITION","INVENTORY_INCOMPLETE","ITEM_MISSING","LANDING_PAGE_INELIGIBLE","LANDING_PAGE_NOT_AVAILABLE_DETAIL","MISSING_DECORATION_DETAIL","MISSING_IMAGE_DETAIL","MODERATION_ADULT_NOVELTY_PV_DETAIL","MODERATION_ADULT_PRODUCT_PV_DETAIL","MODERATION_ADULT_SOFTLINES_PV_DETAIL","MODERATION_CLAIM_WEIGHTLOSS_PV_DETAIL","MODERATION_CONTENT_NUDITY_PV_DETAIL","MODERATION_CONTENT_PROVOCATIVE_PV_DETAIL","MODERATION_CONTENT_SMOKING_PV_DETAIL","MODERATION_CRITICAL_EVENTS_PV_DETAIL","MODERATION_ERROR_404_PV_DETAIL","MODERATION_GRAPHICAL_SEXUAL_IMAGES_PV_DETAIL","MODERATION_HFSS_PRODUCT_PV_DETAIL","MODERATION_LANGUAGE_OFFENSIVE_PV_DETAIL","MODERATION_NOT_COMPLIANT_TO_AD_POLICY_PV_DETAIL","MODERATION_SMOKING_RELATED_PV_DETAIL","NOT_BUYABLE_DETAIL","NOT_IN_BUYBOX_DETAIL","NO_INVENTORY_DETAIL","NO_PURCHASABLE_OFFER_DETAIL","OFFER_MISSING_DETAIL","OTHER","OUT_OF_STOCK_DETAIL","PENDING_REVIEW_DETAIL","PENDING_START_DATE_DETAIL","PIR_RULE_EXCLUDED","PORTFOLIO_ARCHIVED_DETAIL","PORTFOLIO_ENDED_DETAIL","PORTFOLIO_OUT_OF_BUDGET_DETAIL","PORTFOLIO_PAUSED_DETAIL","PORTFOLIO_PENDING_START_DATE_DETAIL","PORTFOLIO_STATUS_ENABLED_DETAIL","REJECTED_DETAIL","RESTRICTED_GL","SECURITY_SCAN_PENDING_REVIEW","SECURITY_SCAN_REJECTED","SKU_DEFECTIVE","STATUS_UNAVAILABLE","TARGETING_CLAUSE_ARCHIVED_DETAIL","TARGETING_CLAUSE_BLOCKED_DETAIL","TARGETING_CLAUSE_PAUSED_DETAIL","TARGETING_CLAUSE_POLICING_SUSPENDED_DETAIL","TARGETING_CLAUSE_STATUS_LIVE_DETAIL","VARIATION_PARENT"],"type":"string"},"SponsoredProductsApplicableMarketplacesError":{"description":"Errors related to ad eligibility","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsApplicableMarketplacesErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsApplicableMarketplacesErrorReason":{"enum":["APPLICABLE_MARKETPLACES_MISMATCH_ERROR"],"type":"string"},"SponsoredProductsAsinFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":100,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SponsoredProductsQueryTermMatchType"}},"type":"object"},"SponsoredProductsAsinOwnershipError":{"description":"Errors related to author asin ownership","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsAsinOwnershipErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsAsinOwnershipErrorReason":{"enum":["ASIN_NOT_OWNED_BY_AUTHOR"],"type":"string"},"SponsoredProductsAudienceSegment":{"properties":{"audienceId":{"description":"`audienceId` is specified based on the `audienceSegmentType` used.","maxLength":20,"minLength":1,"type":"string"},"audienceSegmentType":{"$ref":"#/components/schemas/SponsoredProductsAudienceSegmentType"}},"required":["audienceId"],"type":"object"},"SponsoredProductsAudienceSegmentType":{"description":"DEPRECATED: This field is no longer used and any provided value will be ignored. The audience type is automatically determined via the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) by examining the Audience path. Audience IDs are guaranteed to be unique across all audience types, enabling this inference.\n| Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`\u003d`SPONSORED_PRODUCTS`, `targetTypeFilter`\u003d`AUDIENCE` and `pathsFilter` \u003d `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC`  | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`\u003d`SPONSORED_PRODUCTS`, `targetTypeFilter`\u003d`AUDIENCE` and `pathsFilter` \u003d `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|","enum":["BEHAVIOR_DYNAMIC","SPONSORED_ADS_AMC"],"type":"string"},"SponsoredProductsBiddingError":{"description":"Errors related to bids","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"lowerLimit":{"type":"string"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsBiddingErrorReason"},"upperLimit":{"type":"string"}},"required":["message","reason"],"type":"object"},"SponsoredProductsBiddingErrorReason":{"enum":["BID_AUDIENCES_MORE_THAN_ALLOWED","BID_GT_BUDGET","BID_INVALID_AUDIENCE_ID","BID_INVALID_AUDIENCE_SEGMENT_TYPE","BID_INVALID_PLACEMENT","BID_INVALID_SHOPPER_COHORT_TYPE","BID_MISSING_AUDIENCES","BID_OUT_OF_MARKET_PLACE_RANGE","BID_SHOPPER_COHORTS_MORE_THAN_ALLOWED"],"type":"string"},"SponsoredProductsBiddingStrategy":{"description":"The bidding strategy.\n| Value | Strategy name | Description |\n|----------------|---------------|-------------|\n| `LEGACY_FOR_SALES` | Dynamic bids - down only | Lowers your bids in real time when your ad may be less likely to convert to a sale. Campaigns created before the release of the bidding controls feature used this setting by default. |\n| `AUTO_FOR_SALES` | Dynamic bids - up and down | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `MANUAL` | Fixed bid | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `RULE_BASED` | Rule based bidding | See Rule based bidding documentation https://advertising.amazon.com/API/docs/en-us/sponsored-products/rule-based-bidding/overview |","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","OTHER","RULE_BASED"],"type":"string"},"SponsoredProductsBillingError":{"description":"Errors related to bids","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsBillingErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsBillingErrorReason":{"enum":["ADVERTISER_BILLING_SETUP_INCOMPLETE","ADVERTISER_SUSPENDED","BILLING_ACCOUNT_NOT_FOUND","EXPIRED_PAYMENT_METHOD","PAYMENT_PROFILE_NOT_FOUND","VETTING_FAILURE"],"type":"string"},"SponsoredProductsBudget":{"properties":{"budget":{"description":"Monetary value","format":"double","type":"number"},"budgetType":{"$ref":"#/components/schemas/SponsoredProductsBudgetType"},"effectiveBudget":{"description":"Monetary value","format":"double","type":"number"}},"required":["budget","budgetType"],"type":"object"},"SponsoredProductsBudgetError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsBudgetErrorReason"},"upperLimit":{"type":"string"}},"required":["message","reason"],"type":"object"},"SponsoredProductsBudgetErrorReason":{"enum":["BUDGETING_POLICY_INVALID","BUDGET_CURRENCY_DOES_NOT_MATCH_MARKETPLACE_SETTINGS","BUDGET_LT_DEFAULT_BIDS","BUDGET_LT_KEYWORD_BIDS","BUDGET_LT_PREDEFINED_TARGET_BIDS","BUDGET_OUT_OF_MARKET_PLACE_RANGE","BUDGET_TOO_HIGH","BUDGET_TOO_LOW","MISSING_BUDGETING_POLICY","MISSING_IN_BUDGET_FLAG"],"type":"string"},"SponsoredProductsBudgetType":{"enum":["DAILY","OTHER"],"type":"string"},"SponsoredProductsBulkAdGroupOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsAdGroupSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkCampaignNegativeKeywordOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkCampaignNegativeTargetingClauseOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetingClauseFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetingClauseSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkCampaignOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkKeywordOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsKeywordFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsKeywordSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkNegativeKeywordOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkNegativeTargetingClauseOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingClauseFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingClauseSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkProductAdOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsProductAdFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsProductAdSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsBulkTargetingClauseOperationResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsCampaign":{"properties":{"autoManageCampaign":{"type":"boolean"},"budget":{"$ref":"#/components/schemas/SponsoredProductsBudget"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"dynamicBidding":{"$ref":"#/components/schemas/SponsoredProductsDynamicBidding"},"endDate":{"description":"The format of the date is YYYY-MM-DD.","format":"date","nullable":true,"type":"string"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsCampaignExtendedData"},"globalCampaignId":{"description":"The global campaign identifier that manages this marketplace campaign.","type":"string"},"marketplaceBudgetAllocation":{"$ref":"#/components/schemas/SponsoredProductsMarketplaceBudgetAllocation"},"name":{"description":"The name of the campaign.","type":"string"},"offAmazonSettings":{"$ref":"#/components/schemas/SponsoredProductsOffAmazonSettings"},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"siteRestrictions":{"items":{"$ref":"#/components/schemas/SponsoredProductsSiteRestriction"},"maxItems":1,"minItems":1,"type":"array"},"startDate":{"description":"The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"},"tags":{"$ref":"#/components/schemas/SponsoredProductsTags"},"targetingType":{"$ref":"#/components/schemas/SponsoredProductsTargetingType"}},"required":["budget","campaignId","name","startDate","state","targetingType"],"type":"object"},"SponsoredProductsCampaignAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignAccessErrorSelector":{"properties":{"dateError":{"$ref":"#/components/schemas/SponsoredProductsDateError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsCampaignServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the Campaign","items":{"$ref":"#/components/schemas/SponsoredProductsCampaignServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsCampaignMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/SponsoredProductsBiddingError"},"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"budgetError":{"$ref":"#/components/schemas/SponsoredProductsBudgetError"},"currencyError":{"$ref":"#/components/schemas/SponsoredProductsCurrencyError"},"dateError":{"$ref":"#/components/schemas/SponsoredProductsDateError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignMutationFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationError"},"type":"array"},"index":{"description":"the index of the campaign in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignMutationSuccessResponseItem":{"properties":{"campaign":{"$ref":"#/components/schemas/SponsoredProductsCampaign"},"campaignId":{"description":"the campaign ID","type":"string"},"index":{"description":"the index of the campaign in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignNegativeKeyword":{"properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordExtendedData"},"globalKeywordId":{"description":"The global keyword identifier that manages this marketplace keyword.","type":"string"},"keywordId":{"description":"The identifier of the keyword.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsNegativeMatchType"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"}},"required":["campaignId","keywordId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignNegativeKeywordAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the Keyword","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsCampaignNegativeKeywordFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationError"},"type":"array"},"index":{"description":"the index of the campaign in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordMutationErrorSelector":{"properties":{"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignNegativeKeywordMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignNegativeKeywordSuccessResponseItem":{"properties":{"campaignNegativeKeyword":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeyword"},"campaignNegativeKeywordId":{"description":"the campaignNegativeKeyword ID","type":"string"},"index":{"description":"the index of the campaign in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignNegativeTargetingClause":{"properties":{"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"string"},"expression":{"description":"The CampaignNegativeTargetingClause expression.","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetingClauseExtendedData"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"resolvedExpression":{"description":"The resolved CampaignNegativeTargetingClause expression.","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["campaignId","expression","resolvedExpression","state","targetId"],"type":"object"},"SponsoredProductsCampaignNegativeTargetingClauseExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the CampaignNegativeTargetingClause","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsCampaignNegativeTargetingClauseFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationError"},"type":"array"},"index":{"description":"the index of the CampaignNegativeTargets in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignNegativeTargetingClauseSuccessResponseItem":{"properties":{"campaignNegativeTargetingClauseId":{"description":"the CampaignNegativeTargets ID","type":"string"},"campaignNegativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetingClause"},"index":{"description":"the index of the CampaignNegativeTargets in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsCampaignNegativeTargetsAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignNegativeTargetsAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignNegativeTargetsAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignNegativeTargetsMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsCampaignNegativeTargetsMutationErrorSelector":{"properties":{"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsCampaignNegativeTargetsMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsCampaignServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_STATUS_ENABLED","ENDED","OTHER","PENDING_REVIEW","PENDING_START_DATE","PORTFOLIO_ARCHIVED","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED","REJECTED"],"type":"string"},"SponsoredProductsCampaignServingStatusDetail":{"properties":{"helpUrl":{"description":"A URL with additional information about the status identifier.","type":"string"},"message":{"description":"A human-readable description of the status identifier specified in the name field.","type":"string"},"name":{"$ref":"#/components/schemas/SponsoredProductsCampaignServingStatusReason"}},"type":"object"},"SponsoredProductsCampaignServingStatusReason":{"enum":["ACCOUNT_OUT_OF_BUDGET_DETAIL","ADVERTISER_ARCHIVED_DETAIL","ADVERTISER_EXCEED_SPENDS_LIMIT_DETAIL","ADVERTISER_OUT_OF_BUDGET_DETAIL","ADVERTISER_PAUSED_DETAIL","ADVERTISER_PAYMENT_FAILURE_DETAIL","ADVERTISER_POLICING_PENDING_REVIEW_DETAIL","ADVERTISER_POLICING_SUSPENDED_DETAIL","CAMPAIGN_ARCHIVED_DETAIL","CAMPAIGN_INCOMPLETE_DETAIL","CAMPAIGN_OUT_OF_BUDGET_DETAIL","CAMPAIGN_PAUSED_DETAIL","CAMPAIGN_STATUS_ENABLED_DETAIL","ENDED_DETAIL","OTHER","PENDING_REVIEW_DETAIL","PENDING_START_DATE_DETAIL","PORTFOLIO_ARCHIVED_DETAIL","PORTFOLIO_ENDED_DETAIL","PORTFOLIO_OUT_OF_BUDGET_DETAIL","PORTFOLIO_PAUSED_DETAIL","PORTFOLIO_PENDING_START_DATE_DETAIL","PORTFOLIO_STATUS_ENABLED_DETAIL","REJECTED_DETAIL"],"type":"string"},"SponsoredProductsCreateAdGroup":{"properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"defaultBid":{"description":"A bid value for use when no bid is specified for keywords in the ad group. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","type":"number"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["campaignId","defaultBid","name","state"],"type":"object"},"SponsoredProductsCreateCampaign":{"properties":{"autoManageCampaign":{"type":"boolean"},"budget":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateBudget"},"dynamicBidding":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateDynamicBidding"},"endDate":{"description":"The format of the date is YYYY-MM-DD.","format":"date","nullable":true,"type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"offAmazonSettings":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateOffAmazonSettings"},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"siteRestrictions":{"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.\nIf this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business - as well as select sites and apps off Amazon.\nPlease note that: 1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU), and AMAZON_HAUL option is only available in US;\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions don’t support shopperCohortBidding setting, SITE_AMAZON_BUSINESS placementBidding setting and offAmazonSettings;\n4) Only AMAZON_BUSINESS option is ready for use at the moment.","items":{"$ref":"#/components/schemas/SponsoredProductsSiteRestriction"},"maxItems":1,"minItems":1,"type":"array"},"startDate":{"description":"Default: today\u0027s date. The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"},"tags":{"$ref":"#/components/schemas/SponsoredProductsTags"},"targetingType":{"$ref":"#/components/schemas/SponsoredProductsTargetingType"}},"required":["budget","name","state","targetingType"],"type":"object"},"SponsoredProductsCreateCampaignNegativeKeyword":{"properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeMatchType"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["campaignId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsCreateCampaignNegativeTargetingClause":{"properties":{"campaignId":{"description":"The identifier of the campaign to which this target is associated. CampaignNegativeTargetingClauses are only available for AUTO campaigns","type":"string"},"expression":{"description":"The NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["campaignId","expression","state"],"type":"object"},"SponsoredProductsCreateExpressionType":{"enum":["MANUAL"],"type":"string"},"SponsoredProductsCreateKeyword":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"string"},"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","nullable":true,"type":"number"},"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to zh_CN. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId","campaignId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsCreateKeywordTarget":{"description":"A keyword target.","properties":{"bid":{"description":"Bid associated with the target. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","minimum":0,"type":"number"},"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsKeywordMatchType"}},"required":["keyword","matchType"],"type":"object"},"SponsoredProductsCreateNegativeKeyword":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"string"},"campaignId":{"description":"The identifer of the campaign to which the keyword is associated.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId","campaignId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsCreateNegativeTargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"string"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"string"},"expression":{"description":"The NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId","campaignId","expression","state"],"type":"object"},"SponsoredProductsCreateOrUpdateBiddingStrategy":{"description":"The bidding strategy.\n`strategy` is required for create requests if dynamicBidding is provided, but is optional for update requests.\n| Value | Strategy name | Description |\n|----------------|---------------|-------------|\n| `LEGACY_FOR_SALES` | Dynamic bids - down only | Lowers your bids in real time when your ad may be less likely to convert to a sale. Campaigns created before the release of the bidding controls feature used this setting by default. |\n| `AUTO_FOR_SALES` | Dynamic bids - up and down | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `MANUAL` | Fixed bid | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `RULE_BASED` | Rule based bidding | See Rule based bidding documentation https://advertising.amazon.com/API/docs/en-us/sponsored-products/rule-based-bidding/overview |","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"type":"string"},"SponsoredProductsCreateOrUpdateBudget":{"properties":{"budget":{"description":"Monetary value","format":"double","type":"number"},"budgetType":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateBudgetType"}},"required":["budget","budgetType"],"type":"object"},"SponsoredProductsCreateOrUpdateBudgetType":{"enum":["DAILY"],"type":"string"},"SponsoredProductsCreateOrUpdateDynamicBidding":{"description":"Specifies bidding controls. DynamicBidding is optional for both Create and Update requests.\nFor Create Campaign requests, if you don\u0027t specify dynamicBidding, default strategy of `LEGACY_FOR_SALES` will be applied.","properties":{"placementBidding":{"items":{"$ref":"#/components/schemas/SponsoredProductsPlacementBidding"},"type":"array"},"shopperCohortBidding":{"description":"Specifies Shopper Cohorts based bid adjustment controls. `shopperCohortBidding` is optional for both Create and Update requests.\nYou can enable this control to adjust your bid based on the shopper cohorts. The percentage value set is the percentage of the original bid including any other bid adjustments such as `placementBidding`. For example, a `placementBidding` with 50% adjustment on a $1.00 bid would increase the bid to $1.50, and a `shopperCohortBidding` with 100% adjustment would further increase the bid to $3.00.","items":{"$ref":"#/components/schemas/SponsoredProductsShopperCohortBidding"},"maxItems":1,"minItems":0,"type":"array"},"strategy":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateBiddingStrategy"}},"type":"object"},"SponsoredProductsCreateOrUpdateEntityState":{"description":"Entity state for create or update operation","enum":["ENABLED","PAUSED","PROPOSED"],"type":"string"},"SponsoredProductsCreateOrUpdateMatchType":{"enum":["BROAD","EXACT","PHRASE"],"type":"string"},"SponsoredProductsCreateOrUpdateNegativeMatchType":{"enum":["NEGATIVE_BROAD","NEGATIVE_EXACT","NEGATIVE_PHRASE"],"type":"string"},"SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate":{"properties":{"type":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicateType"},"value":{"description":"The expression value","type":"string"}},"required":["type"],"type":"object"},"SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicateType":{"description":"The type of nagative targeting expression. You can only specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `ASIN_BRAND_SAME_AS` | Target the brand that is the same as the brand expressed. |\n| `ASIN_SAME_AS` | Target an ASIN that is the same as the ASIN expressed. |","enum":["ASIN_BRAND_SAME_AS","ASIN_SAME_AS"],"type":"string"},"SponsoredProductsCreateOrUpdateOffAmazonBudgetControlStrategy":{"description":"The budget control strategy for ads served off Amazon . `OffAmazonBudgetControlStrategy` is optional for create and update requests.\nValue |  Description |\n|-----------|------------|\n| `MAXIMIZE_REACH` | Prioritize more reach using your target settings. This setting may result in more impressions and opportunities for sales off Amazon. |\n| `MINIMIZE_SPEND` | Optimize ad delivery to minimize spending. This setting may result in fewer impressions off Amazon, but it can help control spend. |","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"],"type":"string"},"SponsoredProductsCreateOrUpdateOffAmazonSettings":{"description":"Settings that apply to ads served off Amazon. `OffAmazonSettings` is optional for both Create and Update requests.\nThis field is upcoming and is not ready for use.","properties":{"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateOffAmazonBudgetControlStrategy"}},"type":"object"},"SponsoredProductsCreateProductAd":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"asin":{"description":"The ASIN associated with the product. Defined for vendors only.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"customText":{"description":"The custom text to use for creating a custom text ad for the associated ASIN. Defined only for KDP Authors and Book Vendors in US marketplace.","maxLength":150,"minLength":50,"pattern":"^[^a-z\u003c\u003e^][^\u003c\u003e^]+$","type":"string"},"globalStoreSetting":{"$ref":"#/components/schemas/SponsoredProductsGlobalStoreSetting"},"sku":{"description":"The SKU associated with the product. Defined for seller accounts only.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId","campaignId","state"],"type":"object"},"SponsoredProductsCreateProductTarget":{"description":"A product target.","properties":{"bid":{"description":"Bid associated with the target. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","minimum":0,"type":"number"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionMatchType"},"target":{"description":"The product ASIN of the target.","type":"string"}},"required":["matchType","target"],"type":"object"},"SponsoredProductsCreateSponsoredProductsAdGroupsRequestContent":{"properties":{"adGroups":{"description":"An array of adGroups.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateAdGroup"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["adGroups"],"type":"object"},"SponsoredProductsCreateSponsoredProductsAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/SponsoredProductsBulkAdGroupOperationResponse"}},"required":["adGroups"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignNegativeKeywordsRequestContent":{"properties":{"campaignNegativeKeywords":{"description":"An array of campaignNegativeKeywords.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateCampaignNegativeKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaignNegativeKeywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignNegativeKeywordsResponseContent":{"properties":{"campaignNegativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeKeywordOperationResponse"}},"required":["campaignNegativeKeywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignNegativeTargetingClausesRequestContent":{"properties":{"campaignNegativeTargetingClauses":{"description":"An array of Campaign Negative TargetingClauses.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateCampaignNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaignNegativeTargetingClauses"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignNegativeTargetingClausesResponseContent":{"properties":{"campaignNegativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeTargetingClauseOperationResponse"}},"required":["campaignNegativeTargetingClauses"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignsRequestContent":{"properties":{"campaigns":{"description":"An array of campaigns.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateCampaign"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaigns"],"type":"object"},"SponsoredProductsCreateSponsoredProductsCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignOperationResponse"}},"required":["campaigns"],"type":"object"},"SponsoredProductsCreateSponsoredProductsKeywordsRequestContent":{"properties":{"keywords":{"description":"An array of keywords.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["keywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsKeywordsResponseContent":{"properties":{"keywords":{"$ref":"#/components/schemas/SponsoredProductsBulkKeywordOperationResponse"}},"required":["keywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsNegativeKeywordsRequestContent":{"properties":{"negativeKeywords":{"description":"An array of negativeKeywords.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateNegativeKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["negativeKeywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsNegativeKeywordsResponseContent":{"properties":{"negativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeKeywordOperationResponse"}},"required":["negativeKeywords"],"type":"object"},"SponsoredProductsCreateSponsoredProductsNegativeTargetingClausesRequestContent":{"properties":{"negativeTargetingClauses":{"description":"An array of negativeTargeting.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["negativeTargetingClauses"],"type":"object"},"SponsoredProductsCreateSponsoredProductsNegativeTargetingClausesResponseContent":{"properties":{"negativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeTargetingClauseOperationResponse"}},"required":["negativeTargetingClauses"],"type":"object"},"SponsoredProductsCreateSponsoredProductsProductAdsRequestContent":{"properties":{"productAds":{"description":"An array of ads.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateProductAd"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["productAds"],"type":"object"},"SponsoredProductsCreateSponsoredProductsProductAdsResponseContent":{"properties":{"productAds":{"$ref":"#/components/schemas/SponsoredProductsBulkProductAdOperationResponse"}},"required":["productAds"],"type":"object"},"SponsoredProductsCreateSponsoredProductsTargetingClausesRequestContent":{"properties":{"targetingClauses":{"description":"An array of targetingClauses.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["targetingClauses"],"type":"object"},"SponsoredProductsCreateSponsoredProductsTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"SponsoredProductsCreateTarget":{"description":"Target created in the target promotion group.","properties":{"manualTargetingAdGroupId":{"description":"The adGroupId of the manual-targeting campaign where the target belongs.","type":"string"},"targetId":{"description":"The id of the target that got created.","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsCreateTargetError":{"description":"Response object of failed target promotion group target.","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetErrorSelector"}},"type":"object"},"SponsoredProductsCreateTargetErrorSelector":{"oneOf":[{"properties":{"biddingError":{"$ref":"#/components/schemas/SponsoredProductsBiddingError"}},"required":["biddingError"],"title":"biddingError","type":"object"},{"properties":{"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"}},"required":["billingError"],"title":"billingError","type":"object"},{"properties":{"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"}},"required":["duplicateValueError"],"title":"duplicateValueError","type":"object"},{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"}},"required":["entityNotFoundError"],"title":"entityNotFoundError","type":"object"},{"properties":{"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"}},"required":["entityQuotaError"],"title":"entityQuotaError","type":"object"},{"properties":{"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"}},"required":["entityStateError"],"title":"entityStateError","type":"object"},{"properties":{"expressionTypeError":{"$ref":"#/components/schemas/SponsoredProductsExpressionTypeError"}},"required":["expressionTypeError"],"title":"expressionTypeError","type":"object"},{"properties":{"localeError":{"$ref":"#/components/schemas/SponsoredProductsLocaleError"}},"required":["localeError"],"title":"localeError","type":"object"},{"properties":{"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"}},"required":["malformedValueError"],"title":"malformedValueError","type":"object"},{"properties":{"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"}},"required":["missingValueError"],"title":"missingValueError","type":"object"},{"properties":{"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"}},"required":["parentEntityError"],"title":"parentEntityError","type":"object"},{"properties":{"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"}},"required":["rangeError"],"title":"rangeError","type":"object"},{"properties":{"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"}},"required":["otherError"],"title":"otherError","type":"object"},{"properties":{"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"}},"required":["internalServerError"],"title":"internalServerError","type":"object"},{"properties":{"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"}},"required":["invalidInputError"],"title":"invalidInputError","type":"object"},{"properties":{"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"required":["throttledError"],"title":"throttledError","type":"object"},{"properties":{"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"}},"required":["targetingClauseSetupError"],"title":"targetingClauseSetupError","type":"object"}]},"SponsoredProductsCreateTargetPromotionGroupTargetsBatchError":{"description":"Response object of failed target promotion group target.","properties":{"index":{"description":"index of the item in the request.","type":"string"},"subErrors":{"description":"A list of the errors encountered.","items":{"$ref":"#/components/schemas/SponsoredProductsError"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsBatchSuccess":{"description":"Response object of successfully created target promotion group target.","properties":{"index":{"description":"index of the item in the request.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroupTargetDetails"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsFailureResponseItem":{"description":"Response object of failed target promotion group target.","properties":{"errors":{"description":"Response object of failed target promotion group target.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetError"},"maxItems":10000,"minItems":0,"type":"array"},"expressionType":{"description":"The expression type of the target that was requested to be created.","type":"string"},"target":{"description":"The target that was requested to be created.","type":"string"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsRequestContent":{"description":"Request object for creating target promotion group targets in a target promotion group.","properties":{"targetPromotionGroupId":{"description":"The id of the target promotion group where the targets are being added.","type":"string"},"targets":{"description":"List of targets to be added to the target promotion group.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetRequest"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["targetPromotionGroupId"],"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsResponseContent":{"description":"Response object for creating target promotion group targets.","properties":{"errors":{"description":"List of targets that failed to create.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsFailureResponseItem"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"description":"List of successfully created targets.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsSuccessResponseItem"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsSuccessResponseItem":{"description":"Response object of successfully created target promotion group target.","properties":{"expressionType":{"description":"The expression type of the target that was requested to be created.","type":"string"},"target":{"description":"The target that was requested to be created.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/SponsoredProductsCreateTarget"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsV2RequestContent":{"description":"Request object for creating target promotion group targets in a target promotion group.","properties":{"targetPromotionGroupId":{"description":"The id of the target promotion group where the targets are being added.","type":"string"},"targets":{"description":"List of targets to be added to the target promotion group.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetRequestV2"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetPromotionGroupId"],"type":"object"},"SponsoredProductsCreateTargetPromotionGroupTargetsV2ResponseContent":{"description":"Response object for creating target promotion group targets.","properties":{"error":{"items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsBatchError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsBatchSuccess"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupsRequestContent":{"description":"Request object for creating a Target Promotion Group.","properties":{"adGroupId":{"description":"The adGroupId of the Ad Group of an Auto-Targeting campaign that will be part of the Target Promotion Group.","type":"string"},"adIds":{"description":"The list of adIds (optional) of the Ad Group of the Auto-Targeting campaign, that will be part of the Target Promotion Group. If this\n    list is empty, all the Product Ads under the Ad Group will be part of the Target Promotion Group.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"existingCampaignDetails":{"$ref":"#/components/schemas/SponsoredProductsExistingCampaignDetails"},"newCampaignDetails":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignDetails"}},"required":["adGroupId"],"type":"object"},"SponsoredProductsCreateTargetPromotionGroupsResponseContent":{"description":"Response object for creating a target promotion group.","properties":{"targetPromotionGroup":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroup"}},"type":"object"},"SponsoredProductsCreateTargetPromotionGroupsV2RequestContent":{"description":"Request object for creating a Target Promotion Group.","properties":{"adGroupId":{"description":"The adGroupId of the source Ad Group that will be part of the Target Promotion Group.","type":"string"},"adIds":{"description":"The list of adIds (optional) of the source Ad Group, that will be part of the Target Promotion Group. If this\n    list is not provided, all the Product Ads under the source Ad Group will be part of the Target Promotion Group.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"existingCampaignDetails":{"description":"List of existing manual campaign ad groups to be added in the Target Promotion Group. It must contain one keyword ad group, or one\n    product ad group, or both. The request will fail if this field is provided alongside newCampaignDetails.","items":{"$ref":"#/components/schemas/SponsoredProductsExistingAdGroup"},"maxItems":2,"minItems":1,"type":"array"},"newCampaignDetails":{"description":"List of new destination manual campaigns to be created as part of the Target Promotion Group. It must contain setting for the creation of\n     one keyword ad group, or one product ad group, or both. The request will fail if this field is provided alongside existingCampaignDetails.","items":{"$ref":"#/components/schemas/SponsoredProductsNewCampaign"},"maxItems":2,"minItems":1,"type":"array"},"targetPromotionGroupName":{"description":"The name of the target promotion group that will be created.","type":"string"}},"required":["adGroupId","targetPromotionGroupName"],"type":"object"},"SponsoredProductsCreateTargetPromotionGroupsV2ResponseContent":{"description":"Response object for creating a target promotion group.","properties":{"targetPromotionGroup":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroupV2"}},"type":"object"},"SponsoredProductsCreateTargetRequest":{"description":"Request object for the target promotion group\u0027s target.","properties":{"bid":{"description":"Bid associated with the target. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","minimum":0,"type":"number"},"expressionType":{"description":"The match type (for KEYWORDs) or the expression type (for PRODUCT). One of QUERY_BROAD_MATCHES,\n    QUERY_EXACT_MATCHES, QUERY_PHRASE_MATCHES, ASIN_SAME_AS, ASIN_EXPANDED_FROM","type":"string"},"target":{"description":"The keyword or the product ASIN to be targeted.","type":"string"}},"required":["expressionType","target"],"type":"object"},"SponsoredProductsCreateTargetRequestV2":{"description":"Request object for target promotion group\u0027s target.","oneOf":[{"properties":{"keywordTarget":{"$ref":"#/components/schemas/SponsoredProductsCreateKeywordTarget"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/SponsoredProductsCreateProductTarget"}},"required":["productTarget"],"title":"productTarget","type":"object"}]},"SponsoredProductsCreateTargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"string"},"bid":{"description":"The bid for ads sourced using the target. Targets that do not have bid values in listTargetingClauses will inherit the defaultBid from the adGroup level. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","nullable":true,"type":"number"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"string"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"expressionType":{"$ref":"#/components/schemas/SponsoredProductsCreateExpressionType"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId","campaignId","expression","expressionType","state"],"type":"object"},"SponsoredProductsCreateTargetingExpressionPredicate":{"properties":{"type":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetingExpressionPredicateType"},"value":{"description":"The expression value","type":"string"}},"required":["type"],"type":"object"},"SponsoredProductsCreateTargetingExpressionPredicateType":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `ASIN_CATEGORY_SAME_AS` | Target the category that is the same as the category expressed. |\n| `ASIN_BRAND_SAME_AS` | Target the brand that is the same as the brand expressed. |\n| `ASIN_PRICE_LESS_THAN` | Target a price that is less than the price expressed. |\n| `ASIN_PRICE_BETWEEN` | Target a price that is between the prices expressed. |\n| `ASIN_PRICE_GREATER_THAN` | Target a price that is greater than the price expressed. |\n| `ASIN_REVIEW_RATING_LESS_THAN` | Target a review rating less than the review rating that is expressed. |\n| `ASIN_REVIEW_RATING_BETWEEN` | Target a review rating that is between the review ratings expressed. |\n| `ASIN_REVIEW_RATING_GREATER_THAN` | Target a review rating that is greater than the review rating expressed. |\n| `ASIN_SAME_AS` | Target an ASIN that is the same as the ASIN expressed. |\n| `ASIN_IS_PRIME_SHIPPING_ELIGIBLE` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `ASIN_AGE_RANGE_SAME_AS` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `ASIN_GENRE_SAME_AS` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `ASIN_EXPANDED_FROM` | Target products similar in performance to the ASIN expressed.   |\n| `KEYWORD_GROUP_SAME_AS` | Target the keyword group that is the same as the keyword group expressed (Beta coming soon). |","enum":["ASIN_AGE_RANGE_SAME_AS","ASIN_BRAND_SAME_AS","ASIN_CATEGORY_SAME_AS","ASIN_EXPANDED_FROM","ASIN_GENRE_SAME_AS","ASIN_IS_PRIME_SHIPPING_ELIGIBLE","ASIN_PRICE_BETWEEN","ASIN_PRICE_GREATER_THAN","ASIN_PRICE_LESS_THAN","ASIN_REVIEW_RATING_BETWEEN","ASIN_REVIEW_RATING_GREATER_THAN","ASIN_REVIEW_RATING_LESS_THAN","ASIN_SAME_AS","KEYWORD_GROUP_SAME_AS"],"type":"string"},"SponsoredProductsCurrencyError":{"description":"Errors related to currency","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsCurrencyErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsCurrencyErrorReason":{"enum":["CANNOT_UPDATE_CURRENCY","CURRENCY_NOT_MATCHING_PREFERRED_CURRENCY","CURRENCY_NOT_SUPPORTED","PREFERRED_CURRENCY_NOT_SET"],"type":"string"},"SponsoredProductsDateError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsDateErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsDateErrorReason":{"enum":["END_DATE_EARLIER_THAN_TODAY","END_DATE_LATER_THAN_MAXIMUM","INVALID_DATE","START_DATE_AFTER_END_DATE","START_DATE_EARLIER_THAN_TODAY","START_DATE_LATER_THAN_MAXIMUM","UPDATING_ENDED_CAMPAIGN_WITHOUT_EXTENSION","UPDATING_READ_ONLY_END_DATE","UPDATING_READ_ONLY_START_DATE"],"type":"string"},"SponsoredProductsDeleteSponsoredProductsAdGroupsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["adGroupIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/SponsoredProductsBulkAdGroupOperationResponse"}},"required":["adGroups"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignNegativeKeywordsRequestContent":{"properties":{"campaignNegativeKeywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["campaignNegativeKeywordIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignNegativeKeywordsResponseContent":{"properties":{"campaignNegativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeKeywordOperationResponse"}},"required":["campaignNegativeKeywords"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesRequestContent":{"properties":{"campaignNegativeTargetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["campaignNegativeTargetIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesResponseContent":{"properties":{"campaignNegativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeTargetingClauseOperationResponse"}},"required":["campaignNegativeTargetingClauses"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignsRequestContent":{"properties":{"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["campaignIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignOperationResponse"}},"required":["campaigns"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsKeywordsRequestContent":{"properties":{"keywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["keywordIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsKeywordsResponseContent":{"properties":{"keywords":{"$ref":"#/components/schemas/SponsoredProductsBulkKeywordOperationResponse"}},"required":["keywords"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsNegativeKeywordsRequestContent":{"properties":{"negativeKeywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["negativeKeywordIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsNegativeKeywordsResponseContent":{"properties":{"negativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeKeywordOperationResponse"}},"required":["negativeKeywords"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsNegativeTargetingClausesRequestContent":{"properties":{"negativeTargetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["negativeTargetIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsNegativeTargetingClausesResponseContent":{"properties":{"negativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeTargetingClauseOperationResponse"}},"required":["negativeTargetingClauses"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsProductAdsRequestContent":{"properties":{"adIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["adIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsProductAdsResponseContent":{"properties":{"productAds":{"$ref":"#/components/schemas/SponsoredProductsBulkProductAdOperationResponse"}},"required":["productAds"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsTargetingClausesRequestContent":{"properties":{"targetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"required":["targetIdFilter"],"type":"object"},"SponsoredProductsDeleteSponsoredProductsTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"SponsoredProductsDuplicateValueError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsDuplicateValueErrorReason":{"enum":["DUPLICATE_VALUE","MARKETPLACE_ATTRIBUTES_REPEATED","NAME_NOT_UNIQUE"],"type":"string"},"SponsoredProductsDynamicBidding":{"properties":{"placementBidding":{"items":{"$ref":"#/components/schemas/SponsoredProductsPlacementBidding"},"type":"array"},"shopperCohortBidding":{"description":"Specifies Shopper Cohorts based bid adjustment controls. `shopperCohortBidding` is optional for both Create and Update requests.\nYou can enable this control to adjust your bid based on the shopper cohorts. The percentage value set is the percentage of the original bid including any other bid adjustments such as `placementBidding`. For example, a `placementBidding` with 50% adjustment on a $1.00 bid would increase the bid to $1.50, and a `shopperCohortBidding` with 100% adjustment would further increase the bid to $3.00.","items":{"$ref":"#/components/schemas/SponsoredProductsShopperCohortBidding"},"maxItems":1,"minItems":0,"type":"array"},"strategy":{"$ref":"#/components/schemas/SponsoredProductsBiddingStrategy"}},"required":["strategy"],"type":"object"},"SponsoredProductsEntityNotFoundError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"entityId":{"description":"The entity id in the request","type":"string"},"entityType":{"$ref":"#/components/schemas/SponsoredProductsEntityType"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundErrorReason"}},"required":["entityId","entityType","message","reason"],"type":"object"},"SponsoredProductsEntityNotFoundErrorReason":{"enum":["ENTITY_NOT_FOUND"],"type":"string"},"SponsoredProductsEntityQuotaError":{"description":"Errors related to exceeding quota in campaign management service","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"entityType":{"$ref":"#/components/schemas/SponsoredProductsEntityType"},"message":{"description":"Human readable error message","type":"string"},"quota":{"description":"optional current quota","type":"string"},"quotaScope":{"$ref":"#/components/schemas/SponsoredProductsQuotaScope"},"reason":{"$ref":"#/components/schemas/SponsoredProductsQuotaErrorReason"}},"required":["entityType","message","reason"],"type":"object"},"SponsoredProductsEntityState":{"description":"The current resource state.\n| State | Description |\n| --- | --- |\n| `ENABLED` | Enabled State |\n| `PAUSED` | Paused State |\n| `PROPOSED` | Proposed State (Upcoming Feature) |\n| `ARCHIVED` | ARCHIVED State |\n| `ENABLING` | State for Draft Entity Only |\n| `USER_DELETED` | State for Draft Entity Only |\n| `OTHER` | Read Only |","enum":["ARCHIVED","ENABLED","ENABLING","OTHER","PAUSED","PROPOSED","USER_DELETED"],"type":"string"},"SponsoredProductsEntityStateError":{"description":"entity state update errors","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"entityType":{"$ref":"#/components/schemas/SponsoredProductsEntityType"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsEntityStateErrorReason"}},"required":["entityType","message","reason"],"type":"object"},"SponsoredProductsEntityStateErrorReason":{"enum":["ARCHIVED_ENTITY_CANNOT_BE_MODIFIED","AUTO_TARGETING_CLAUSE_CANNOT_BE_ARCHIVED_MANUALLY","INVALID_STATE_TRANSITION","INVALID_TARGET_STATE","MARKETPLACE_STATE_CANNOT_BE_ARCHIVED","PARENT_ARCHIVED_FORBIDS_UPDATES","PARENT_ENTITY_FORBIDS_CREATION","PARENT_STATUS_FORBIDS_UPDATES_AND_CREATES"],"type":"string"},"SponsoredProductsEntityStateFilter":{"description":"Filter entities by state. To filter live entities, only \u0027ENABLED\u0027, \u0027PAUSED\u0027 and \u0027ARCHIVED\u0027 can be used","properties":{"include":{"items":{"$ref":"#/components/schemas/SponsoredProductsEntityState"},"maxItems":10,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"SponsoredProductsEntityType":{"enum":["AD_GROUP","CAMPAIGN","CAMPAIGN_NEGATIVE_KEYWORD","CAMPAIGN_NEGATIVE_TARGETING_CLAUSE","KEYWORD","NEGATIVE_KEYWORD","NEGATIVE_TARGETING_CLAUSE","PRODUCT_AD","TARGETING_CLAUSE"],"type":"string"},"SponsoredProductsError":{"properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"type":"object"},"SponsoredProductsErrorCause":{"description":"Structure describing error cause - location in the payload and data causing error","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error","type":"string"},"trigger":{"description":"optional value causing error","type":"string"}},"required":["location"],"type":"object"},"SponsoredProductsExistingAdGroup":{"properties":{"adGroupId":{"description":"The id of the Ad Group.","type":"string"}},"required":["adGroupId"],"type":"object"},"SponsoredProductsExistingCampaignDetails":{"description":"The request object for creating a new target promotion group with existing campaigns. Please note that the adGroupIds provided need to\ncontain the same Ad ASINs/SKUs combination as the Auto-Targeting adGroup for the target promotion group.","properties":{"keywordCampaignAdGroupIds":{"description":"AdGroupIds of existing manual campaigns to be used as part of the Target Promotion Group for\n    promoting keyword targets.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1,"minItems":1,"type":"array"},"productCampaignAdGroupIds":{"description":"AdGroupIds of existing manual campaigns to be used as part of the Target Promotion Group for\n    promoting product targets.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"SponsoredProductsExpressionType":{"enum":["AUTO","MANUAL","OTHER"],"type":"string"},"SponsoredProductsExpressionTypeError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsExpressionTypeErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsExpressionTypeErrorReason":{"enum":["UNSUPPORTED_EXPRESSION_TYPE"],"type":"string"},"SponsoredProductsExpressionTypeFilter":{"description":"Filter entities by ExpressionType","properties":{"include":{"items":{"$ref":"#/components/schemas/SponsoredProductsExpressionType"},"maxItems":2,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"SponsoredProductsExpressionTypeWithoutOther":{"enum":["AUTO","MANUAL"],"type":"string"},"SponsoredProductsGetTargetPromotionGroupsRecommendationsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to 1000.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token for fetching the next page","type":"string"}},"type":"object"},"SponsoredProductsGetTargetPromotionGroupsRecommendationsResponseContent":{"properties":{"nextToken":{"description":"Token for fetching the next page","type":"string"},"targets":{"description":"List of optimized targets for the request, as recommended by Amazon heuristics","items":{"$ref":"#/components/schemas/SponsoredProductsRecommendedTarget"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"Total number of records available","type":"integer"}},"required":["targets","totalResults"],"type":"object"},"SponsoredProductsGlobalStoreSetting":{"properties":{"catalogSourceCountryCode":{"description":"Country code of source marketplace where seller has listed the product. Possible source country codes include US, UK, DE, JP, and AE.","maxLength":2,"minLength":2,"type":"string"}},"type":"object"},"SponsoredProductsInternalErrorErrorCode":{"enum":["INTERNAL_ERROR"],"type":"string"},"SponsoredProductsInternalServerError":{"description":"Error that represents non-retryable API service error. Sending the same request will result in another error.","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsInternalServerErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsInternalServerErrorCode":{"enum":["INTERNAL_SERVER_EXCEPTION"],"type":"string"},"SponsoredProductsInternalServerErrorReason":{"enum":["INTERNAL_ERROR"],"type":"string"},"SponsoredProductsInternalServerExceptionCode":{"enum":["INTERNAL_SERVER_EXCEPTION"],"type":"string"},"SponsoredProductsInternalServerExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInternalErrorErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsInvalidArgumentErrorCode":{"enum":["INVALID_ARGUMENT"],"type":"string"},"SponsoredProductsInvalidInputError":{"description":"Errors related to ad eligibility","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsInvalidInputErrorReason":{"enum":["INVALID_TOKEN"],"type":"string"},"SponsoredProductsKeyword":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"string"},"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only. Keywords that do not have bid values in listKeywords will inherit the defaultBid from the adGroup level. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","type":"number"},"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsKeywordExtendedData"},"globalKeywordId":{"description":"The global keyword identifier that manages this marketplace keyword.","type":"string"},"keywordId":{"description":"The identifier of the keyword.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to zh_CN. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"}},"required":["adGroupId","campaignId","keywordId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsKeywordAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsKeywordAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsKeywordAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"localeError":{"$ref":"#/components/schemas/SponsoredProductsLocaleError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsKeywordAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsKeywordAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsKeywordExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the Keyword","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsKeywordFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationError"},"type":"array"},"index":{"description":"the index of the keyword in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsKeywordMatchType":{"enum":["BROAD","EXACT","PHRASE"],"type":"string"},"SponsoredProductsKeywordMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsKeywordMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/SponsoredProductsBiddingError"},"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"localeError":{"$ref":"#/components/schemas/SponsoredProductsLocaleError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsKeywordMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsKeywordServingStatus":{"enum":["ACCOUNT_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","ADVERTISER_OUT_OF_BUDGET","ADVERTISER_PAUSED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_GROUP_PAUSED","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_STATUS_ENABLED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","CAMPAIGN_PAUSED","CAMPAIGN_STATUS_ENABLED","ENDED","OTHER","PENDING_REVIEW","PENDING_START_DATE","PORTFOLIO_ARCHIVED","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PAUSED","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_STATUS_ENABLED","REJECTED","TARGETING_CLAUSE_ARCHIVED","TARGETING_CLAUSE_BLOCKED","TARGETING_CLAUSE_PAUSED","TARGETING_CLAUSE_POLICING_SUSPENDED","TARGETING_CLAUSE_STATUS_LIVE"],"type":"string"},"SponsoredProductsKeywordServingStatusDetail":{"properties":{"helpUrl":{"description":"A URL with additional information about the status identifier.","type":"string"},"message":{"description":"A human-readable description of the status identifier specified in the name field.","type":"string"},"name":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusReason"}},"type":"object"},"SponsoredProductsKeywordServingStatusReason":{"enum":["ACCOUNT_OUT_OF_BUDGET_DETAIL","ADVERTISER_ARCHIVED_DETAIL","ADVERTISER_EXCEED_SPENDS_LIMIT_DETAIL","ADVERTISER_OUT_OF_BUDGET_DETAIL","ADVERTISER_PAUSED_DETAIL","ADVERTISER_PAYMENT_FAILURE_DETAIL","ADVERTISER_POLICING_PENDING_REVIEW_DETAIL","ADVERTISER_POLICING_SUSPENDED_DETAIL","AD_GROUP_ARCHIVED_DETAIL","AD_GROUP_INCOMPLETE_DETAIL","AD_GROUP_LOW_BID_DETAIL","AD_GROUP_PAUSED_DETAIL","AD_GROUP_POLICING_CREATIVE_REJECTED_DETAIL","AD_GROUP_POLICING_PENDING_REVIEW_DETAIL","AD_GROUP_STATUS_ENABLED_DETAIL","CAMPAIGN_ARCHIVED_DETAIL","CAMPAIGN_INCOMPLETE_DETAIL","CAMPAIGN_OUT_OF_BUDGET_DETAIL","CAMPAIGN_PAUSED_DETAIL","CAMPAIGN_STATUS_ENABLED_DETAIL","ENDED_DETAIL","OTHER","PENDING_REVIEW_DETAIL","PENDING_START_DATE_DETAIL","PORTFOLIO_ARCHIVED_DETAIL","PORTFOLIO_ENDED_DETAIL","PORTFOLIO_OUT_OF_BUDGET_DETAIL","PORTFOLIO_PAUSED_DETAIL","PORTFOLIO_PENDING_START_DATE_DETAIL","PORTFOLIO_STATUS_ENABLED_DETAIL","REJECTED_DETAIL","TARGETING_CLAUSE_ARCHIVED_DETAIL","TARGETING_CLAUSE_BLOCKED_DETAIL","TARGETING_CLAUSE_PAUSED_DETAIL","TARGETING_CLAUSE_POLICING_SUSPENDED_DETAIL","TARGETING_CLAUSE_STATUS_LIVE_DETAIL"],"type":"string"},"SponsoredProductsKeywordSuccessResponseItem":{"properties":{"index":{"description":"the index of the keyword in the array from the request body","format":"int32","minimum":0,"type":"integer"},"keyword":{"$ref":"#/components/schemas/SponsoredProductsKeyword"},"keywordId":{"description":"the keyword ID","type":"string"}},"required":["index"],"type":"object"},"SponsoredProductsKeywordTargetV2":{"description":"A keyword target.","properties":{"destinationAdGroupId":{"description":"The adGroupId of the destination manual-targeting adGroup where the target belongs.","type":"string"},"keywordId":{"description":"The id of the keyword target.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The match type (for KEYWORDs). One of EXACT, PHRASE, BROAD","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsKeywordTextFilter":{"description":"Filter by keywordText","properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SponsoredProductsQueryTermMatchType"}},"required":["queryTermMatchType"],"type":"object"},"SponsoredProductsListSponsoredProductsAdGroupsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"campaignTargetingTypeFilter":{"$ref":"#/components/schemas/SponsoredProductsTargetingType"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SponsoredProductsNameFilter"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsAdGroupsResponseContent":{"properties":{"adGroups":{"items":{"$ref":"#/components/schemas/SponsoredProductsAdGroup"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignNegativeKeywordsRequestContent":{"properties":{"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"campaignNegativeKeywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"campaignNegativeKeywordTextFilter":{"$ref":"#/components/schemas/SponsoredProductsKeywordTextFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"matchTypeFilter":{"description":"Restricts results to resources with the selected matchType","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeMatchType"},"type":"array"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignNegativeKeywordsResponseContent":{"properties":{"campaignNegativeKeywords":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeyword"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignNegativeTargetingClausesRequestContent":{"properties":{"asinFilter":{"$ref":"#/components/schemas/SponsoredProductsAsinFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"campaignNegativeTargetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignNegativeTargetingClausesResponseContent":{"properties":{"campaignNegativeTargetingClauses":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignsRequestContent":{"properties":{"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"marketplaceBudgetAllocationFilter":{"$ref":"#/components/schemas/SponsoredProductsMarketplaceBudgetAllocationFilter"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nameFilter":{"$ref":"#/components/schemas/SponsoredProductsNameFilter"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"portfolioIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsCampaignsResponseContent":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/SponsoredProductsCampaign"},"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsKeywordsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"keywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"keywordTextFilter":{"$ref":"#/components/schemas/SponsoredProductsKeywordTextFilter"},"locale":{"description":"Restricts results to keywords associated with locale","type":"string"},"matchTypeFilter":{"description":"Only the keyword with match type that is in this list will be listed","items":{"$ref":"#/components/schemas/SponsoredProductsMatchType"},"type":"array"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsKeywordsResponseContent":{"properties":{"keywords":{"items":{"$ref":"#/components/schemas/SponsoredProductsKeyword"},"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsNegativeKeywordsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"locale":{"description":"Restricts results to negativeKeywords that match the specified locale.","type":"string"},"matchTypeFilter":{"description":"Only the negativeKeyword with the match type that is in this list will be listed","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeMatchType"},"type":"array"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"negativeKeywordIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"negativeKeywordTextFilter":{"$ref":"#/components/schemas/SponsoredProductsKeywordTextFilter"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsNegativeKeywordsResponseContent":{"properties":{"negativeKeywords":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeyword"},"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsNegativeTargetingClausesRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"asinFilter":{"$ref":"#/components/schemas/SponsoredProductsAsinFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"negativeTargetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsNegativeTargetingClausesResponseContent":{"properties":{"negativeTargetingClauses":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsProductAdsRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"adIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsProductAdsResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"productAds":{"items":{"$ref":"#/components/schemas/SponsoredProductsProductAd"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListSponsoredProductsTargetingClausesRequestContent":{"properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"asinFilter":{"$ref":"#/components/schemas/SponsoredProductsAsinFilter"},"campaignIdFilter":{"$ref":"#/components/schemas/SponsoredProductsReducedObjectIdFilter"},"expressionTypeFilter":{"$ref":"#/components/schemas/SponsoredProductsExpressionTypeFilter"},"includeExtendedDataFields":{"description":"Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus","type":"boolean"},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API","format":"int32","type":"integer"},"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"stateFilter":{"$ref":"#/components/schemas/SponsoredProductsEntityStateFilter"},"targetIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"type":"object"},"SponsoredProductsListSponsoredProductsTargetingClausesResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"targetingClauses":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of entities","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupTargetsRequestContent":{"description":"Request object for querying target promotion group targets.","properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"maxResults":{"default":1000,"description":"The maximum number of results requested.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next or previous response page","type":"string"},"targetPromotionGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupTargetsResponseContent":{"description":"Response object for querying target promotion group targets.","properties":{"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the\n    request. If the nextToken field is empty, there are no further results.","type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SponsoredProductsTarget"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results available.","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupTargetsV2RequestContent":{"description":"Request object for querying target promotion group targets.","properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"maxResults":{"default":1000,"description":"The maximum number of results requested.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next or previous response page","type":"string"},"targetPromotionGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupTargetsV2ResponseContent":{"description":"Response object for querying target promotion group targets.","properties":{"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the\n    request. If the nextToken field is empty, there are no further results.","type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroupTargetDetails"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results available.","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupsRequestContent":{"description":"Request object for querying target promotion groups.","properties":{"adGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"maxResults":{"default":1000,"description":"The maximum number of results requested.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next or previous response page","type":"string"},"targetPromotionGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupsResponseContent":{"description":"Response object for querying target promotion groups.","properties":{"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the\n    request. If the nextToken field is empty, there are no further results.","type":"string"},"targetPromotionGroups":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroup"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results available.","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupsV2RequestContent":{"description":"Request object for querying target promotion groups.","properties":{"destinationAdGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"maxResults":{"default":1000,"description":"The maximum number of results requested.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value allowing to navigate to the next or previous response page","type":"string"},"sourceAdGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"},"targetPromotionGroupIdFilter":{"$ref":"#/components/schemas/SponsoredProductsObjectIdFilter"}},"type":"object"},"SponsoredProductsListTargetPromotionGroupsV2ResponseContent":{"description":"Response object for querying target promotion groups.","properties":{"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the\n    request. If the nextToken field is empty, there are no further results.","type":"string"},"targetPromotionGroups":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetPromotionGroupV2"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results available.","format":"int64","type":"integer"}},"type":"object"},"SponsoredProductsLocaleError":{"properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsLocaleErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsLocaleErrorReason":{"enum":["INVALID_LOCALE"],"type":"string"},"SponsoredProductsMalformedValueError":{"description":"Errors being used to represent malformed values\ne.g. containing not allowed characters, not following patters etc","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"fragment":{"description":"fragment of the value which is wrong","type":"string"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsMalformedValueErrorReason":{"enum":["BLANK","FORBIDDEN_CHARS","LEADING_OR_TRAILING_WHITESPACE","PATTERN_NOT_MATCHED","TOO_LONG","TOO_SHORT"],"type":"string"},"SponsoredProductsMarketplace":{"enum":["AE","AU","BR","CA","DE","EG","ES","FR","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","UK","US"],"type":"string"},"SponsoredProductsMarketplaceBudgetAllocation":{"description":"Setting for distribution of global budget into marketplaces in global campaign.\n\n| Value | Description |\n| ---------------------- | -------------------- |\n| `AUTO` | Auto distribute global budget to marketplaces in global campaign. Budget updates for marketplaces are not allowed for AUTO campaigns. The budget can only be updated in global campaign for AUTO campaigns. |\n|  `MANUAL`    | Manually distribute global budget to marketplaces in global campaign.     |","enum":["AUTO","MANUAL"],"type":"string"},"SponsoredProductsMarketplaceBudgetAllocationFilter":{"description":"Filter campaigns by MarketplaceBudgetAllocation setting. By default, only MANUAL campaigns are returned. This filter is not functional yet, will be functional soon.","properties":{"include":{"items":{"$ref":"#/components/schemas/SponsoredProductsMarketplaceBudgetAllocation"},"maxItems":2,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"SponsoredProductsMatchType":{"enum":["BROAD","EXACT","OTHER","PHRASE"],"type":"string"},"SponsoredProductsMissingValueError":{"description":"Error describing missing values in API payloads","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsMissingValueErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsMissingValueErrorReason":{"enum":["MISSING_VALUE"],"type":"string"},"SponsoredProductsNameFilter":{"description":"Filter entities by name","properties":{"include":{"items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"queryTermMatchType":{"$ref":"#/components/schemas/SponsoredProductsQueryTermMatchType"}},"type":"object"},"SponsoredProductsNegativeKeyword":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this keyword is associated.","type":"string"},"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordExtendedData"},"globalKeywordId":{"description":"The global keyword identifier that manages this marketplace keyword.","type":"string"},"keywordId":{"description":"The identifier of the keyword.","type":"string"},"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"$ref":"#/components/schemas/SponsoredProductsNegativeMatchType"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"}},"required":["adGroupId","campaignId","keywordId","keywordText","matchType","state"],"type":"object"},"SponsoredProductsNegativeKeywordAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsNegativeKeywordAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsNegativeKeywordAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsNegativeKeywordExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the Keyword","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsNegativeKeywordFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationError"},"type":"array"},"index":{"description":"the index of the negativeKeyword in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsNegativeKeywordMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsNegativeKeywordMutationErrorSelector":{"properties":{"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsNegativeKeywordMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsNegativeKeywordSuccessResponseItem":{"properties":{"index":{"description":"the index of the negativeKeyword in the array from the request body","format":"int32","minimum":0,"type":"integer"},"negativeKeyword":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeyword"},"negativeKeywordId":{"description":"the negativeKeyword ID","type":"string"}},"required":["index"],"type":"object"},"SponsoredProductsNegativeMatchType":{"enum":["NEGATIVE_BROAD","NEGATIVE_EXACT","NEGATIVE_PHRASE","OTHER"],"type":"string"},"SponsoredProductsNegativeTargetAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsNegativeTargetAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsNegativeTargetAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsNegativeTargetMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsNegativeTargetMutationErrorSelector":{"properties":{"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsNegativeTargetMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsNegativeTargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"string"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"string"},"expression":{"description":"The NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingClauseExtendedData"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"resolvedExpression":{"description":"The resolved NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["adGroupId","campaignId","expression","resolvedExpression","state","targetId"],"type":"object"},"SponsoredProductsNegativeTargetingClauseExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the NegativeTargetingClause","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsNegativeTargetingClauseFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationError"},"type":"array"},"index":{"description":"the index of the NegativeTargetingClause in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsNegativeTargetingClauseSuccessResponseItem":{"properties":{"index":{"description":"the index of the NegativeTargetingClause in the array from the request body","format":"int32","minimum":0,"type":"integer"},"negativeTargetingClause":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingClause"},"targetId":{"description":"the NegativeTargetingClause ID","type":"string"}},"required":["index"],"type":"object"},"SponsoredProductsNegativeTargetingExpressionPredicate":{"properties":{"type":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetingExpressionPredicateType"},"value":{"description":"The expression value","type":"string"}},"type":"object"},"SponsoredProductsNegativeTargetingExpressionPredicateType":{"description":"The type of nagative targeting expression. You can only specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `ASIN_BRAND_SAME_AS` | Target the brand that is the same as the brand expressed. |\n| `ASIN_SAME_AS` | Target an ASIN that is the same as the ASIN expressed. |\n| `OTHER` | Other Type.   |","enum":["ASIN_BRAND_SAME_AS","ASIN_SAME_AS","OTHER"],"type":"string"},"SponsoredProductsNewAdGroup":{"properties":{"adGroupName":{"description":"The name of the new ad group.","type":"string"},"defaultBid":{"description":"The default bid value that gets applied if no bid is provided for the target. For more information about bid constraints by marketplace,\n    see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","minimum":0,"type":"number"},"targetingTypes":{"description":"List of targeting types to be used for targets in the ad group. Supported types are KEYWORD and PRODUCT.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["adGroupName","defaultBid","targetingTypes"],"type":"object"},"SponsoredProductsNewCampaign":{"properties":{"adGroups":{"description":"List of ad groups to be created inside the new campaign.","items":{"$ref":"#/components/schemas/SponsoredProductsNewAdGroup"},"maxItems":1,"minItems":1,"type":"array"},"budget":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignBudget"},"campaignName":{"description":"The campaign name.","type":"string"},"dynamicBidding":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignDynamicBidding"},"endDate":{"description":"The end date of the new target promotion group entities. The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"startDate":{"description":"The start date of the new target promotion group entities. Default is today\u0027s date. The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"tags":{"$ref":"#/components/schemas/SponsoredProductsTags"}},"required":["adGroups","budget","campaignName"],"type":"object"},"SponsoredProductsNewCampaignBudget":{"description":"The budget for the campaigns in the target promotion group.","properties":{"budget":{"description":"The value of the budget.","format":"double","minimum":0,"type":"number"},"budgetType":{"description":"DAILY.","type":"string"}},"required":["budget","budgetType"],"type":"object"},"SponsoredProductsNewCampaignDetails":{"description":"The request object for creating a new target promotion group with new campaigns.","properties":{"budget":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignBudget"},"defaultBid":{"description":"The default bid value that gets applied if no bid is provided for the target. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","minimum":0,"type":"number"},"dynamicBidding":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignDynamicBidding"},"endDate":{"description":"The end date of the new target promotion group entities. The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"namePrefix":{"description":"The name prefix to be used for the entities under the target promotion group. e.g. if the namePrefix\n    is ABC, we will create a keyword campaign with the name \u0027ABC-ManualKeywordTargeting-Campaign-AutoGenerated\u0027","type":"string"},"startDate":{"description":"The start date of the new target promotion group entities. Default is today\u0027s date. The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"tags":{"$ref":"#/components/schemas/SponsoredProductsTags"}},"required":["budget","defaultBid","namePrefix"],"type":"object"},"SponsoredProductsNewCampaignDynamicBidding":{"description":"Specifies bidding controls.","properties":{"placementBidding":{"description":"The product placement.","items":{"$ref":"#/components/schemas/SponsoredProductsNewCampaignPlacementBidding"},"maxItems":3,"minItems":0,"type":"array"},"strategy":{"description":"One of LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL, RULE_BASED.","type":"string"}},"required":["strategy"],"type":"object"},"SponsoredProductsNewCampaignPlacementBidding":{"description":"The product placement.","properties":{"percentage":{"description":"The bidding placement percentage.","format":"int32","type":"integer"},"placement":{"description":"The bidding placement. One of PLACEMENT_TOP, PLACEMENT_PRODUCT_PAGE, PLACEMENT_REST_OF_SEARCH.","type":"string"}},"required":["percentage","placement"],"type":"object"},"SponsoredProductsNotImplementedExceptionCode":{"enum":["NOT_IMPLEMENTED"],"type":"string"},"SponsoredProductsNotImplementedExceptionResponseContent":{"description":"Operation is not implemented.","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionCode"},"message":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SponsoredProductsObjectIdFilter":{"description":"Filter entities by the list of objectIds","properties":{"include":{"items":{"description":"entity object identifier","type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"SponsoredProductsOffAmazonBudgetControlStrategy":{"enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"],"type":"string"},"SponsoredProductsOffAmazonSettings":{"properties":{"offAmazonBudgetControlStrategy":{"$ref":"#/components/schemas/SponsoredProductsOffAmazonBudgetControlStrategy"}},"type":"object"},"SponsoredProductsOtherError":{"description":"Errors not related to any of the other error types","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsOtherErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsOtherErrorReason":{"enum":["OTHER_ERROR"],"type":"string"},"SponsoredProductsParentEntityError":{"description":"Errors related to parent entity","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsParentEntityErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsParentEntityErrorReason":{"enum":["PARENT_ENTITY_ARCHIVED","PARENT_ENTITY_DOES_NOT_TARGET_THESE_MARKETPLACES","PARENT_ENTITY_NOT_FOUND"],"type":"string"},"SponsoredProductsPlacement":{"description":"You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% Top of Search adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a Top of Search placement. A further 100% Amazon Business adjustment would increase the bid to $3.00 for the Amazon Business Top of Search placement and to $2.00 for all other Amazon Business placements.\nThe Amazon Business Bid Adjustment and Reporting for Sponsored Products will be coming soon to Bulksheets.\n| Predicate |  Placement |\n|-----------|------------|\n| `PLACEMENT_TOP` | Top of search (first page) |\n| `PLACEMENT_PRODUCT_PAGE` | Product pages |\n| `PLACEMENT_REST_OF_SEARCH` | Rest of the search |\n| `SITE_AMAZON_BUSINESS` | Site Amazon Business |","enum":["PLACEMENT_PRODUCT_PAGE","PLACEMENT_REST_OF_SEARCH","PLACEMENT_TOP","SITE_AMAZON_BUSINESS"],"type":"string"},"SponsoredProductsPlacementBidding":{"properties":{"percentage":{"format":"int32","maximum":900,"minimum":0,"type":"integer"},"placement":{"$ref":"#/components/schemas/SponsoredProductsPlacement"}},"type":"object"},"SponsoredProductsProductAd":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"string"},"adId":{"description":"The product ad identifier.","type":"string"},"asin":{"description":"The ASIN associated with the product. Defined for vendors only.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"customText":{"description":"The custom text that is associated with this ad. Defined for custom text ads only.","type":"string"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsProductAdExtendedData"},"globalAdId":{"description":"The global ad identifier that manages this marketplace ad.","type":"string"},"globalStoreSetting":{"$ref":"#/components/schemas/SponsoredProductsGlobalStoreSetting"},"sku":{"description":"The SKU associated with the product. Defined for seller accounts only.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"}},"required":["adGroupId","adId","campaignId","state"],"type":"object"},"SponsoredProductsProductAdAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsProductAdAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsProductAdAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsProductAdAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsProductAdAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsProductAdExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsAdServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the Ad","items":{"$ref":"#/components/schemas/SponsoredProductsAdServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsProductAdFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationError"},"type":"array"},"index":{"description":"the index of the product ad in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsProductAdMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsProductAdMutationErrorSelector":{"properties":{"adEligibilityError":{"$ref":"#/components/schemas/SponsoredProductsAdEligibilityError"},"asinOwnershipError":{"$ref":"#/components/schemas/SponsoredProductsAsinOwnershipError"},"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"productIdentifierError":{"$ref":"#/components/schemas/SponsoredProductsProductIdentifierError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"},"unsupportedOperationError":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedOperationError"}},"type":"object"},"SponsoredProductsProductAdMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsProductAdSuccessResponseItem":{"properties":{"adId":{"description":"the ProductAd ID","type":"string"},"index":{"description":"The index in the original list from the request.","format":"int32","minimum":0,"type":"integer"},"productAd":{"$ref":"#/components/schemas/SponsoredProductsProductAd"}},"required":["index"],"type":"object"},"SponsoredProductsProductIdentifierError":{"description":"Errors related to product identifiers","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsProductIdentifierErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsProductIdentifierErrorReason":{"enum":["INVALID_ASIN","INVALID_SKU"],"type":"string"},"SponsoredProductsProductTargetV2":{"description":"A product target.","properties":{"destinationAdGroupId":{"description":"The adGroupId of the destination manual-targeting adGroup where the target belongs.","type":"string"},"expressionType":{"description":"The the expression type (for PRODUCT). One of PRODUCT_EXACT, PRODUCT_SIMILAR","type":"string"},"target":{"description":"The product ASIN of the target.","type":"string"},"targetId":{"description":"The id of the product target.","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsQueryTermMatchType":{"description":"Match type for query filters.\n| Value |  Description |\n|-----------|------------|\n| `BROAD_MATCH` | Match if the queried value contains the filter value (substring matching). Note: If queryTermMatchType is set to BROAD_MATCH, only matches for the first query included will be returned. |\n| `EXACT_MATCH` | Match if the queried value is exactly equivalent to the filter value. |","enum":["BROAD_MATCH","EXACT_MATCH"],"type":"string"},"SponsoredProductsQuotaErrorReason":{"enum":["NON_ARCHIVED_QUOTA_EXCEEDED","QUOTA_EXCEEDED"],"type":"string"},"SponsoredProductsQuotaScope":{"enum":["ACCOUNT","PARENT_ENTITY"],"type":"string"},"SponsoredProductsRangeError":{"description":"Errors related to range constraints violations","properties":{"allowed":{"description":"allowed values","items":{"type":"string"},"type":"array"},"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"lowerLimit":{"description":"optional lower limit","type":"string"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsValueLimitErrorReason"},"upperLimit":{"description":"optional upper limit","type":"string"}},"required":["message","reason"],"type":"object"},"SponsoredProductsRecommendationReason":{"description":"Provides a reason for why this target is being recommended for harvesting","properties":{"data":{"description":"The data supporting the recommendation reason","type":"string"},"reason":{"description":"The reason for the recommendation","type":"string"}},"type":"object"},"SponsoredProductsRecommendedTarget":{"properties":{"adAsin":{"description":"The ASIN of the product being advertised","type":"string"},"adGroupId":{"description":"The ID of an ad group for which the targets are recommended","type":"string"},"adId":{"description":"The ID of an ad for which the targets are recommended","type":"string"},"campaignId":{"description":"The ID of a campaign for which the targets are recommended","type":"string"},"recommendationReasons":{"description":"Provides a list of reasons for why this target is being recommended for harvesting","items":{"$ref":"#/components/schemas/SponsoredProductsRecommendationReason"},"maxItems":1000,"minItems":0,"type":"array"},"recommendedTarget":{"description":"The keyword or ASIN that is being targeted","type":"string"},"targetType":{"$ref":"#/components/schemas/SponsoredProductsTargetType"}},"type":"object"},"SponsoredProductsReducedObjectIdFilter":{"description":"Filter entities by the list of objectIds","properties":{"include":{"items":{"description":"entity object identifier","type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["include"],"type":"object"},"SponsoredProductsResponseAdGroup":{"description":"Ad groups where targets can be promoted.","properties":{"adGroupId":{"description":"The id of the ad group in the campaign.","type":"string"}},"type":"object"},"SponsoredProductsSchemaValidationExceptionCode":{"enum":["INVALID_SCHEMA"],"type":"string"},"SponsoredProductsSchemaValidationExceptionResponseContent":{"description":"Request failed schema validation.","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"message":{"description":"Human-readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsServiceUnavailableExceptionCode":{"enum":["SERVICE_UNAVAILABLE"],"type":"string"},"SponsoredProductsServiceUnavailableExceptionErrorCode":{"enum":["SERVICE_UNAVAILABLE_EXCEPTION"],"type":"string"},"SponsoredProductsServiceUnavailableExceptionResponseContent":{"description":"Server unable to process request. Please retry later.","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsShopperCohortBidding":{"properties":{"audienceSegments":{"description":"A list of Audience Segments. Shoppers belonging to these segments will be selected for applying the bid adjustments. This is a required field when using \"AUDIENCE_SEGMENT\" option for `shopperCohortType`.","items":{"$ref":"#/components/schemas/SponsoredProductsAudienceSegment"},"maxItems":1,"minItems":1,"type":"array"},"percentage":{"format":"int32","maximum":900,"minimum":0,"type":"integer"},"shopperCohortType":{"$ref":"#/components/schemas/SponsoredProductsShopperCohortType"}},"required":["shopperCohortType"],"type":"object"},"SponsoredProductsShopperCohortType":{"description":"This field specifies the type of shopper cohort used to apply bid adjustments. `AUDIENCE_SEGMENT` is the only supported type currently.\n| Value |  Description |\n|-----------|------------|\n| `AUDIENCE_SEGMENT` | A predefined list of the shopper ids. |","enum":["AUDIENCE_SEGMENT"],"type":"string"},"SponsoredProductsSiteRestriction":{"description":"Restrict the ad to a particular site.\nIf the value is absent (ie null), it means no site restrictions and defaults to current Sponsored Products campaign behavior.\nThis field is coming up and is not ready for use at the moment.\n\n| Value | Description |\n| ---------------------- | -------------------- |\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n|  `AMAZON_HAUL`    | Restrict the ad to only show on Amazon Haul.     |","enum":["AMAZON_BUSINESS","AMAZON_HAUL"],"type":"string"},"SponsoredProductsTags":{"additionalProperties":{"type":"string"},"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","maxProperties":50,"minProperties":0,"type":"object"},"SponsoredProductsTarget":{"description":"Target promotion group\u0027s target.","properties":{"expressionType":{"description":"The match type (for KEYWORDs) or the expression type (for PRODUCT). One of QUERY_BROAD_MATCHES,\n    QUERY_EXACT_MATCHES, QUERY_PHRASE_MATCHES, ASIN_SAME_AS, ASIN_EXPANDED_FROM","type":"string"},"manualTargetingAdGroupId":{"description":"The adGroupId of the manual-targeting campaign where the target belongs.","type":"string"},"target":{"description":"The keyword text or the product ASIN of the target.","type":"string"},"targetId":{"description":"The id of the target.","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsTargetAccessError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsTargetAccessErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsTargetAccessErrorSelector":{"properties":{"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"invalidInputError":{"$ref":"#/components/schemas/SponsoredProductsInvalidInputError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsTargetAccessExceptionResponseContent":{"description":"Exception resulting in accessing campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetAccessError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsTargetMutationError":{"properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationErrorSelector"}},"required":["errorType","errorValue"],"type":"object"},"SponsoredProductsTargetMutationErrorSelector":{"properties":{"biddingError":{"$ref":"#/components/schemas/SponsoredProductsBiddingError"},"billingError":{"$ref":"#/components/schemas/SponsoredProductsBillingError"},"duplicateValueError":{"$ref":"#/components/schemas/SponsoredProductsDuplicateValueError"},"entityNotFoundError":{"$ref":"#/components/schemas/SponsoredProductsEntityNotFoundError"},"entityQuotaError":{"$ref":"#/components/schemas/SponsoredProductsEntityQuotaError"},"entityStateError":{"$ref":"#/components/schemas/SponsoredProductsEntityStateError"},"expressionTypeError":{"$ref":"#/components/schemas/SponsoredProductsExpressionTypeError"},"internalServerError":{"$ref":"#/components/schemas/SponsoredProductsInternalServerError"},"malformedValueError":{"$ref":"#/components/schemas/SponsoredProductsMalformedValueError"},"missingValueError":{"$ref":"#/components/schemas/SponsoredProductsMissingValueError"},"otherError":{"$ref":"#/components/schemas/SponsoredProductsOtherError"},"parentEntityError":{"$ref":"#/components/schemas/SponsoredProductsParentEntityError"},"rangeError":{"$ref":"#/components/schemas/SponsoredProductsRangeError"},"targetingClauseSetupError":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupError"},"throttledError":{"$ref":"#/components/schemas/SponsoredProductsThrottledError"}},"type":"object"},"SponsoredProductsTargetMutationExceptionResponseContent":{"description":"Exception resulting in mutating campaign management entities","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsInvalidArgumentErrorCode"},"errors":{"items":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationError"},"type":"array"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsTargetPromotionGroup":{"description":"A Target Promotion Group that groups an Auto-Targeting Campaign/AdGroup with a Manual-Targeting Keyword Campaign/AdGroup, and a\nManual-Targeting Product Campaign/AdGroup","properties":{"autoTargetingCampaignAdGroupId":{"description":"The Id of the auto-targeting AdGroup associated with the target promotion group","type":"string"},"autoTargetingCampaignAdIds":{"description":"The list of Product Ad Ids in the Auto-Targeting campaign\u0027s Ad Group that\u0027s tied to the Target Promotion Group.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"keywordCampaignAdGroupIds":{"description":"The Ids of the manual keyword-targeting AdGroups associated with the target promotion group","items":{"description":"Entity object identifier","type":"string"},"maxItems":1,"minItems":1,"type":"array"},"productCampaignAdGroupIds":{"description":"The Ids of the manual product-targeting AdGroups associated with the target promotion group","items":{"description":"Entity object identifier","type":"string"},"maxItems":1,"minItems":1,"type":"array"},"state":{"description":"The state of the target promotion group.","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"},"targetPromotionGroupName":{"description":"The name of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsTargetPromotionGroupTargetDetails":{"oneOf":[{"properties":{"keywordTargetDetailsV2":{"$ref":"#/components/schemas/SponsoredProductsKeywordTargetV2"}},"required":["keywordTargetDetailsV2"],"title":"keywordTargetDetailsV2","type":"object"},{"properties":{"productTargetDetailsV2":{"$ref":"#/components/schemas/SponsoredProductsProductTargetV2"}},"required":["productTargetDetailsV2"],"title":"productTargetDetailsV2","type":"object"}]},"SponsoredProductsTargetPromotionGroupV2":{"description":"A Target Promotion Group that groups a source AdGroup with one or more destination Manual Keyword/Product Targeting AdGroup(s)","properties":{"adIds":{"description":"The list of Product Ad Ids in the source Ad Group that\u0027s tied to the Target Promotion Group.","items":{"description":"Entity object identifier","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"destinationAdGroups":{"description":"The destination manual targeting AdGroups associated with the target promotion group.","items":{"$ref":"#/components/schemas/SponsoredProductsResponseAdGroup"},"maxItems":1000,"minItems":0,"type":"array"},"sourceAdGroupId":{"description":"The Id of the source AdGroup associated with the target promotion group","type":"string"},"sourceCampaignId":{"description":"The campaign Id of the source AdGroup associated with the target promotion group","type":"string"},"state":{"description":"The state of the target promotion group.","type":"string"},"targetPromotionGroupId":{"description":"The id of the target promotion group.","type":"string"},"targetPromotionGroupName":{"description":"The name of the target promotion group.","type":"string"}},"type":"object"},"SponsoredProductsTargetType":{"description":"Indicates if the recommendation target is a Keyword or ASIN","enum":["ASIN","KEYWORD"],"type":"string"},"SponsoredProductsTargetingClause":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which this target is associated.","type":"string"},"bid":{"description":"The bid for ads sourced using the target. Targets that do not have bid values in listTargetingClauses will inherit the defaultBid from the adGroup level. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","type":"number"},"campaignId":{"description":"The identifier of the campaign to which this target is associated.","type":"string"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"expressionType":{"$ref":"#/components/schemas/SponsoredProductsExpressionType"},"extendedData":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseExtendedData"},"globalTargetId":{"description":"The global target identifier that manages this marketplace target.","type":"string"},"resolvedExpression":{"description":"The resolved targeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["adGroupId","campaignId","expression","expressionType","resolvedExpression","state","targetId"],"type":"object"},"SponsoredProductsTargetingClauseExtendedData":{"properties":{"creationDateTime":{"description":"Creation date in ISO 8601.","format":"date-time","type":"string"},"lastUpdateDateTime":{"description":"Last updated date in ISO 8601.","format":"date-time","type":"string"},"servingStatus":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatus"},"servingStatusDetails":{"description":"The serving status reasons of the TargetingClause","items":{"$ref":"#/components/schemas/SponsoredProductsKeywordServingStatusDetail"},"type":"array"}},"type":"object"},"SponsoredProductsTargetingClauseFailureResponseItem":{"properties":{"errors":{"description":"A list of validation errors","items":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationError"},"type":"array"},"index":{"description":"the index of the targetingClause in the array from the request body","format":"int32","minimum":0,"type":"integer"}},"required":["index"],"type":"object"},"SponsoredProductsTargetingClauseSetupError":{"description":"Errors related to targeting clause setup","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"marketplace":{"$ref":"#/components/schemas/SponsoredProductsMarketplace"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsTargetingClauseSetupErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsTargetingClauseSetupErrorReason":{"enum":["AUTO_TARGETING_CLAUSE_CANNOT_BE_CREATED_MANUALLY","TARGETING_EXPRESSION_INVALID_VALUE","TARGETING_TYPE_NOT_ALLOWED_FOR_AUTO_TARGETING_CAMPAIGN","TYPE_CONFLICT_IN_AD_GROUP"],"type":"string"},"SponsoredProductsTargetingClauseSuccessResponseItem":{"properties":{"index":{"description":"the index of the targetingClause in the array from the request body","format":"int32","minimum":0,"type":"integer"},"targetId":{"description":"the targetingClause ID","type":"string"},"targetingClause":{"$ref":"#/components/schemas/SponsoredProductsTargetingClause"}},"required":["index"],"type":"object"},"SponsoredProductsTargetingExpressionMatchType":{"enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"],"type":"string"},"SponsoredProductsTargetingExpressionPredicate":{"properties":{"type":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionPredicateType"},"value":{"description":"The expression value","type":"string"}},"type":"object"},"SponsoredProductsTargetingExpressionPredicateType":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `QUERY_BROAD_REL_MATCHES` | Auto Targeting - cannot be manually created - corresponds to the `Loose match` target type in the UI, this will show your ad to shoppers who use search terms loosely related to your products.|\n| `QUERY_HIGH_REL_MATCHES` | Auto Targeting - cannot be manually created - corresponds to the `Close match` target type in the UI, this will show your ad to shoppers who use search terms closely related to your products.|\n| `ASIN_ACCESSORY_RELATED` | Auto Targeting - cannot be manually created - corresponds to the `Complements` target type in the UI, this will show your ad to shoppers who view the detail pages of products that complement your product.|\n| `ASIN_SUBSTITUTE_RELATED` | Auto Targeting - cannot be manually created - corresponds to the `Substitutes` target type in the UI, this will show your ad to shoppers who use detail pages of products similar to yours.|\n| `ASIN_CATEGORY_SAME_AS` | Target the category that is the same as the category expressed |\n| `ASIN_BRAND_SAME_AS` | Target the brand that is the same as the brand expressed. |\n| `ASIN_PRICE_LESS_THAN` | Target a price that is less than the price expressed. |\n| `ASIN_PRICE_BETWEEN` | Target a price that is between the prices expressed. |\n| `ASIN_PRICE_GREATER_THAN` | Target a price that is greater than the price expressed. |\n| `ASIN_REVIEW_RATING_LESS_THAN` | Target a review rating less than the review rating that is expressed. |\n| `ASIN_REVIEW_RATING_BETWEEN` | Target a review rating that is between the review ratings expressed. |\n| `ASIN_REVIEW_RATING_GREATER_THAN` | Target a review rating that is greater than the review rating expressed. |\n| `ASIN_SAME_AS` | Target an ASIN that is the same as the ASIN expressed. |\n| `ASIN_IS_PRIME_SHIPPING_ELIGIBLE` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `ASIN_AGE_RANGE_SAME_AS` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `ASIN_GENRE_SAME_AS` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `ASIN_EXPANDED_FROM` | Target products similar in performance to the ASIN expressed.   |\n| `KEYWORD_GROUP_SAME_AS` | Target the keyword group that is the same as the keyword group expressed (Beta coming soon). |\n| `OTHER` | Other Type.   |","enum":["ASIN_ACCESSORY_RELATED","ASIN_AGE_RANGE_SAME_AS","ASIN_BRAND_SAME_AS","ASIN_CATEGORY_SAME_AS","ASIN_EXPANDED_FROM","ASIN_GENRE_SAME_AS","ASIN_IS_PRIME_SHIPPING_ELIGIBLE","ASIN_PRICE_BETWEEN","ASIN_PRICE_GREATER_THAN","ASIN_PRICE_LESS_THAN","ASIN_REVIEW_RATING_BETWEEN","ASIN_REVIEW_RATING_GREATER_THAN","ASIN_REVIEW_RATING_LESS_THAN","ASIN_SAME_AS","ASIN_SUBSTITUTE_RELATED","KEYWORD_GROUP_SAME_AS","OTHER","QUERY_BROAD_REL_MATCHES","QUERY_HIGH_REL_MATCHES"],"type":"string"},"SponsoredProductsTargetingExpressionPredicateTypeWithoutOther":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `QUERY_BROAD_REL_MATCHES` | Auto Targeting - cannot be manually created - corresponds to the `Loose match` target type in the UI, this will show your ad to shoppers who use search terms loosely related to your products.|\n| `QUERY_HIGH_REL_MATCHES` | Auto Targeting - cannot be manually created - corresponds to the `Close match` target type in the UI, this will show your ad to shoppers who use search terms closely related to your products.|\n| `ASIN_ACCESSORY_RELATED` | Auto Targeting - cannot be manually created - corresponds to the `Complements` target type in the UI, this will show your ad to shoppers who view the detail pages of products that complement your product.|\n| `ASIN_SUBSTITUTE_RELATED` | Auto Targeting - cannot be manually created - corresponds to the `Substitutes` target type in the UI, this will show your ad to shoppers who use detail pages of products similar to yours.|\n| `ASIN_CATEGORY_SAME_AS` | Target the category that is the same as the category expressed |\n| `ASIN_BRAND_SAME_AS` | Target the brand that is the same as the brand expressed. |\n| `ASIN_PRICE_LESS_THAN` | Target a price that is less than the price expressed. |\n| `ASIN_PRICE_BETWEEN` | Target a price that is between the prices expressed. |\n| `ASIN_PRICE_GREATER_THAN` | Target a price that is greater than the price expressed. |\n| `ASIN_REVIEW_RATING_LESS_THAN` | Target a review rating less than the review rating that is expressed. |\n| `ASIN_REVIEW_RATING_BETWEEN` | Target a review rating that is between the review ratings expressed. |\n| `ASIN_REVIEW_RATING_GREATER_THAN` | Target a review rating that is greater than the review rating expressed. |\n| `ASIN_SAME_AS` | Target an ASIN that is the same as the ASIN expressed. |\n| `ASIN_IS_PRIME_SHIPPING_ELIGIBLE` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `ASIN_AGE_RANGE_SAME_AS` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `ASIN_GENRE_SAME_AS` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `ASIN_EXPANDED_FROM` | Target products similar in performance to the ASIN expressed.   |\n| `KEYWORD_GROUP_SAME_AS` | Target the keyword group that is the same as the keyword group expressed (Beta coming soon). |\n| `OTHER` | Other Type.   |","enum":["ASIN_ACCESSORY_RELATED","ASIN_AGE_RANGE_SAME_AS","ASIN_BRAND_SAME_AS","ASIN_CATEGORY_SAME_AS","ASIN_EXPANDED_FROM","ASIN_GENRE_SAME_AS","ASIN_IS_PRIME_SHIPPING_ELIGIBLE","ASIN_PRICE_BETWEEN","ASIN_PRICE_GREATER_THAN","ASIN_PRICE_LESS_THAN","ASIN_REVIEW_RATING_BETWEEN","ASIN_REVIEW_RATING_GREATER_THAN","ASIN_REVIEW_RATING_LESS_THAN","ASIN_SAME_AS","ASIN_SUBSTITUTE_RELATED","KEYWORD_GROUP_SAME_AS","QUERY_BROAD_REL_MATCHES","QUERY_HIGH_REL_MATCHES"],"type":"string"},"SponsoredProductsTargetingExpressionPredicateWithoutOther":{"properties":{"type":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionPredicateTypeWithoutOther"},"value":{"description":"The expression value","type":"string"}},"required":["type"],"type":"object"},"SponsoredProductsTargetingType":{"enum":["AUTO","MANUAL"],"type":"string"},"SponsoredProductsThrottledError":{"description":"Error that represents failure due to API caller exceeding allowed service limits.","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsThrottledErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsThrottledErrorCode":{"enum":["THROTTLED"],"type":"string"},"SponsoredProductsThrottledErrorReason":{"enum":["THROTTLED"],"type":"string"},"SponsoredProductsThrottlingExceptionCode":{"enum":["THROTTLED"],"type":"string"},"SponsoredProductsThrottlingExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsThrottledErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsUnauthenticatedExceptionCode":{"enum":["UNAUTHENTICATED"],"type":"string"},"SponsoredProductsUnauthenticatedExceptionResponseContent":{"description":"Unauthenticated. Request failed because user is not authenticated.","properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionCode"},"message":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"SponsoredProductsUnauthorizedErrorCode":{"enum":["UNAUTHORIZED"],"type":"string"},"SponsoredProductsUnauthorizedExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsUnsupportedMediaTypeErrorCode":{"enum":["UNSUPPORTED_MEDIA_TYPE"],"type":"string"},"SponsoredProductsUnsupportedMediaTypeExceptionResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeErrorCode"},"message":{"description":"Human readable error message","type":"string"}},"required":["code","message"],"type":"object"},"SponsoredProductsUnsupportedOperationError":{"description":"Errors being used to represent an unsupported operation\ne.g. Seller are not supported to create custom text product ads.","properties":{"cause":{"$ref":"#/components/schemas/SponsoredProductsErrorCause"},"message":{"description":"Human readable error message","type":"string"},"reason":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedOperationErrorReason"}},"required":["message","reason"],"type":"object"},"SponsoredProductsUnsupportedOperationErrorReason":{"enum":["UNSUPPORTED_OPERATION"],"type":"string"},"SponsoredProductsUpdateAdGroup":{"properties":{"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"defaultBid":{"description":"A bid value for use when no bid is specified for keywords in the ad group. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","type":"number"},"name":{"description":"The name of the ad group.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adGroupId"],"type":"object"},"SponsoredProductsUpdateCampaign":{"properties":{"budget":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateBudget"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"dynamicBidding":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateDynamicBidding"},"endDate":{"description":"The format of the date is YYYY-MM-DD.","format":"date","nullable":true,"type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"offAmazonSettings":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateOffAmazonSettings"},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","nullable":true,"type":"string"},"siteRestrictions":{"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.\nIf this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business - as well as select sites and apps off Amazon.\nPlease note that: 1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU), and AMAZON_HAUL option is only available in US;\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions don’t support shopperCohortBidding setting, SITE_AMAZON_BUSINESS placementBidding setting and offAmazonSettings;\n4) Only AMAZON_BUSINESS option is ready for use at the moment.","items":{"$ref":"#/components/schemas/SponsoredProductsSiteRestriction"},"maxItems":1,"minItems":1,"type":"array"},"startDate":{"description":"The format of the date is YYYY-MM-DD.","format":"date","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"},"tags":{"$ref":"#/components/schemas/SponsoredProductsTags"},"targetingType":{"$ref":"#/components/schemas/SponsoredProductsTargetingType"}},"required":["campaignId"],"type":"object"},"SponsoredProductsUpdateCampaignNegativeKeyword":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["keywordId"],"type":"object"},"SponsoredProductsUpdateCampaignNegativeTargetingClause":{"properties":{"expression":{"description":"The NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["targetId"],"type":"object"},"SponsoredProductsUpdateKeyword":{"properties":{"bid":{"description":"Bid associated with this keyword. Applicable to biddable match types only. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","nullable":true,"type":"number"},"keywordId":{"description":"The identifier of the keyword.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["keywordId"],"type":"object"},"SponsoredProductsUpdateNegativeKeyword":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["keywordId"],"type":"object"},"SponsoredProductsUpdateNegativeTargetingClause":{"properties":{"expression":{"description":"The NegativeTargeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate"},"maxItems":1000,"minItems":0,"type":"array"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["targetId"],"type":"object"},"SponsoredProductsUpdateProductAd":{"properties":{"adId":{"description":"The product ad identifier.","type":"string"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"}},"required":["adId"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsAdGroupsRequestContent":{"properties":{"adGroups":{"description":"An array of adGroups with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateAdGroup"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["adGroups"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsAdGroupsResponseContent":{"properties":{"adGroups":{"$ref":"#/components/schemas/SponsoredProductsBulkAdGroupOperationResponse"}},"required":["adGroups"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignNegativeKeywordsRequestContent":{"properties":{"campaignNegativeKeywords":{"description":"An array of campaignNegativeKeywords with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateCampaignNegativeKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaignNegativeKeywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignNegativeKeywordsResponseContent":{"properties":{"campaignNegativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeKeywordOperationResponse"}},"required":["campaignNegativeKeywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignNegativeTargetingClausesRequestContent":{"properties":{"campaignNegativeTargetingClauses":{"description":"An array of Campaign Negative TargetingClauses with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateCampaignNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaignNegativeTargetingClauses"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignNegativeTargetingClausesResponseContent":{"properties":{"campaignNegativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignNegativeTargetingClauseOperationResponse"}},"required":["campaignNegativeTargetingClauses"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignsRequestContent":{"properties":{"campaigns":{"description":"An array of campaigns with updated values. Note: targetingType cannot be updated","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateCampaign"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaigns"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsCampaignsResponseContent":{"properties":{"campaigns":{"$ref":"#/components/schemas/SponsoredProductsBulkCampaignOperationResponse"}},"required":["campaigns"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsKeywordsRequestContent":{"properties":{"keywords":{"description":"An array of keywords with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["keywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsKeywordsResponseContent":{"properties":{"keywords":{"$ref":"#/components/schemas/SponsoredProductsBulkKeywordOperationResponse"}},"required":["keywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsNegativeKeywordsRequestContent":{"properties":{"negativeKeywords":{"description":"An array of negativeKeywords with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateNegativeKeyword"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["negativeKeywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsNegativeKeywordsResponseContent":{"properties":{"negativeKeywords":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeKeywordOperationResponse"}},"required":["negativeKeywords"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsNegativeTargetingClausesRequestContent":{"properties":{"negativeTargetingClauses":{"description":"An array of negativeTargeting with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateNegativeTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["negativeTargetingClauses"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsNegativeTargetingClausesResponseContent":{"properties":{"negativeTargetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkNegativeTargetingClauseOperationResponse"}},"required":["negativeTargetingClauses"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsProductAdsRequestContent":{"properties":{"productAds":{"description":"An array of ads with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateProductAd"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["productAds"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsProductAdsResponseContent":{"properties":{"productAds":{"$ref":"#/components/schemas/SponsoredProductsBulkProductAdOperationResponse"}},"required":["productAds"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsTargetingClausesRequestContent":{"properties":{"targetingClauses":{"description":"An array of targetingClauses with updated values.","items":{"$ref":"#/components/schemas/SponsoredProductsUpdateTargetingClause"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["targetingClauses"],"type":"object"},"SponsoredProductsUpdateSponsoredProductsTargetingClausesResponseContent":{"properties":{"targetingClauses":{"$ref":"#/components/schemas/SponsoredProductsBulkTargetingClauseOperationResponse"}},"required":["targetingClauses"],"type":"object"},"SponsoredProductsUpdateTargetingClause":{"properties":{"bid":{"description":"The bid for ads sourced using the target. Targets that do not have bid values in listTargetingClauses will inherit the defaultBid from the adGroup level. For more information about bid constraints by marketplace, see [bid limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","format":"double","nullable":true,"type":"number"},"expression":{"description":"The targeting expression.","items":{"$ref":"#/components/schemas/SponsoredProductsTargetingExpressionPredicateWithoutOther"},"maxItems":1000,"minItems":0,"type":"array"},"expressionType":{"$ref":"#/components/schemas/SponsoredProductsExpressionTypeWithoutOther"},"state":{"$ref":"#/components/schemas/SponsoredProductsCreateOrUpdateEntityState"},"targetId":{"description":"The target identifier","type":"string"}},"required":["targetId"],"type":"object"},"SponsoredProductsValueLimitErrorReason":{"enum":["INVALID_ENUM_VALUE","NOT_IN_LIST","TOO_HIGH","TOO_LOW"],"type":"string"},"SuggestedBidValues":{"items":{"description":"The suggested bid.","format":"double","minimum":0,"type":"number"},"maxItems":3,"type":"array"},"TargetableAsinCounts":{"description":"Response object to get number of targetable asins for refinements provided by the user","properties":{"asinCounts":{"$ref":"#/components/schemas/IntegerRange"}},"type":"object"},"TargetableCategories":{"description":"Response object containing all targetable categories for the advertiser\u0027s marketplace. ID is the category ID. NA is the name. CH is the list of child categories. TA is if the category is targetable. AsinCountRange is the AsinCounts of the node. Version 4 adds the number of targetable ASINs to each category.","example":"[{\"id\":2748212011,\"na\":\"Art Paper\",\"ch\":[{\"id\":8090742011,\"na\":\"Palette Paper\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":11,\"max\":19}},{\"id\":8090734011,\"na\":\"Sketchbooks \u0026 Notebooks\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":3,\"max\":5}}],\"ta\":true,\"asinCountRange\":{\"min\":57,\"max\":84}},{\"id\":12898291,\"na\":\"Tracing Paper\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":24,\"max\":40}}]","properties":{"categoryTree":{"type":"string"}},"type":"object"},"TargetableCategoriesLoP":{"description":"Response object containing all targetable categories for the advertiser\u0027s marketplace in a language of preference (LoP) provide by the locale query parameter. ID is the category ID. NA is the name. TN is the translated name in the language of preference. CH is the list of child categories. TA is if the category is targetable. AsinCountRange is the AsinCounts of the node. Version 4 adds the number of targetable ASINs to each category.","example":"[{\"id\":2748212011,\"na\":\"Art Paper\",\"tn\":\"Papel de arte\",\"ch\":[{\"id\":8090742011,\"na\":\"Palette Paper\",\"tn\":\"Papel de paleta\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":11,\"max\":19}},{\"id\":8090734011,\"na\":\"Sketchbooks \u0026 Notebooks\",\"tn\":\"Cuadernos de bocetos y cuadernos\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":3,\"max\":5}}],\"ta\":true,\"asinCountRange\":{\"min\":57,\"max\":84}},{\"id\":12898291,\"na\":\"Tracing Paper\",\"tn\":\"Papel de trazar\",\"ch\":[],\"ta\":true, \"asinCountRange\":{\"min\":24,\"max\":40}}]","properties":{"categoryTree":{"type":"string"}},"type":"object"},"TargetingExpression":{"description":"The targeting expression. The `type` property specifies the targeting option. Use `CLOSE_MATCH` to match your auto targeting ads closely to the specified value. Use `LOOSE_MATCH` to match your auto targeting ads broadly to the specified value. Use `SUBSTITUTES` to display your auto targeting ads along with substitutable products. Use `COMPLEMENTS` to display your auto targeting ads along with affiliated products. Use `KEYWORD_BROAD_MATCH` to broadly match your keyword targeting ads with search queries. Use `KEYWORD_EXACT_MATCH` to exactly match your keyword targeting ads with search queries. Use `KEYWORD_PHRASE_MATCH` to match your keyword targeting ads with search phrases. your keyword targeting ads with search phrases.","example":{"type":"CLOSE_MATCH"},"properties":{"type":{"enum":["CLOSE_MATCH","COMPLEMENTS","KEYWORD_BROAD_MATCH","KEYWORD_EXACT_MATCH","KEYWORD_PHRASE_MATCH","LOOSE_MATCH","SUBSTITUTES"],"type":"string"},"value":{"description":"The targeting expression value.","type":"string"}},"required":["type"],"type":"object"},"TargetingExpressionList":{"description":"The list of targeting expressions. Maximum of 100 per request, use pagination for more if needed.","example":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}],"items":{"$ref":"#/components/schemas/TargetingExpression"},"maxItems":100,"type":"array"},"TargetingExpressionListV4":{"description":"The list of targeting expressions. Maximum of 100 per request, use pagination for more if needed.","example":[{"type":"CLOSE_MATCH"},{"type":"LOOSE_MATCH"},{"type":"SUBSTITUTES"},{"type":"COMPLEMENTS"}],"items":{"$ref":"#/components/schemas/TargetingExpressionV4"},"maxItems":100,"type":"array"},"TargetingExpressionV4":{"description":"The targeting expression. The `type` property specifies the targeting option. Use `CLOSE_MATCH` to match your auto targeting ads closely to the specified value. Use `LOOSE_MATCH` to match your auto targeting ads broadly to the specified value. Use `SUBSTITUTES` to display your auto targeting ads along with substitutable products. Use `COMPLEMENTS` to display your auto targeting ads along with affiliated products. Use `KEYWORD_BROAD_MATCH` to broadly match your keyword targeting ads with search queries. Use `KEYWORD_EXACT_MATCH` to exactly match your keyword targeting ads with search queries. Use `KEYWORD_PHRASE_MATCH` to match your keyword targeting ads with search phrases. your keyword targeting ads with search phrases. Use `PAT_ASIN` to match your product attribute targeting ads with product ASIN. Use `PAT_CATEGORY` to match your product attribute targeting ads with product category. Use `PAT_CATEGORY_REFINEMENT` to match your product attribute targeting ads with product attribute, including brand, price, rating, prime shipping eligible, age range and genre. Use `KEYWORD_GROUP` to match your keyword targeting ads with keyword group.","example":{"type":"CLOSE_MATCH"},"properties":{"type":{"enum":["CLOSE_MATCH","COMPLEMENTS","KEYWORD_BROAD_MATCH","KEYWORD_EXACT_MATCH","KEYWORD_GROUP","KEYWORD_PHRASE_MATCH","LOOSE_MATCH","PAT_ASIN","PAT_CATEGORY","PAT_CATEGORY_REFINEMENT","SUBSTITUTES"],"type":"string"},"value":{"description":"The targeting expression value.","type":"string"}},"required":["type"],"type":"object"},"TargetingGroupBidRecommendation":{"description":"Contains suggested recommendation for the auto targeting group.","properties":{"action":{"description":"Type of suggested action.","enum":["ADD","DECREASE","INCREASE","REMOVE"],"type":"string"},"adGroupId":{"description":"The ad group identifier.","type":"string"},"suggestedBid":{"description":"The suggested bid value associated with this targeting.","format":"double","type":"number"},"targetId":{"description":"The target identifier.","type":"string"},"targetingGroupExpression":{"description":"The type of targeting group expression.\n| Value | Description |\n| --- | --- |\n| `LOOSE_MATCH` | This will show your ad to shoppers who use search terms loosely related to your products.|\n| `CLOSE_MATCH` | This will show your ad to shoppers who use search terms closely related to your products.|\n| `COMPLEMENTS` | This will show your ad to shoppers who view the detail pages of products that complement your product.|\n| `SUBSTITUTES` | This will show your ad to shoppers who use detail pages of products similar to yours.|","enum":["CLOSE_MATCH","COMPLEMENTS","LOOSE_MATCH","SUBSTITUTES"],"type":"string"}},"type":"object"},"Theme":{"description":"The bid recommendation theme. This API currently supports `CONVERSION_OPPORTUNITIES`, `PRIME_DAY`, `FALL_PRIME_DEAL_EVENT`, and `BFCM_HOLIDAY` themes.","enum":["BFCM_HOLIDAY","CONVERSION_OPPORTUNITIES","FALL_PRIME_DEAL_EVENT","PRIME_DAY"],"type":"string"},"ThemeBasedBidRecommendation":{"example":{"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"targetingExpression":{"type":"LOOSE_MATCH"}}],"impactMetrics":{"clicks":{"values":[{"lower":"30","upper":"70"},{"lower":"80","upper":"90"},{"lower":"95","upper":"120"}]},"orders":{"values":[{"lower":"3","upper":"6"},{"lower":"7","upper":"10"},{"lower":"11","upper":"15"}]}},"theme":"CONVERSION_OPPORTUNITIES"},"properties":{"bidRecommendationsForTargetingExpressions":{"description":"The bid recommendations for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/BidRecommendationPerTargetingExpression"},"type":"array"},"impactMetrics":{"$ref":"#/components/schemas/ImpactMetrics"},"theme":{"$ref":"#/components/schemas/Theme"}},"required":["bidRecommendationsForTargetingExpressions","theme"],"type":"object"},"ThemeBasedBidRecommendationResponse":{"description":"A list of bid recommendation themes and associated bid recommendations.","example":{"bidRecommendations":[{"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"targetingExpression":{"type":"LOOSE_MATCH"}}],"impactMetrics":{"clicks":{"values":[{"lower":"30","upper":"70"},{"lower":"80","upper":"90"},{"lower":"95","upper":"120"}]},"orders":{"values":[{"lower":"3","upper":"6"},{"lower":"7","upper":"10"},{"lower":"11","upper":"15"}]}},"theme":"CONVERSION_OPPORTUNITIES"}]},"properties":{"bidRecommendations":{"items":{"$ref":"#/components/schemas/ThemeBasedBidRecommendation"},"maxItems":2,"type":"array"}},"required":["bidRecommendations"],"type":"object"},"ThemeBasedBidRecommendationResponseV4":{"description":"A list of bid recommendation themes and associated bid recommendations.","example":{"bidRecommendations":[{"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},{"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1.2"},{"suggestedBid":"1.7"},{"suggestedBid":"2.2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.3"},{"suggestedBid":"1.5"},{"suggestedBid":"2.4"}],"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"PRIME_DAY"}]},"properties":{"bidRecommendations":{"items":{"$ref":"#/components/schemas/ThemeBasedBidRecommendationV4"},"maxItems":2,"type":"array"}},"required":["bidRecommendations"],"type":"object"},"ThemeBasedBidRecommendationResponseV5":{"description":"A list of bid recommendation themes and associated bid recommendations.","example":{"bidRecommendations":[{"bidAnalysesForTargetingExpressions":[{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"LOOSE_MATCH"}}],"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},{"bidAnalysesForTargetingExpressions":[{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"ALTERNATIVE"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"ALTERNATIVE"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"SUGGESTED"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"ALTERNATIVE"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"ALTERNATIVE"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"SUGGESTED"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"ALTERNATIVE"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"ALTERNATIVE"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"SUGGESTED"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"ALTERNATIVE"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"ALTERNATIVE"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"SUGGESTED"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"ALTERNATIVE"},{"bid":"1.3","impactMetrics":{"estimatedImpressionAvg":"675","estimatedImpressionLower":"450","estimatedImpressionUpper":"900"},"type":"SUGGESTED_LOWER"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"SUGGESTED_UPPER"},{"bid":"2.6","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"ALTERNATIVE"},{"bid":"1.3","impactMetrics":{"estimatedImpressionAvg":"675","estimatedImpressionLower":"450","estimatedImpressionUpper":"900"},"type":"SUGGESTED_LOWER"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"SUGGESTED_UPPER"},{"bid":"2.6","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"ALTERNATIVE"},{"bid":"1.3","impactMetrics":{"estimatedImpressionAvg":"675","estimatedImpressionLower":"450","estimatedImpressionUpper":"900"},"type":"SUGGESTED_LOWER"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"SUGGESTED_UPPER"},{"bid":"2.6","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"ALTERNATIVE"},{"bid":"1.3","impactMetrics":{"estimatedImpressionAvg":"675","estimatedImpressionLower":"450","estimatedImpressionUpper":"900"},"type":"SUGGESTED_LOWER"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"SUGGESTED_UPPER"},{"bid":"2.6","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"LOOSE_MATCH"}}],"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1.2"},{"suggestedBid":"1.7"},{"suggestedBid":"2.2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.3"},{"suggestedBid":"1.5"},{"suggestedBid":"2.4"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"PRIME_DAY"}]},"properties":{"bidRecommendations":{"items":{"$ref":"#/components/schemas/ThemeBasedBidRecommendationV5"},"maxItems":2,"type":"array"}},"required":["bidRecommendations"],"type":"object"},"ThemeBasedBidRecommendationV4":{"example":{"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},"properties":{"bidRecommendationsForTargetingExpressions":{"description":"The bid recommendations for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/BidRecommendationPerTargetingExpressionV4"},"type":"array"},"theme":{"$ref":"#/components/schemas/Theme"}},"required":["bidRecommendationsForTargetingExpressions","theme"],"type":"object"},"ThemeBasedBidRecommendationV5":{"example":{"bidAnalysesForTargetingExpressions":[{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1","impactMetrics":{"estimatedImpressionAvg":"450","estimatedImpressionLower":"300","estimatedImpressionUpper":"600"},"type":"SUGGESTED_LOWER"},{"bid":"1.2","impactMetrics":{"estimatedImpressionAvg":"600","estimatedImpressionLower":"400","estimatedImpressionUpper":"800"},"type":"ALTERNATIVE"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"ALTERNATIVE"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidAnalyses":{"ALL":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_PRODUCT_PAGE":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_REST_OF_SEARCH":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}],"PLACEMENT_TOP":[{"bid":"0.8","impactMetrics":{"estimatedImpressionAvg":"300","estimatedImpressionLower":"200","estimatedImpressionUpper":"400"},"type":"ALTERNATIVE"},{"bid":"1.1","impactMetrics":{"estimatedImpressionAvg":"525","estimatedImpressionLower":"350","estimatedImpressionUpper":"700"},"type":"SUGGESTED_LOWER"},{"bid":"1.4","impactMetrics":{"estimatedImpressionAvg":"750","estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"type":"SUGGESTED"},{"bid":"1.5","impactMetrics":{"estimatedImpressionAvg":"900","estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"type":"SUGGESTED"},{"bid":"1.7","impactMetrics":{"estimatedImpressionAvg":"1050","estimatedImpressionLower":"700","estimatedImpressionUpper":"1400"},"type":"ALTERNATIVE"},{"bid":"2","impactMetrics":{"estimatedImpressionAvg":"1200","estimatedImpressionLower":"800","estimatedImpressionUpper":"1600"},"type":"ALTERNATIVE"},{"bid":"2.2","impactMetrics":{"estimatedImpressionAvg":"1275","estimatedImpressionLower":"850","estimatedImpressionUpper":"1700"},"type":"SUGGESTED_UPPER"},{"bid":"2.4","impactMetrics":{"estimatedImpressionAvg":"1350","estimatedImpressionLower":"900","estimatedImpressionUpper":"1800"},"type":"ALTERNATIVE"}]},"targetingExpression":{"type":"LOOSE_MATCH"}}],"bidRecommendationsForTargetingExpressions":[{"bidValues":[{"suggestedBid":"1"},{"suggestedBid":"1.5"},{"suggestedBid":"2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"600","estimatedImpressionUpper":"1200"},"targetingExpression":{"type":"CLOSE_MATCH"}},{"bidValues":[{"suggestedBid":"1.1"},{"suggestedBid":"1.4"},{"suggestedBid":"2.2"}],"suggestedBidImpactMetrics":{"estimatedImpressionLower":"500","estimatedImpressionUpper":"1000"},"targetingExpression":{"type":"LOOSE_MATCH"}}],"theme":"CONVERSION_OPPORTUNITIES"},"properties":{"bidAnalysesForTargetingExpressions":{"description":"The bid analyses for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/BidAnalysesPerTargetingExpression"},"type":"array"},"bidRecommendationsForTargetingExpressions":{"description":"The bid recommendations for targeting expressions listed in the request.","items":{"$ref":"#/components/schemas/BidRecommendationPerTargetingExpressionV5"},"type":"array"},"theme":{"$ref":"#/components/schemas/Theme"}},"required":["bidRecommendationsForTargetingExpressions","theme"],"type":"object"},"ThemeRecommendation":{"description":"Recommended asins grouped by theme attribute.","properties":{"description":{"description":"A theme name representing the context around the recommended list of ASINs.","example":"These target ASINs generated sales for the input ASIN in the past 30 days.","type":"string"},"recommendedAsins":{"description":"List of recommended ASINs under current theme.","items":{"example":"BX20002121","maxLength":10,"minLength":10,"type":"string"},"type":"array"},"theme":{"description":"A theme name representing the context around the recommended list of ASINs.","example":"Top Converting targets","type":"string"}},"type":"object"},"ThemedBid":{"properties":{"bid":{"description":"The bid value for the keyword, in minor currency units (example: cents). The default value will be the suggested bid.","format":"Double","type":"number"},"matchType":{"description":"Keyword match type. The default value will be BROAD.","enum":["BROAD","EXACT","PHRASE"],"type":"string"},"rank":{"description":"The keyword target rank.","type":"number"},"suggestedBid":{"$ref":"#/components/schemas/BidValues"},"theme":{"description":"The theme of the bid recommendation. The default theme is CONVERSION_OPPORTUNITIES.","type":"string"}},"type":"object"},"ThrottlingException":{"description":"Returns information about a ThrottlingException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"UnauthorizedException":{"description":"Returns information about an UnauthorizedException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"UnprocessableEntityException":{"description":"Returns information about UnprocessableEntityException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"UpdateBudgetRulesResponse":{"properties":{"responses":{"items":{"$ref":"#/components/schemas/BudgetRuleResponse"},"type":"array"}},"type":"object"},"UpdateSPBudgetRulesRequest":{"description":"Request object for updating budget rule for SP campaign","properties":{"budgetRulesDetails":{"description":"A list of budget rule details.","items":{"$ref":"#/components/schemas/SPBudgetRule"},"maxItems":25,"type":"array"}},"type":"object"},"UpdateSPCampaignOptimizationRuleResponse":{"properties":{"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"}},"type":"object"},"UpdateSPCampaignOptimizationRulesRequest":{"description":"Request object for updating campaign optimization rule","example":{"campaignIds":["1223785","123784"],"campaignOptimizationId":"10001","recurrence":"DAILY","ruleAction":"ADOPT","ruleCondition":[{"comparisonOperator":"GREATER_THAN","metricName":"ROAS","threshold":"7"}],"ruleName":"RuleROAS4","ruleType":"BID"},"properties":{"campaignIds":{"description":"A list of campaign ids","items":{"$ref":"#/components/schemas/RuleCampaignId"},"maxItems":20,"type":"array"},"campaignOptimizationId":{"$ref":"#/components/schemas/campaignOptimizationId"},"recurrence":{"$ref":"#/components/schemas/RecurrenceType"},"ruleAction":{"$ref":"#/components/schemas/RuleAction"},"ruleCondition":{"$ref":"#/components/schemas/RuleConditionList"},"ruleName":{"$ref":"#/components/schemas/RuleName"},"ruleType":{"$ref":"#/components/schemas/RuleType"}},"required":["campaignIds","campaignOptimizationId","recurrence","ruleAction","ruleType"]},"ValidationException":{"description":"Returns information about a ValidationException.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"Values":{"description":"Metrics benchmark values.","properties":{"clicks":{"$ref":"#/components/schemas/Clicks"},"conversions":{"$ref":"#/components/schemas/Conversions"},"impressions":{"$ref":"#/components/schemas/Impressions"}}},"budgetIncreaseBy":{"properties":{"type":{"$ref":"#/components/schemas/BudgetChangeType"},"value":{"description":"The budget value.","format":"double","type":"number"}},"required":["type","value"],"type":"object"},"campaignOptimizationId":{"description":"The persistent rule identifier.","maxLength":355,"type":"string"},"state":{"description":"The budget rule state.","enum":["ACTIVE","PAUSED"],"type":"string"},"timeOfDay":{"properties":{"endTime":{"description":"The end time of intra-day budget rule window in the format \u0027hh:mm:ss\u0027. Required to be greater than start-time. ","type":"string"},"startTime":{"description":"The start time of intra-day budget rule window in the format \u0027hh:mm:ss\u0027 ","type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"description":" ","title":"Sponsored Products","version":"3.0"},"openapi":"3.0.1","paths":{"/sp/adGroups":{"post":{"description":"Create ad groups\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsAdGroupsResponseContent"}}},"description":"CreateSponsoredProductsAdGroups 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ad groups"]},"put":{"description":"Update ad groups\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsAdGroupsResponseContent"}}},"description":"UpdateSponsoredProductsAdGroups 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ad groups"]}},"/sp/adGroups/delete":{"post":{"description":"Delete ad groups\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsAdGroupsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsAdGroupsResponseContent"}}},"description":"DeleteSponsoredProductsAdGroups 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAdGroupMutationExceptionResponseContent"}}},"description":"AdGroupMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ad groups"]}},"/sp/adGroups/list":{"post":{"description":"List ad groups\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsAdGroups","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsAdGroupsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spAdGroup.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsAdGroupsResponseContent"}}},"description":"ListSponsoredProductsAdGroups 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAdGroupAccessExceptionResponseContent"}}},"description":"AdGroupAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Ad groups"]}},"/sp/budgetRules":{"get":{"operationId":"GetSPBudgetRulesForAdvertiser","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","in":"query","name":"pageSize","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSPBudgetRulesForAdvertiserResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Get all budget rules created by an advertiser","tags":["BudgetRules"]},"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateBudgetRulesForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSPBudgetRulesRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBudgetRulesResponse"}}},"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Creates one or more budget rules.","tags":["BudgetRules"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateBudgetRulesForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSPBudgetRulesRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBudgetRulesResponse"}}},"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Updates one or more budget rules.","tags":["BudgetRules"]}},"/sp/budgetRules/{budgetRuleId}":{"get":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetBudgetRuleByRuleIdForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The budget rule identifier.","in":"path","name":"budgetRuleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSPBudgetRuleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a budget rule specified by identifier.","tags":["BudgetRules"]}},"/sp/budgetRules/{budgetRuleId}/campaigns":{"get":{"operationId":"GetCampaignsAssociatedWithSPBudgetRule","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The budget rule identifier.","in":"path","name":"budgetRuleId","required":true,"schema":{"type":"string"}},{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","in":"query","name":"pageSize","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetAssociatedCampaignsResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets all the campaigns associated with a budget rule","tags":["BudgetRules"]}},"/sp/budgetRulesAssociation":{"post":{"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"BulkBudgetRulesAssociationForSP","parameters":[{"description":"The identifier of a client associated with a Login with Amazon account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBudgetRulesAssociationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBudgetRulesAssociationResponse"}}},"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Associates budget rules to one or more campaigns.","tags":["BudgetRules"]}},"/sp/budgetRulesAssociation/delete":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"BulkBudgetRulesDisAssociationForSP","parameters":[{"description":"The identifier of a client associated with a Login with Amazon account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBudgetRulesDisAssociationRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkBudgetRulesDisAssociationResponse"}}},"description":"Multi-status. An object containing a list of dissociated budget rule response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"DisAssociates budget rules from one or more campaigns","tags":["BudgetRules"]}},"/sp/campaign/recommendations":{"get":{"description":"Gets the top consolidated recommendations across bid, budget, targeting for SP campaigns given an advertiser profile id. The recommendations are refreshed everyday.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\",\"advertiser_campaign_edit\"]","operationId":"getCampaignRecommendations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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","required":true,"schema":{"type":"string"}},{"description":"Optional.  Returns or generates recommendations only for the specified campaignIds.","in":"query","name":"campaignIds","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Optional. Limits the number of items to return in the response.","in":"query","name":"maxResults","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/GetCampaignRecommendationsResponse"}}},"description":"Success."},"400":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}},"description":"Invalid Request - The input fails to satisfy the constraints of the API."},"401":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"403":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}},"description":"Access Denied - Request failed because the user is not allowed to invoke the operation."},"422":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Consolidated Recommendations"]},"post":{"description":"Gets the top consolidated recommendations across bid, budget, targeting for SP campaigns given an advertiser profile id. The recommendations are refreshed everyday.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\",\"advertiser_campaign_edit\"]","operationId":"fetchCampaignRecommendations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spgetcampaignrecommendationsrequest.v2+json":{"schema":{"$ref":"#/components/schemas/GetCampaignRecommendationsRequestV2"}}}},"responses":{"200":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/GetCampaignRecommendationsResponseV2"}}},"description":"Success."},"400":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}},"description":"Invalid Request - The input fails to satisfy the constraints of the API."},"401":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"403":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}},"description":"Access Denied - Request failed because the user is not allowed to invoke the operation."},"422":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spgetcampaignrecommendationsresponse.v2+json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Consolidated Recommendations"]}},"/sp/campaignNegativeKeywords":{"post":{"description":"Create campaign negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsCampaignNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignNegativeKeywordsResponseContent"}}},"description":"CreateSponsoredProductsCampaignNegativeKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationExceptionResponseContent"}}},"description":"CampaignNegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative keywords"]},"put":{"description":"Update campaign negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsCampaignNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignNegativeKeywordsResponseContent"}}},"description":"UpdateSponsoredProductsCampaignNegativeKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationExceptionResponseContent"}}},"description":"CampaignNegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative keywords"]}},"/sp/campaignNegativeKeywords/delete":{"post":{"description":"Delete campaign negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsCampaignNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignNegativeKeywordsResponseContent"}}},"description":"DeleteSponsoredProductsCampaignNegativeKeywords 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordMutationExceptionResponseContent"}}},"description":"CampaignNegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative keywords"]}},"/sp/campaignNegativeKeywords/list":{"post":{"description":"List campaign negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsCampaignNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignNegativeKeywordsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spCampaignNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignNegativeKeywordsResponseContent"}}},"description":"ListSponsoredProductsCampaignNegativeKeywords 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeKeywordAccessExceptionResponseContent"}}},"description":"CampaignNegativeKeywordAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative keywords"]}},"/sp/campaignNegativeTargets":{"post":{"description":"Create campaign negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsCampaignNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignNegativeTargetingClausesResponseContent"}}},"description":"CreateSponsoredProductsCampaignNegativeTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationExceptionResponseContent"}}},"description":"CampaignNegativeTargetsMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative targeting clauses"]},"put":{"description":"Update campaign negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsCampaignNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignNegativeTargetingClausesResponseContent"}}},"description":"UpdateSponsoredProductsCampaignNegativeTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationExceptionResponseContent"}}},"description":"CampaignNegativeTargetsMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative targeting clauses"]}},"/sp/campaignNegativeTargets/delete":{"post":{"description":"Delete campaign negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsCampaignNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesResponseContent"}}},"description":"DeleteSponsoredProductsCampaignNegativeTargetingClauses 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsMutationExceptionResponseContent"}}},"description":"CampaignNegativeTargetsMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative targeting clauses"]}},"/sp/campaignNegativeTargets/list":{"post":{"description":"List campaign negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsCampaignNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignNegativeTargetingClausesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spCampaignNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignNegativeTargetingClausesResponseContent"}}},"description":"ListSponsoredProductsCampaignNegativeTargetingClauses 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignNegativeTargetsAccessExceptionResponseContent"}}},"description":"CampaignNegativeTargetsAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaign negative targeting clauses"]}},"/sp/campaigns":{"post":{"description":"Create campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsCampaignsResponseContent"}}},"description":"CreateSponsoredProductsCampaigns 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]},"put":{"description":"Update campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsCampaignsResponseContent"}}},"description":"UpdateSponsoredProductsCampaigns 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/sp/campaigns/budget/usage":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"spCampaignsBudgetUsage","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{}}],"requestBody":{"content":{"application/vnd.spcampaignbudgetusage.v1+json":{"schema":{"$ref":"#/components/schemas/BudgetUsageCampaignRequest"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spcampaignbudgetusage.v1+json":{"schema":{"$ref":"#/components/schemas/BudgetUsageCampaignResponse"}}},"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetUsageError"}}},"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved."}},"summary":"Budget usage API for SP campaigns","tags":["Budget Usage"]}},"/sp/campaigns/budgetRecommendations":{"post":{"description":"Given a list of campaigns as input, this API provides the following metrics -  \u003cbr\u003e \u003cb\u003e1. Recommended daily budget - \u003c/b\u003e Estimated daily budget needed to keep the campaign in budget for the full 24-hour period in a day. Consider this daily budget to minimize your campaign\u0027s chances of running out of budget. \u003cbr\u003e \u003cb\u003e2. Percent time in budget \u003c/b\u003e - Actual average percentage of time the campaign was in budget between the start and end date specified in the response. Note: value -1 means we don’t have enough information to compute the campaign’s percent time in budget. \u003cbr\u003e \u003cb\u003e3. Estimated missed impressions, clicks and sales \u003c/b\u003e - These are the estimated range of additional impressions, clicks and sales the campaign might have generated between the start and end date specified in the response had it been in budget 100% of the time. These are estimates based on historical traffic and the campaign\u0027s past performance (e.g. impressions \u0026 clicks generated) but not guaranteed.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getBudgetRecommendations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Forbidden - access to the requested resource is forbidden"},"415":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Unsupported Media Type - the payload is in a format not supported by this method."},"422":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Unprocessable Entity - Failed due to invalid parameters."},"429":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Too Many Requests - request was rate-limited. Retry later."},"500":{"content":{"application/vnd.budgetrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTORBudgetRecommendationError"}}},"description":"Internal Server DBCError - something went wrong on the server. Retry later and report a DBCError if unresolved."}},"summary":"Get recommended daily budget and estimated missed opportunities for campaigns.","tags":["Budget recommendations and missed opportunities"]}},"/sp/campaigns/budgetRules/recommendations":{"post":{"description":"A rule enables an automatic budget increase for a specified date range or for a special event. The response also includes a suggested budget increase for each special event.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SPGetBudgetRulesRecommendation","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spbudgetrulesrecommendation.v3+json":{"schema":{"discriminator":{"mapping":{"EVENTS_FOR_EXISTING_CAMPAIGN":"#/components/schemas/SPBudgetRulesRecommendationEventRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/SPBudgetRulesRecommendationEventRequest"}]}}}},"responses":{"200":{"content":{"application/vnd.spbudgetrulesrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPBudgetRulesRecommendationEventResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/vnd.spbudgetrulesrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPBudgetRulesRecommendationError"}}},"description":"Bad Request."},"429":{"content":{"application/vnd.spbudgetrulesrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPBudgetRulesRecommendationError"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spbudgetrulesrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPBudgetRulesRecommendationError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.","tags":["BudgetRulesRecommendation"]}},"/sp/campaigns/delete":{"post":{"description":"Delete campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsCampaignsResponseContent"}}},"description":"DeleteSponsoredProductsCampaigns 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignMutationExceptionResponseContent"}}},"description":"CampaignMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/sp/campaigns/initialBudgetRecommendation":{"post":{"description":"Creates daily budget recommendation along with benchmark metrics when creating a new campaign.","operationId":"getBudgetRecommendation","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","explode":false,"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"},"style":"simple"},{"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.","explode":false,"in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/InitialBudgetRecommendationRequest"}}}},"responses":{"200":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/InitialBudgetRecommendationResponse"}}},"description":"200 response."},"400":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"400 response."},"401":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"401 response."},"403":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"403 response."},"415":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"415 response."},"429":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"429 response."},"500":{"content":{"application/vnd.spinitialbudgetrecommendation.v3.4+json":{"schema":{"$ref":"#/components/schemas/BudgetRecommendationNewCampaignsException"}}},"description":"500 response."}},"tags":["Budget Recommendation New Campaigns"]}},"/sp/campaigns/list":{"post":{"description":"List campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spCampaign.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsCampaignsResponseContent"}}},"description":"ListSponsoredProductsCampaigns 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCampaignAccessExceptionResponseContent"}}},"description":"CampaignAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Campaigns"]}},"/sp/campaigns/{campaignId}/budgetRules":{"get":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListAssociatedBudgetRulesForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The campaign identifier.","in":"path","name":"campaignId","required":true,"schema":{"format":"int64","type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPListAssociatedBudgetRulesResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a list of budget rules associated to a campaign specified by identifier.","tags":["BudgetRules"]},"post":{"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateAssociatedBudgetRulesForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a Login with Amazon account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The campaign identifier.","in":"path","name":"campaignId","required":true,"schema":{"format":"int64","type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociatedBudgetRulesRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociatedBudgetRulesResponse"}}},"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Associates one or more budget rules to a campaign specified by identifer.","tags":["BudgetRules"]}},"/sp/campaigns/{campaignId}/budgetRules/{budgetRuleId}":{"delete":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DisassociateAssociatedBudgetRuleForSPCampaigns","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The campaign identifier.","in":"path","name":"campaignId","required":true,"schema":{"format":"int64","type":"number"}},{"description":"The budget rule identifier.","in":"path","name":"budgetRuleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateAssociatedBudgetRuleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unauthorized. The request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Disassociates a budget rule specified by identifier from a campaign specified by identifier.","tags":["BudgetRules"]}},"/sp/campaigns/{campaignId}/optimizationRules":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"AssociateOptimizationRulesToCampaign","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.\nUse `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The sp campaign identifier.","in":"path","name":"campaignId","required":true,"schema":{"description":"Sp campaign identifier.","type":"string"}}],"requestBody":{"content":{"application/vnd.spoptimizationrules.v1+json":{"examples":{"associateASingleRule":{"value":{"optimizationRuleIds":["7bf484ff-381c-4703-82ec-66b9eb732705"]}},"associateMultipleRules":{"value":{"optimizationRuleIds":["babc8a5e-b050-496f-a4f6-36f1f67d5bad","c7b2b725-2269-4b5e-95d0-54cd0fd28cd1","f0da81d5-318d-4938-9c45-0d33f680fdc1"]}}},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerAssociateOptimizationRulesToCampaignRequest"}}}},"responses":{"207":{"content":{"application/vnd.spoptimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerAssociateOptimizationRulesToCampaignResponse"}}},"description":"Multi-status.\nAn object containing a list of optimization rule response objects reflecting the same order as the input.\n"},"400":{"content":{"application/json":{"example":{"code":"400","message":"Invalid advertiser id."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Bad request caused by invalid input."},"401":{"content":{"application/json":{"example":{"code":"401","message":"Unauthenticated."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Unauthenticated. Request failed because user is not authenticated.\n"},"403":{"content":{"application/json":{"example":{"code":"403","message":"You do not have permission to access the resource."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource.\n"},"500":{"content":{"application/json":{"example":{"code":"500","message":"Internal server error."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Associates one or multiple optimization rules with a campaign.\n","tags":["Optimization Rules"]}},"/sp/global/targets/bid/recommendations":{"post":{"description":"The \u003cb\u003e POST /sp/targets/bid/recommendations \u003c/b\u003e endpoint returns recommended bids for each target given either A) new ad group (a list of ad ASINs) or B) existing ad group (a campaign ID and ad group ID). Please use the recommendationType field to specify if you want to use option A or option B. This API is currently available at marketplaces where SP is available. The API supports keyword, auto and product targets. The API will return a 422 response when an unsupported marketplace or target is provided. \u003ch1\u003e Version 5.0 \u003c/h1\u003e\u003ch2\u003e New Features \u003c/h2\u003e\u003cul\u003e\u003cli\u003e Version 5.0 introduces two new capabilities. First, advertisers will receive the estimated impressions for the suggested bid to help them understand the potential impact of adopting them. Second, advertisers will get a view of the estimated impressions for a range of bids (8 bids) for each target. \u003c/li\u003e\u003cli\u003e The second feature is default to be disabled. To enable it, user needs to set \u003cb\u003e includeAnalysis \u003c/b\u003e as True in request body. \u003c/li\u003e\u003cli\u003e New features are currently available only for existing ad group requests in US marketplace. \u003c/li\u003e\u003c/ul\u003e\u003ch1\u003e Version 4.0 \u003c/h1\u003e\u003ch2\u003e New Features \u003c/h2\u003e\u003cul\u003e\u003cli\u003e Version 4.0 allows users to get theme-based bid recommendations for product targeting expressions, including PAT_ASIN, PAT_CATEGORY and PAT_CATEGORY_REFINEMENT. \u003c/li\u003e\u003cli\u003e Version 4.0 supports keyword, auto and product targets in all marketplaces. \u003c/li\u003e\u003cli\u003e Version 4.0 removes \"impact metrics\" when returning each bid suggestion. \u003c/li\u003e\u003cli\u003e Version 4.0 also allows users to get theme-based bid recommendations for keyword group targeting expressions with the type KEYWORD_GROUP. This new type is only available in US marketplace. \u003c/li\u003e\u003c/ul\u003e\u003cbr\u003e\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetMultiCountryThemeBasedBidRecommendationForAdGroup_v1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"Global Account Id Identifier.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"BIDS_FOR_EXISTING_AD_GROUP":"#/components/schemas/MultiCountryAdGroupThemeBasedBidRecommendationRequest","BIDS_FOR_NEW_AD_GROUP":"#/components/schemas/MultiCountryAsinsThemeBasedBidRecommendationRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/MultiCountryAdGroupThemeBasedBidRecommendationRequest"},{"$ref":"#/components/schemas/MultiCountryAsinsThemeBasedBidRecommendationRequest"}]}}}},"responses":{"200":{"content":{"application/vnd.spthemebasedglobalbidrecommendation.v1+json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Method Not Allowed. Request failed because the request HTTP method is not supported."},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Not Acceptable. Request failed because the service cannot produce a response in a format matching the media types provided in the Accept header."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Unsupported Media Type. Request failed because the payload format is not supported."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Unprocessable entity. Failed due to invalid parameters. If you receive an error like “Invalid Advertiser and ASINs combination in the request”, please make sure the ad group has at least one ASIN in it."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCountryThemeBasedBidRecommendationCompleteFailureResponse"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Get bid recommendations for multi-country ad groups","tags":["Multi Country Theme-based bid recommendations"]}},"/sp/global/targets/keywords/recommendations/list":{"post":{"description":"The \u003cb\u003e POST /sp/global/targets/keywords/recommendations/list \u003c/b\u003e endpoint returns recommended keyword targets for a list of countries given either A) a list of ad ASINs per target country or B) a global campaign ID and ad group ID. Please use the recommendationType field to specify if you want to use option A or option B. This endpoint will also return recommended bids along with each recommendation keyword target.\u003cbr\u003e\u003cbr\u003e \u003cb\u003e Asins\u003c/b\u003e \u003cbr\u003eGlobal API endpoint accepts \u003cb\u003easins\u003c/b\u003e array. Item is a \u003cb\u003ecountry asin map\u003c/b\u003e Key is the 2-letter country code. Value is an asin.\u003cbr\u003e\u003cbr\u003e \u003cb\u003e Targets\u003c/b\u003e \u003cbr\u003eGlobal API endpoint accepts \u003cb\u003etargets\u003c/b\u003e array. Item is a \u003cb\u003ecountry target object\u003c/b\u003e Object has two fields: matchType and countryKeywords. CountryKeywords is a map with a key as the 2-letter country code and value as a keyword object. \u003cbr/\u003e\u003cbr/\u003eEach country will be processed in parallel according to rules of \u003ca href\u003d\"https://advertising.amazon.com/API/docs/en-us/sponsored-products/3-0/openapi/prod#tag/Keyword-Targets:~:text\u003dkeywords/localize%20endpoint.-,Version%205.0,-New%20Features\"\u003eversion 5\u003c/a\u003e recommendation API.\u003ch3\u003e Availability \u003c/h3\u003e Global keyword recommendation API is available in all the marketplaces.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getGlobalRankedKeywordRecommendation","parameters":[{"description":"The advertiser\u0027s Marketplace ID associated with the advertiser account to support single marketplace request. Will not be used if global account id is provided.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","schema":{"type":"string"}},{"description":"The advertiser\u0027s ID associated with the advertiser account to support single marketplace request. Will not be used if global account id is provided.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","schema":{"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Used for authentication of Global Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"discriminator":{"mapping":{"KEYWORDS_FOR_ADGROUP":"#/components/schemas/GlobalRankedKeywordTargetsForAdGroupRequest","KEYWORDS_FOR_ASINS":"#/components/schemas/GlobalRankedKeywordTargetsForAsinsRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/GlobalRankedKeywordTargetsForAsinsRequest"},{"$ref":"#/components/schemas/GlobalRankedKeywordTargetsForAdGroupRequest"}]}}}},"responses":{"200":{"content":{"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/GlobalRankedTargetWithThemedBidsResponse"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Unauthorized - Request failed because user is not authenticated in any of requested marketplaces or\nis not allowed to invoke the operation."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Unsupported Media Type Exception."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPTargetingCountryErrors"}}},"description":"Service Unavailable due to transient error or dependent service failure - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Get global keyword recommendations","tags":["Keyword Targets"]}},"/sp/keywords":{"post":{"description":"Create keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsKeywordsResponseContent"}}},"description":"CreateSponsoredProductsKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationExceptionResponseContent"}}},"description":"KeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Keywords"]},"put":{"description":"Update keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsKeywordsResponseContent"}}},"description":"UpdateSponsoredProductsKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationExceptionResponseContent"}}},"description":"KeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Keywords"]}},"/sp/keywords/delete":{"post":{"description":"Delete keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsKeywordsResponseContent"}}},"description":"DeleteSponsoredProductsKeywords 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsKeywordMutationExceptionResponseContent"}}},"description":"KeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Keywords"]}},"/sp/keywords/list":{"post":{"description":"List keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"ListSponsoredProductsKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsKeywordsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsKeywordsResponseContent"}}},"description":"ListSponsoredProductsKeywords 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsKeywordAccessExceptionResponseContent"}}},"description":"KeywordAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Keywords"]}},"/sp/negativeKeywords":{"post":{"description":"Create negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsNegativeKeywordsResponseContent"}}},"description":"CreateSponsoredProductsNegativeKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationExceptionResponseContent"}}},"description":"NegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative keywords"]},"put":{"description":"Update negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsNegativeKeywordsResponseContent"}}},"description":"UpdateSponsoredProductsNegativeKeywords 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationExceptionResponseContent"}}},"description":"NegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative keywords"]}},"/sp/negativeKeywords/delete":{"post":{"description":"Delete negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsNegativeKeywordsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsNegativeKeywordsResponseContent"}}},"description":"DeleteSponsoredProductsNegativeKeywords 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordMutationExceptionResponseContent"}}},"description":"NegativeKeywordMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative keywords"]}},"/sp/negativeKeywords/list":{"post":{"description":"List negative keywords\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsNegativeKeywords","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsNegativeKeywordsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spNegativeKeyword.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsNegativeKeywordsResponseContent"}}},"description":"ListSponsoredProductsNegativeKeywords 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeKeywordAccessExceptionResponseContent"}}},"description":"NegativeKeywordAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative keywords"]}},"/sp/negativeTargets":{"post":{"description":"Create negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsNegativeTargetingClausesResponseContent"}}},"description":"CreateSponsoredProductsNegativeTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationExceptionResponseContent"}}},"description":"NegativeTargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative targeting clauses"]},"put":{"description":"Update negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsNegativeTargetingClausesResponseContent"}}},"description":"UpdateSponsoredProductsNegativeTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationExceptionResponseContent"}}},"description":"NegativeTargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative targeting clauses"]}},"/sp/negativeTargets/brands/recommendations":{"get":{"description":"Returns brands recommended for negative targeting. Only available for Sellers and Vendors. These recommendations include your own brands because targeting your own brands usually results in lower performance than targeting competitors\u0027 brands.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getNegativeBrands","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/Brands"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request - The input fails to satisfy the constraints of the API."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}},"description":"Access Denied - Request failed because the user is not allowed to invoke the operation."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Returns brands recommended for negative targeting.","tags":["Product Targeting"]}},"/sp/negativeTargets/brands/search":{"post":{"description":"Returns up to 100 brands related to keyword input for negative targeting.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"searchBrands","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spproducttargeting.v3+json":{"schema":{"$ref":"#/components/schemas/SearchBrandsRequest"}}}},"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/Brands"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request - The input fails to satisfy the constraints of the API."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Returns brands related to keyword input for negative targeting.","tags":["Product Targeting"]}},"/sp/negativeTargets/delete":{"post":{"description":"Delete negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsNegativeTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsNegativeTargetingClausesResponseContent"}}},"description":"DeleteSponsoredProductsNegativeTargetingClauses 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetMutationExceptionResponseContent"}}},"description":"NegativeTargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative targeting clauses"]}},"/sp/negativeTargets/list":{"post":{"description":"List negative targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsNegativeTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsNegativeTargetingClausesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spNegativeTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsNegativeTargetingClausesResponseContent"}}},"description":"ListSponsoredProductsNegativeTargetingClauses 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNegativeTargetAccessExceptionResponseContent"}}},"description":"NegativeTargetAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Negative targeting clauses"]}},"/sp/productAds":{"post":{"description":"Create product ads\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsProductAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsProductAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsProductAdsResponseContent"}}},"description":"CreateSponsoredProductsProductAds 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationExceptionResponseContent"}}},"description":"ProductAdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Product ads"]},"put":{"description":"Update product ads\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsProductAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsProductAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsProductAdsResponseContent"}}},"description":"UpdateSponsoredProductsProductAds 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationExceptionResponseContent"}}},"description":"ProductAdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Product ads"]}},"/sp/productAds/delete":{"post":{"description":"Delete product ads\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsProductAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsProductAdsRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsProductAdsResponseContent"}}},"description":"DeleteSponsoredProductsProductAds 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsProductAdMutationExceptionResponseContent"}}},"description":"ProductAdMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Product ads"]}},"/sp/productAds/list":{"post":{"description":"List product ads\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredProductsProductAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsProductAdsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spProductAd.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsProductAdsResponseContent"}}},"description":"ListSponsoredProductsProductAds 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsProductAdAccessExceptionResponseContent"}}},"description":"ProductAdAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Product ads"]}},"/sp/rules/campaignOptimization":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateOptimizationRule","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSPCampaignOptimizationRulesRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/CreateSPCampaignOptimizationRulesResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Creates a campaign optimization rule.","tags":["Campaign Optimization Rules"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateOptimizationRule","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSPCampaignOptimizationRulesRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateSPCampaignOptimizationRuleResponse"}}},"description":"Successfully updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error. "}},"summary":"Updates a campaign optimization rule.","tags":["Campaign Optimization Rules"]}},"/sp/rules/campaignOptimization/eligibility":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetOptimizationRuleEligibility","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/SPCampaignOptimizationRecommendationsAPIRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/SPCampaignOptimizationRecommendationAPIResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable Entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error."}},"summary":"Gets a campaign optimization rule eligibility for SP campaigns.","tags":["Campaign Optimization Rules"]}},"/sp/rules/campaignOptimization/state":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetRuleNotification","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/SPCampaignOptimizationNotificationAPIRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/SPCampaignOptimizationNotificationAPIResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error."}},"summary":"Gets campaign optimization rule state. Recommended refresh frequency is once a day.","tags":["Campaign Optimization Rules"]}},"/sp/rules/campaignOptimization/{campaignOptimizationId}":{"delete":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteCampaignOptimizationRule","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The sp campaign optimization rule identifier.","in":"path","name":"campaignOptimizationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteSPCampaignOptimizationRuleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Resource not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error."}},"summary":"Deletes a campaign optimization rule specified by identifier.","tags":["Campaign Optimization Rules"]},"get":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetCampaignOptimizationRule","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The sp campaign optimization rule identifier.","in":"path","name":"campaignOptimizationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.optimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/GetSPCampaignOptimizationRuleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Forbidden. The request failed because user does not have access to a specified resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Resource not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignOptimizationRuleError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a campaign optimization rule specified by identifier.","tags":["Campaign Optimization Rules"]}},"/sp/rules/optimization":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateOptimizationRules","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.\nUse `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spoptimizationrules.v1+json":{"examples":{"singleRuleForEveryMorning":{"value":{"optimizationRules":[{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"15"},"actionType":"ADOPT"},"recurrence":{"duration":{"startTime":"2022-11-01T00:00:00Z"},"timesOfDay":[{"endTime":"07:00","startTime":"05:00"}],"type":"DAILY"},"ruleCategory":"BID","ruleName":"increase_bids_by_15%_on_mornings","ruleSubCategory":"SCHEDULE","status":"ENABLED"}]}},"singleRuleForWeekendNightsWithDuration":{"value":{"optimizationRules":[{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"50"},"actionType":"ADOPT"},"recurrence":{"daysOfWeek":["SATURDAY","SUNDAY"],"duration":{"endTime":"2024-11-01T00:00:00Z","startTime":"2022-11-01T00:00:00Z"},"timesOfDay":[{"endTime":"14:00","startTime":"12:00"}],"type":"WEEKLY"},"ruleCategory":"BID","ruleName":"increase_bids_by_50%_on_weekend_nights","ruleSubCategory":"SCHEDULE","status":"ENABLED"}]}}},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerCreateOptimizationRulesRequest"}},"application/vnd.spoptimizationrules.v2+json":{"examples":{"singleRuleForEveryMorning":{"value":{"optimizationRules":[{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"15"},"actionType":"ADOPT"},"recurrence":{"duration":{"startTime":"2022-11-01T00:00:00Z"},"timesOfDay":[{"endTime":"07:00","startTime":"05:00"}],"type":"DAILY"},"ruleCategory":"BID","ruleName":"increase_bids_by_15%_on_mornings","ruleSubCategory":"SCHEDULE","status":"ENABLED"}]}},"singleRuleForPromotingTargetAndRaisingBid":{"value":{"optimizationRules":[{"action":{"actionDetails":{"actionOperator":"INCREMENT","actionUnit":"PERCENT","value":"50"},"actionType":"ADOPT"},"conditions":[{"attributeName":"CLICKS","criteria":{"comparisonOperator":"GREATER_THAN_OR_EQUAL_TO","value":"2"}}],"ruleCategory":"TARGETING","ruleName":"increase_bids_by_50%_on_target_promotion","ruleSubCategory":"PERFORMANCE","status":"ENABLED","targeting":[{"expressionTypes":["BROAD","EXACT"],"lookbackDays":"14","targetingType":"KEYWORD"}]}]}}},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerCreateOptimizationRulesRequestV2"}}}},"responses":{"207":{"content":{"application/vnd.spoptimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesResponse"}},"application/vnd.spoptimizationrules.v2+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerCreateOptimizationRulesResponseV2"}}},"description":"Multi-status.\nAn object containing a list of optimization rule response objects reflecting the same order as the input.\n"},"400":{"content":{"application/json":{"example":{"code":"400","message":"Invalid advertiser id."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Bad request caused by invalid input."},"401":{"content":{"application/json":{"example":{"code":"401","message":"Unauthenticated."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Unauthenticated. Request failed because user is not authenticated.\n"},"403":{"content":{"application/json":{"example":{"code":"403","message":"You do not have permission to access the resource."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource.\n"},"500":{"content":{"application/json":{"example":{"code":"500","message":"Internal server error."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Creates one or more optimization rules.\n","tags":["Optimization Rules"]},"put":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateOptimizationRules","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.\nUse `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spoptimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerUpdateOptimizationRulesRequest"}},"application/vnd.spoptimizationrules.v2+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerUpdateOptimizationRulesRequestV2"}}}},"responses":{"207":{"content":{"application/vnd.spoptimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesResponse"}},"application/vnd.spoptimizationrules.v2+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerUpdateOptimizationRulesResponseV2"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"example":{"code":"400","message":"Invalid advertiser id."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Bad request caused by invalid input."},"401":{"content":{"application/json":{"example":{"code":"401","message":"Unauthenticated."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Unauthenticated. Request failed because user is not authenticated.\n"},"403":{"content":{"application/json":{"example":{"code":"403","message":"You do not have permission to access the resource."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource.\n"},"500":{"content":{"application/json":{"example":{"code":"500","message":"Internal server error."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Updates one or more optimization rules.\n","tags":["Optimization Rules"]}},"/sp/rules/optimization/search":{"post":{"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SearchOptimizationRules","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.\nUse `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.\nThis is a required header for advertisers and integrators using the Advertising API.\n","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spoptimizationrules.v1+json":{"examples":{"getIntradayBiddingRulesByMultipleCampaignIds":{"value":{"campaignFilter":{"campaignId":{"filterType":"EXACT_MATCH","values":["12345678","34567890"]}},"optimizationRuleFilter":{"ruleCategory":{"filterType":"EXACT_MATCH","values":["BID"]},"ruleSubCategory":{"filterType":"EXACT_MATCH","values":["SCHEDULE"]}}}},"getIntradayBiddingRulesBySingleCampaignId":{"value":{"campaignFilter":{"campaignId":{"filterType":"EXACT_MATCH","values":["12345678"]}},"optimizationRuleFilter":{"ruleCategory":{"filterType":"EXACT_MATCH","values":["BID"]},"ruleSubCategory":{"filterType":"EXACT_MATCH","values":["SCHEDULE"]}}}},"getMultipleOptimizationRulesByRuleId":{"value":{"optimizationRuleFilter":{"optimizationRuleId":{"filterType":"EXACT_MATCH","values":["29aeb716-2ba7-4fae-9f9a-3e8306e0ca0f","c735308f-fd6c-49a6-b2a8-e53f354265bc"]}}}},"getSingleOptimizationRuleByRuleId":{"value":{"optimizationRuleFilter":{"optimizationRuleId":{"filterType":"EXACT_MATCH","values":["29aeb716-2ba7-4fae-9f9a-3e8306e0ca0f"]}}}}},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSearchOptimizationRulesRequest"}},"application/vnd.spoptimizationrules.v2+json":{"examples":{"FilterOptimizationRuleByNameAndLimitResultTo100Rules":{"value":{"maxResults":100,"optimizationRuleFilter":{"ruleName":{"filterType":"BROAD_MATCH","values":["rule_name"]}}}},"getMultipleOptimizationRulesByRuleId":{"value":{"optimizationRuleFilter":{"optimizationRuleId":{"filterType":"EXACT_MATCH","values":["29aeb716-2ba7-4fae-9f9a-3e8306e0ca0f","c735308f-fd6c-49a6-b2a8-e53f354265bc"]}}}},"getOptimizationRulesByRuleCategoryAndSubCategory":{"value":{"optimizationRuleFilter":{"ruleCategory":{"filterType":"EXACT_MATCH","values":["BID"]},"ruleSubCategory":{"filterType":"EXACT_MATCH","values":["SCHEDULE"]}}}},"getSingleOptimizationRuleByRuleId":{"value":{"optimizationRuleFilter":{"optimizationRuleId":{"filterType":"EXACT_MATCH","values":["29aeb716-2ba7-4fae-9f9a-3e8306e0ca0f"]}}}},"sortOptimizationRuleByRuleName":{"value":{"sortBy":["NAME"]}}},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSearchOptimizationRulesRequestV2"}}}},"responses":{"200":{"content":{"application/vnd.spoptimizationrules.v1+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSearchOptimizationRulesResponse"}},"application/vnd.spoptimizationrules.v2+json":{"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerSearchOptimizationRulesResponseV2"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"example":{"code":"400","message":"Invalid advertiser id."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Bad request caused by invalid input."},"401":{"content":{"application/json":{"example":{"code":"401","message":"Unauthenticated."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Unauthenticated. Request failed because user is not authenticated.\n"},"403":{"content":{"application/json":{"example":{"code":"403","message":"You do not have permission to access the resource."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource.\n"},"500":{"content":{"application/json":{"example":{"code":"500","message":"Internal server error."},"schema":{"$ref":"#/components/schemas/OptimizationRulesAPISwaggerOptimizationRulesError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Searches optimization rules based on optional filters.\n","tags":["Optimization Rules"]}},"/sp/targetPromotionGroups":{"post":{"description":"Creates a target promotion group, by grouping the auto-targeting adGroupId\nand manual-targeting adGroups, divided by keyword targeting adGroups, and product targeting adGroups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"CreateTargetPromotionGroups","parameters":[{"description":" The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","type":"string"}}],"requestBody":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupsRequestContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupsV2RequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupsResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupsV2ResponseContent"}}},"description":"CreateTargetPromotionGroups 200 response"},"400":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 400 response"},"401":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}}},"description":"UnauthenticatedException 401 response"},"403":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"501":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}}},"description":"NotImplementedException 501 response"},"503":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"}},"tags":["TargetPromotionGroups"]}},"/sp/targetPromotionGroups/list":{"post":{"description":"Returns the target promotion groups for an advertiser and / or adGroupId, and / or target\npromotion group id.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"ListTargetPromotionGroups","parameters":[{"description":" The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","type":"string"}}],"requestBody":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupsRequestContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupsV2RequestContent"}}}},"responses":{"200":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupsResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupsV2ResponseContent"}}},"description":"ListTargetPromotionGroups 200 response"},"400":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 400 response"},"401":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}}},"description":"UnauthenticatedException 401 response"},"403":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"501":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}}},"description":"NotImplementedException 501 response"},"503":{"content":{"application/vnd.sptargetpromotiongroup.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}},"application/vnd.sptargetpromotiongroup.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"}},"tags":["TargetPromotionGroups"]}},"/sp/targetPromotionGroups/recommendations":{"post":{"description":"Retrieves keyword and product targets of an auto-targeting campaign as recommendations for promoting to a manual-targeting campaign. The recommendations are based on performance heuristics of the targets.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetTargetPromotionGroupsRecommendations","parameters":[{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"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.","type":"string"}}],"requestBody":{"content":{"application/vnd.spTargetPromotionGroupsRecommendations.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsGetTargetPromotionGroupsRecommendationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spTargetPromotionGroupsRecommendations.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsGetTargetPromotionGroupsRecommendationsResponseContent"}}},"description":"GetTargetPromotionGroupsRecommendations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"}},"tags":["TargetPromotionGroups"]}},"/sp/targetPromotionGroups/targets":{"post":{"description":"Creates keyword and/or product targets in the manual adGroup that are part of the target promotion group\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"CreateTargetPromotionGroupTargets","parameters":[{"description":" The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","type":"string"}}],"requestBody":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsRequestContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsV2RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateTargetPromotionGroupTargetsV2ResponseContent"}}},"description":"CreateTargetPromotionGroupTargets 207 response"},"400":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 400 response"},"401":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}}},"description":"UnauthenticatedException 401 response"},"403":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"501":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}}},"description":"NotImplementedException 501 response"},"503":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"}},"tags":["TargetPromotionGroups"]}},"/sp/targetPromotionGroups/targets/list":{"post":{"description":"Returns the targets created through target promotion groups for an advertiser and / or given target promotion group.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"ListTargetPromotionGroupTargets","parameters":[{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account. This is a required\n    header for advertisers and integrators using the Advertising API.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles\n    resource to list profiles associated with the access token passed in the HTTP Authorization header. This is a\n    required header for advertisers and integrators using the Advertising API.","type":"string"}}],"requestBody":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupTargetsRequestContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupTargetsV2RequestContent"}}}},"responses":{"200":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupTargetsResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListTargetPromotionGroupTargetsV2ResponseContent"}}},"description":"ListTargetPromotionGroupTargets 200 response"},"400":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsSchemaValidationExceptionResponseContent"}}},"description":"SchemaValidationException 400 response"},"401":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthenticatedExceptionResponseContent"}}},"description":"UnauthenticatedException 401 response"},"403":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"501":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsNotImplementedExceptionResponseContent"}}},"description":"NotImplementedException 501 response"},"503":{"content":{"application/vnd.sptargetpromotiongrouptarget.v1+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}},"application/vnd.sptargetpromotiongrouptarget.v2+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"}},"tags":["TargetPromotionGroups"]}},"/sp/targeting/recommendations/keywordGroups":{"post":{"description":"This API (currently beta) recommends Keyword Group targets for a given list of Ad ASINs. Keyword Groups is a new control for Amazon Ads Sponsored Products keyword-based campaigns that enables advertisers to reach relevant audiences through a collection of keywords.\n\nOnce a Keyword Group specification is created, the performance of Keyword Groups will be available in the search terms report. Keyword Groups improves campaign performance by dynamically updating the keywords within a group through the campaign lifecycle and eliminates the need for advertisers to constantly curate new keywords. Additionally, Keyword Groups can be used alongside keywords within the same ad group.\n\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getKeywordGroupRecommendations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","explode":false,"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The identifier of an account. Account can be a global advertising account. This will be a required header for the global calls.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"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.","explode":false,"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"},"style":"simple"},{"description":"User specified locale. If nothing is passed the default for the marketplace will be used. The value should confirm to the IETF BCP 47 standard, using language tags composed of language- and optionally region specific sub-tags (e.g., \u0027en-us\u0027 for American English and \u0027fr-CA\u0027 for Canadian French).","explode":false,"in":"header","name":"locale","schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/KeywordGroupsRecommendationsRequest"}}}},"responses":{"200":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/KeywordGroupsRecommendationsResponse"}}},"description":"Success."},"400":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Unauthorized."},"403":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Not Authenticated."},"404":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Not Found."},"415":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Unsupported Media."},"424":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Dependency Failure."},"429":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Internal Server Error."},"503":{"content":{"application/vnd.spkeywordgroupsrecommendations.v1.0+json":{"schema":{"$ref":"#/components/schemas/SPKeywordGroupsException"}}},"description":"Service Unavailable"}},"tags":["Keyword Group Targeting Recommendations"]}},"/sp/targets":{"post":{"description":"Create targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"CreateSponsoredProductsTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsCreateSponsoredProductsTargetingClausesResponseContent"}}},"description":"CreateSponsoredProductsTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Targeting clauses"]},"put":{"description":"Update targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"UpdateSponsoredProductsTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","in":"header","name":"Prefer","schema":{"description":"The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service.\nThe service ignores preference values that are either not supported or not known by the service.\nEither multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent\nSupported preferences:\nreturn\u003drepresentation - return the full object when doing create/update/delete operations instead of ids.\nPlease note that the extendedData field will be part of the full object for /list endpoints only.","type":"string"}}],"requestBody":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUpdateSponsoredProductsTargetingClausesResponseContent"}}},"description":"UpdateSponsoredProductsTargetingClauses 207 response","headers":{"Preference-Applied":{"description":"Header containing preferences applied while processing API call","schema":{"description":"Header containing preferences applied while processing API call","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Targeting clauses"]}},"/sp/targets/bid/recommendations":{"post":{"description":"The \u003cb\u003e POST /sp/targets/bid/recommendations \u003c/b\u003e endpoint returns recommended bids for each target given either A) new ad group (a list of ad ASINs) or B) existing ad group (a campaign ID and ad group ID). Please use the recommendationType field to specify if you want to use option A or option B. This API is currently available at marketplaces where SP is available. The API supports keyword, auto and product targets. The API will return a 422 response when an unsupported marketplace or target is provided. \u003ch1\u003e Version 5.0 \u003c/h1\u003e\u003ch2\u003e New Features \u003c/h2\u003e\u003cul\u003e\u003cli\u003e Version 5.0 introduces two new capabilities. First, advertisers will receive the estimated impressions for the suggested bid to help them understand the potential impact of adopting them. Second, advertisers will get a view of the estimated impressions for a range of bids (8 bids) for each target. \u003c/li\u003e\u003cli\u003e The second feature is default to be disabled. To enable it, user needs to set \u003cb\u003e includeAnalysis \u003c/b\u003e as True in request body. \u003c/li\u003e\u003cli\u003e New features are currently available only for existing ad group requests in US marketplace. \u003c/li\u003e\u003c/ul\u003e\u003ch1\u003e Version 4.0 \u003c/h1\u003e\u003ch2\u003e New Features \u003c/h2\u003e\u003cul\u003e\u003cli\u003e Version 4.0 allows users to get theme-based bid recommendations for product targeting expressions, including PAT_ASIN, PAT_CATEGORY and PAT_CATEGORY_REFINEMENT. \u003c/li\u003e\u003cli\u003e Version 4.0 supports keyword, auto and product targets in all marketplaces. \u003c/li\u003e\u003cli\u003e Version 4.0 removes \"impact metrics\" when returning each bid suggestion. \u003c/li\u003e\u003cli\u003e Version 4.0 also allows users to get theme-based bid recommendations for keyword group targeting expressions with the type KEYWORD_GROUP. This new type is only available in US marketplace. \u003c/li\u003e\u003c/ul\u003e\u003cbr\u003e\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetThemeBasedBidRecommendationForAdGroup_v1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"discriminator":{"mapping":{"BIDS_FOR_EXISTING_AD_GROUP":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequest","BIDS_FOR_NEW_AD_GROUP":"#/components/schemas/AsinsThemeBasedBidRecommendationRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequest"},{"$ref":"#/components/schemas/AsinsThemeBasedBidRecommendationRequest"}]}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"discriminator":{"mapping":{"BIDS_FOR_EXISTING_AD_GROUP":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequestV4","BIDS_FOR_NEW_AD_GROUP":"#/components/schemas/AsinsThemeBasedBidRecommendationRequestV4"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequestV4"},{"$ref":"#/components/schemas/AsinsThemeBasedBidRecommendationRequestV4"}]}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"discriminator":{"mapping":{"BIDS_FOR_EXISTING_AD_GROUP":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequestV5","BIDS_FOR_NEW_AD_GROUP":"#/components/schemas/AsinsThemeBasedBidRecommendationRequestV5"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/AdGroupThemeBasedBidRecommendationRequestV5"},{"$ref":"#/components/schemas/AsinsThemeBasedBidRecommendationRequestV5"}]}}}},"responses":{"200":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/ThemeBasedBidRecommendationResponse"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/ThemeBasedBidRecommendationResponseV4"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/ThemeBasedBidRecommendationResponseV5"}}},"description":"Successful Operation."},"400":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"405":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Method Not Allowed. Request failed because the request HTTP method is not supported."},"406":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Not Acceptable. Request failed because the service cannot produce a response in a format matching the media types provided in the Accept header."},"415":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Unsupported Media Type. Request failed because the payload format is not supported."},"422":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Unprocessable entity. Failed due to invalid parameters. If you receive an error like “Invalid Advertiser and ASINs combination in the request”, please make sure the ad group has at least one ASIN in it."},"429":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spthemebasedbidrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}},"application/vnd.spthemebasedbidrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/BidRecommendationError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Get bid recommendations for ad groups","tags":["Theme-based bid recommendations"]}},"/sp/targets/categories":{"get":{"description":"Returns all targetable categories. This API returns a large JSON string containing a tree of category nodes. Each category node has the fields - category id, category name, and child categories.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getTargetableCategories","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}},{"description":"The locale to which the caller wishes to translate the targetable categories to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned targetable categories will be in the default language of the marketplace.","in":"query","name":"locale","schema":{"enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/TargetableCategories"}},"application/vnd.spproducttargetingresponse.v4+json":{"schema":{"$ref":"#/components/schemas/TargetableCategories"}},"application/vnd.spproducttargetingresponse.v5+json":{"schema":{"$ref":"#/components/schemas/TargetableCategoriesLoP"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Returns all targetable categories.","tags":["Product Targeting"]}},"/sp/targets/categories/recommendations":{"post":{"description":"Returns a list of category recommendations for the input list of ASINs. Use this API to discover relevant categories to target. To find ASINs, either use the Product Metadata API or browse the Amazon Retail Website. \u003cbr\u003e \u003cul\u003e\u003cli\u003eResponse can be requested in different versions with the help of accept header. Please review the response mediaTypes for more information.\u003c/li\u003e\u003cul\u003e\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getCategoryRecommendationsForASINs","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}},{"description":"The locale to which the caller wishes to translate the list of category recommendations to. For example, if the caller wishes to receive a list of category recommendations in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned list of category recommendations will be in the default language of the marketplace.","in":"query","name":"locale","schema":{"enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"],"type":"string"}}],"requestBody":{"content":{"application/vnd.spproducttargeting.v3+json":{"schema":{"$ref":"#/components/schemas/GetCategoryRecommendationsForAsinsRequest"}}}},"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/CategoryRecommendations"}},"application/vnd.spproducttargetingresponse.v4+json":{"schema":{"$ref":"#/components/schemas/CategoryRecommendationsWithAsinCounts"}},"application/vnd.spproducttargetingresponse.v5+json":{"schema":{"$ref":"#/components/schemas/CategoryRecommendationsWithAsinCountsLoP"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Returns a list of category recommendations for the input list of ASINs.","tags":["Product Targeting"]}},"/sp/targets/category/{categoryId}/refinements":{"get":{"description":"Returns refinements according to category input.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getRefinementsForCategory","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The category ID. Please use the GetTargetableCategories API or the GetCategoriesForASINs API to retrieve categories IDs. This API does not check if the category is a valid category.","in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}},{"description":"The locale to which the caller wishes to translate the refinements to. For example, if the caller wishes to receive the refinements in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the refinements will be in the default language of the marketplace.","in":"query","name":"locale","schema":{"enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"],"type":"string"}}],"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/Refinements"}},"application/vnd.spproducttargetingresponse.v4+json":{"schema":{"$ref":"#/components/schemas/RefinementsLoP"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Returns refinements according to category input.","tags":["Product Targeting"]}},"/sp/targets/delete":{"post":{"description":"Delete targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"DeleteSponsoredProductsTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsTargetingClausesRequestContent"}}},"required":true},"responses":{"207":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsDeleteSponsoredProductsTargetingClausesResponseContent"}}},"description":"DeleteSponsoredProductsTargetingClauses 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsTargetMutationExceptionResponseContent"}}},"description":"TargetMutationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Targeting clauses"]}},"/sp/targets/keywords/recommendations":{"post":{"description":"The \u003cb\u003e POST /sp/targets/keywords/recommendations \u003c/b\u003e endpoint returns recommended keyword targets given either A) a list of ad ASINs or B) a campaign ID and ad group ID. Please use the recommendationType field to specify if you want to use option A or option B. This endpoint will also return recommended bids along with each recommendation keyword target.\u003cbr\u003e\u003cbr\u003e \u003cb\u003e Ranking \u003c/b\u003e \u003cbr\u003e The keyword recommendations will be ranked in descending order of clicks or impressions, depending on the \u003cb\u003esortDimension\u003c/b\u003e field provided by the user. You may also input your own keyword targets to be ranked alongside the keyword recommendations by using the \u003cb\u003etargets\u003c/b\u003e array. \u003cbr\u003e\u003cbr\u003e \u003cb\u003e Localization \u003c/b\u003e \u003cbr\u003e Use the \u003cb\u003e locale \u003c/b\u003e field to get keywords in your specified locale. Supported marketplace to locale mappings can be found at the \u003ca href\u003d\u0027https://advertising.amazon.com/API/docs/en-us/localization/#/Keyword%20Localization\u0027\u003ePOST /keywords/localize\u003c/a\u003e endpoint. \u003ch1\u003e Version 5.0 \u003c/h1\u003e  \u003ch2\u003e New Features \u003c/h2\u003e Version 5.0 utilizes the new theme-based bid recommendations, which can be retrieved at the endpoint \u003cb\u003e/sp/targets/bid/recommendations\u003c/b\u003e, to return improved bid recommendations for each keyword. Theme-based bid recommendations provide \\\\\\\"themes\\\\\\\" and \\\\\\\"impact metrics\\\\\\\" along with each bid suggestion to help you choose the right bid for your keyword target.\u003cbr\u003e\u003cbr\u003e\u003cb\u003eThemes\u003c/b\u003e\u003cbr\u003e We now may return multiple bid suggestions for each keyword target. Each suggestion will have a theme to express the business objective of the bid. Available themes are: \u003cul\u003e \u003cli\u003e CONVERSION_OPPORTUNITIES - The default theme which aims to maximize number of conversions. \u003c/li\u003e \u003cli\u003e SPECIAL_DAYS - A theme available during high sales events such as Prime Day, to anticipate an increase in sales and competition.\u003c/li\u003e\u003c/ul\u003e\u003cb\u003eImpact Metrics\u003c/b\u003e\u003cbr\u003eWe have added impact metrics which provide insight on the number of clicks and conversions you will receive for targeting a keyword at a certain bid. \u003cbr\u003e\u003cbr\u003e\u003cb\u003eBidding Strategy\u003c/b\u003e\u003cbr\u003e You may now specify your bidding strategy in the KEYWORDS_BY_ASINS request to get bid suggestions tailored to your bidding strategy. For KEYWORDS_BY_ADGROUP requests, you will not specify a bidding strategy, because the bidding strategy of the ad group is used. The three bidding strategies are: \u003cul\u003e \u003cli\u003e LEGACY_FOR_SALES - Dynamic bids (down only) \u003c/li\u003e \u003cli\u003e AUTO_FOR_SALES - Dynamic bids (up and down) \u003c/li\u003e \u003cli\u003e MANUAL - Fixed bids \u003c/li\u003e \u003c/ul\u003e \u003ch3\u003e Availability \u003c/h3\u003e Version 5.0 is only available in the following marketplaces: US, CA, BR, MX, UK, DE, FR, ES, IN, IT, NL, AE, SA, TR, EG, BE, SE, PL, JP, AU, SG. \u003ch1\u003e Version 4.0 \u003c/h1\u003e \u003ch2\u003e New features \u003c/h2\u003e Version 4.0 allows users to retrieve recommended keyword targets which are sorted in descending order of clicks or conversions. The default sort dimension, if not specified, ranks recommendations by our interal ranking mechanism. We have also added search term metrics. \u003cb\u003e Search term impression share \u003c/b\u003e indicates the percentage share of all ad-attributed impressions you received on that keyword in the last 30 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords. \u003cb\u003e Search term impression rank \u003c/b\u003e indicates your ranking among all advertisers for the keyword by ad impressions in a marketplace. It tells an advertiser how many advertisers had higher share of ad impressions. \u003ci\u003e Search term information is only available for keywords the advertiser targeted with ad impressions. \u003c/i\u003e \u003ch3\u003e Availability \u003c/h3\u003e Version 4.0 is available in all marketplaces.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getRankedKeywordRecommendation","parameters":[{"description":"The advertiser\u0027s Marketplace ID associated with the advertiser.\naccount.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","schema":{"type":"string"}},{"description":"The advertiser\u0027s ID associated with the advertiser account.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","schema":{"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"discriminator":{"mapping":{"KEYWORDS_FOR_ADGROUP":"#/components/schemas/AdGroupKeywordTargetRankRecommendationRequest","KEYWORDS_FOR_ASINS":"#/components/schemas/AsinsKeywordTargetRankRecommendationRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/AdGroupKeywordTargetRankRecommendationRequest"},{"$ref":"#/components/schemas/AsinsKeywordTargetRankRecommendationRequest"}]}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"discriminator":{"mapping":{"KEYWORDS_FOR_ADGROUP":"#/components/schemas/AdGroupKeywordTargetRankRecommendationRequest","KEYWORDS_FOR_ASINS":"#/components/schemas/AsinsKeywordTargetRankRecommendationRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/AdGroupKeywordTargetRankRecommendationRequest"},{"$ref":"#/components/schemas/AsinsKeywordTargetRankRecommendationRequest"}]}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"discriminator":{"mapping":{"KEYWORDS_FOR_ADGROUP":"#/components/schemas/RankedKeywordTargetsForAdGroupRequest","KEYWORDS_FOR_ASINS":"#/components/schemas/RankedKeywordTargetsForAsinsRequest"},"propertyName":"recommendationType"},"oneOf":[{"$ref":"#/components/schemas/RankedKeywordTargetsForAsinsRequest"},{"$ref":"#/components/schemas/RankedKeywordTargetsForAdGroupRequest"}]}}}},"responses":{"200":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/KeywordTargetResponse"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/RankedTargetResponse"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/RankedTargetWithThemedBidsResponse"}}},"description":"success"},"400":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Bad Request"},"401":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Unauthorized - Request failed because user is not authenticated or\nis not allowed to invoke the operation."},"415":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Unsupported Media Type Exception."},"422":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."},"503":{"content":{"application/vnd.spkeywordsrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v4+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}},"application/vnd.spkeywordsrecommendation.v5+json":{"schema":{"$ref":"#/components/schemas/SPTargetingError"}}},"description":"Service Unavailable due to transient error or dependent service failure - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Get keyword recommendations","tags":["Keyword Targets"]}},"/sp/targets/list":{"post":{"description":"List targeting clauses\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"campaign_proposed\"]","operationId":"ListSponsoredProductsTargetingClauses","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list\nprofiles associated with the access token passed in the HTTP Authorization header.","type":"string"}}],"requestBody":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsTargetingClausesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.spTargetingClause.v3+json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsListSponsoredProductsTargetingClausesResponseContent"}}},"description":"ListSponsoredProductsTargetingClauses 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsTargetAccessExceptionResponseContent"}}},"description":"TargetAccessException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsUnsupportedMediaTypeExceptionResponseContent"}}},"description":"UnsupportedMediaTypeException 415 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended","format":"int32","type":"integer"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsoredProductsInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Targeting clauses"]}},"/sp/targets/products/count":{"post":{"description":"Get number of targetable asins based on refinements provided by the user. Please use the GetTargetableCategories API or the GetCategoryRecommendationsForASINs API to retrieve the category ID. Please use the GetRefinementsByCategory API to retrieve refinements data for a category.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getTargetableASINCounts","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"Used to indicate the behavior preferred by the client but is not required for successful completion of the request. Supported values will be updated in the future.","in":"header","name":"Prefer","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spproducttargeting.v3+json":{"schema":{"$ref":"#/components/schemas/GetTargetableAsinCountsRequest"}}}},"responses":{"200":{"content":{"application/vnd.spproducttargetingresponse.v3+json":{"schema":{"$ref":"#/components/schemas/TargetableAsinCounts"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request - The input fails to satisfy the constraints of the API."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}},"description":"Unauthorized - Request failed because user is not authenticated."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved."}},"summary":"Get number of targetable asins based on refinements provided by the user.","tags":["Product Targeting"]}},"/sp/targets/products/recommendations":{"post":{"description":"Given an advertised ASIN as input, this API returns suggested ASINs to target in a product targeting campaign. We use various methods to generate these suggestions. These include using historical performance of your ad, items that shoppers they frequently view and purchase together, etc. The suggested targets can be retrieved either as a single list, or grouped by ‘theme\u0027 – i.e. an accompanying context for why we recommend the items. You can pick the desired format using the Accepts header, please see the response mediaTypes for more information. \u003c/br\u003e\n\u003ch4\u003ePagination Behavior\u003c/h4\u003e The API supports cursor based pagination using encoded cursor values to return next set of records or previously served records. The \u003cb\u003ecount\u003c/b\u003e parameter in the request body will be used to determine the size of results when requesting the previous page or next page. If no value for \u003cb\u003ecount\u003c/b\u003e is passed in the request, a default value is assumed. Please refer the range and defaults for these values in the request schema under GetProductRecommendationsRequest. \u003c/br\u003e \u003ci\u003e\u003cb\u003eNote:\u003c/b\u003e The clients should never cache pagination cursor values locally as these values will expire after a certain time period. However a cursor value can be reused to perform retries in case of failures as long as the value has not expired.\n\u003c/br\u003e\u003c/br\u003e \u003ch4\u003eThemes \u003c/h4\u003e Themes provide additional context for why we are recommending a product as a target. See below for an overall list of themes currently available –  \u003c/br\u003e\u003cb\u003e- Top converting targets\u003c/b\u003e – These ASINs generated conversions for the input ASIN in the past 30 days (e.g. your product appeared as an ad on the detail page of these items, and a shopper clicked and purchased your item). The suggested ASINs under this theme are sorted in decreasing order of sales generated for your promoted item. \u003c/br\u003e\u003cb\u003e- Similar items (frequently viewed together)\u003c/b\u003e – Items that shoppers frequently view and click along with your advertised item during a shopping session.\n\u003c/br\u003e\u003cb\u003e- Complements\u003c/b\u003e – Items that are frequently purchased together as complements. For example, if you are promoting a tennis racquet, you may see tennis balls recommended under this theme.\n\u003c/br\u003e\u003cb\u003e- Similar items with low ratings and reviews\u003c/b\u003e – Subset of the ‘similar items’ theme containing items that are rated lower than 3 stars and/or with fewer than 5 reviews.\n\u003c/br\u003e\u003cb\u003e- Other books read by your readers\u003c/b\u003e – Items that shoppers frequently view and click along with your advertised item during a shopping session. \u003c/br\u003e\u003c/br\u003e\u003ci\u003e\u003cb\u003eNote:\u003c/b\u003e Availability of themes differs by input ASIN - some ASINs may not have all above themes available\u003c/i\u003e\n","operationId":"getProductRecommendations","parameters":[{"description":"The Advertiser ID associated with the advertiser account.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","schema":{"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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. This is a required header for advertisers and integrators using the Advertising API.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.spproductrecommendation.v3+json":{"schema":{"$ref":"#/components/schemas/GetProductRecommendationsRequest"}}}},"responses":{"200":{"content":{"application/vnd.spproductrecommendationresponse.asins.v3+json":{"schema":{"$ref":"#/components/schemas/ProductRecommendationsByASIN"}},"application/vnd.spproductrecommendationresponse.themes.v3+json":{"schema":{"$ref":"#/components/schemas/ProductRecommendationsByTheme"}}},"description":"success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}},"description":"Bad Request"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityException"}}},"description":"Unprocessable entity - Failed due to invalid parameters."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Suggested target ASINs for your advertised product","tags":["Product Recommendation Service"]}},"/sp/v1/events":{"post":{"description":"A rule enables an automatic budget increase for a specified date range or for a special event. The response includes the suggested date range for each special event.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SPGetAllRuleEvents","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetAllRuleEventRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetAllRuleEventResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetRuleEventError"}}},"description":"Bad Request."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetRuleEventError"}}},"description":"Too Many Requests. Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SPGetRuleEventError"}}},"description":"Internal Server Error. Something went wrong on the server."}},"summary":"Gets all special individual and grouped events with suggested date range in advertiser\u0027s marketplace.","tags":["BudgetRulesRecommendation"]}}}}