Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"APIError":{"description":"Error response object providing information on API error.","properties":{"code":{"description":"HTTP status code of the response.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","message"],"type":"object"},"APISuccess":{"description":"Response object providing information on API success.","properties":{"code":{"description":"HTTP status code of the response.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","message"],"type":"object"},"AdProduct":{"enum":["SB","SD","SP","ST"],"type":"string"},"ApplyRecommendationFailure":{"properties":{"error":{"$ref":"#/components/schemas/APIError"},"index":{"description":"Index of the recommendation in the array from the request body.","type":"number"},"recommendationId":{"description":"Recommendation identifier.","type":"string"}},"required":["error","index","recommendationId"],"type":"object"},"ApplyRecommendationSuccess":{"properties":{"index":{"description":"Index of the recommendation in the array from the request body.","type":"number"},"recommendation":{"$ref":"#/components/schemas/Recommendation"},"recommendationId":{"description":"Recommendation identifier.","type":"string"},"success":{"$ref":"#/components/schemas/APISuccess"}},"required":["index","recommendation","recommendationId","success"],"type":"object"},"ApplyRecommendationsRequest":{"properties":{"recommendationIds":{"description":"Recommendation identifier.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["recommendationIds"],"type":"object"},"ApplyRecommendationsResponse":{"properties":{"failures":{"items":{"$ref":"#/components/schemas/ApplyRecommendationFailure","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/ApplyRecommendationSuccess","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"required":["failures","successes"],"type":"object"},"AsinContext":{"description":"Underlying asin context behind generating the recommendation.","properties":{"seasonEndDate":{"description":"Date in which the products in the advertiser's category historically traffic-increase has cooled off.","format":"date","type":"string"},"seasonStartDate":{"description":"Date in which the products in the advertiser's category have historically started to see an increase in traffic.","format":"date","type":"string"},"trailing4WeeksClickthroughRate":{"description":"Past 4 weeks clickthrough rate of target product type.","type":"number"},"trailing4WeeksConversionRate":{"description":"Past 4 weeks conversion rate of target product type.","type":"number"}},"type":"object"},"Benchmark":{"description":"The value of a campaign performance metric relative to peer campaigns, where peer campaigns are identified using an unsupervised learning model that groups campaigns into mutually exclusive clusters o...","properties":{"benchmarkValue":{"description":"The benchmark for the campaign for a given metric. This value is based on the performance of similar campaigns for the given metric over the specific time period.","type":"number"},"percentDifference":{"description":"The percent difference relative to the benchmark value.","type":"number"},"period":{"description":"The time period in days over which the metric value was determined.","type":"number"}},"type":"object"},"BenchmarkContext":{"description":"Benchmark Context for the recommendation. \n | Benchmark | Description |\n|---|---|\n| Impressions | Impressions received by the campaign over the specified time period |\n| Roas | Return on ad spend (RoA...","properties":{"adSpend":{"$ref":"#/components/schemas/Benchmark"},"attributedOrders":{"$ref":"#/components/schemas/Benchmark"},"brandedSearches":{"$ref":"#/components/schemas/Benchmark"},"budgetUtilization":{"$ref":"#/components/schemas/Benchmark"},"clickthroughRate":{"$ref":"#/components/schemas/Benchmark"},"costPerBrandedSearch":{"$ref":"#/components/schemas/Benchmark"},"costPerDetailPageView":{"$ref":"#/components/schemas/Benchmark"},"detailPageViews":{"$ref":"#/components/schemas/Benchmark"},"impressions":{"$ref":"#/components/schemas/Benchmark"},"roas":{"$ref":"#/components/schemas/Benchmark"}},"type":"object"},"BiddingStrategy":{"description":"Campaign bidding strategy.","enum":["AUTO_FOR_SALES","LEGACY_FOR_SALES","MANUAL","RULE_BASED"],"type":"string"},"BudgetRecommendation":{"description":"Budget recommendation of the campaign to which this recommendation is associated.","properties":{"sevenDaysMissedOpportunities":{"$ref":"#/components/schemas/SevenDaysMissedOpportunities"}},"required":["sevenDaysMissedOpportunities"],"type":"object"},"BudgetRule":{"description":"Budget rule of the campaign to which this recommendation is associated.","properties":{"ruleDetails":{"$ref":"#/components/schemas/BudgetRuleDetails"},"ruleId":{"description":"Identifier of the budget rule.","type":"string"}},"required":["ruleDetails"],"type":"object"},"BudgetRuleDateRangeTypeDuration":{"properties":{"endDate":{"description":"End date of the budget rule in YYYY-MM-DD format. The end date is inclusive.","format":"date","type":"string"},"startDate":{"description":"Start date of the budget rule in YYYY-MM-DD format. The start date is inclusive.","format":"date","type":"string"}},"required":["startDate"],"type":"object"},"BudgetRuleDetails":{"properties":{"budgetIncreaseBy":{"$ref":"#/components/schemas/BudgetRuleIncreaseBy"},"duration":{"$ref":"#/components/schemas/BudgetRuleDuration"},"performanceMeasureCondition":{"$ref":"#/components/schemas/BudgetRulePerformanceMeasureCondition"},"ruleName":{"description":"Name of the budget rule.","type":"string"},"ruleType":{"description":"Type of budget rule.","type":"string"}},"type":"object"},"BudgetRuleDuration":{"properties":{"dateRangeTypeDuration":{"$ref":"#/components/schemas/BudgetRuleDateRangeTypeDuration"},"eventTypeDuration":{"$ref":"#/components/schemas/BudgetRuleEventTypeDuration"}},"type":"object"},"BudgetRuleEventTypeDuration":{"properties":{"endDate":{"description":"End date of the event in YYYY-MM-DD format.","format":"date","type":"string"},"eventId":{"description":"Identifier of the event.","type":"string"},"startDate":{"description":"Start date of the event in YYYY-MM-DD format. Note that this field is present only for announced events.","format":"date","type":"string"}},"required":["eventId"],"type":"object"},"BudgetRuleIncreaseBy":{"properties":{"value":{"description":"Budget of the rule.","type":"number"}},"required":["value"],"type":"object"},"BudgetRulePerformanceMeasureCondition":{"properties":{"threshold":{"description":"Threshold of the performance metric.","type":"number"}},"required":["threshold"],"type":"object"},"CampaignEstimatedImpact":{"description":"Estimated impact at the campaign level.","properties":{"clicks":{"$ref":"#/components/schemas/EstimatedImpactClicks"},"cohortTopOfSearchImpressionShare":{"$ref":"#/components/schemas/EstimatedImpactCohortTopOfSearchImpressionShare"},"cost":{"$ref":"#/components/schemas/EstimatedImpactCost"},"impressions":{"$ref":"#/components/schemas/EstimatedImpactImpressions"},"incrementalSalesIncrementalCostRatio":{"$ref":"#/components/schemas/EstimatedImpactIncrementalSalesIncrementalCostRatio"},"opportunityLostPurchaseJourney":{"$ref":"#/components/schemas/EstimatedImpactOpportunityLostPurchaseJourney"},"opportunityLostToCompetitors":{"$ref":"#/components/schemas/EstimatedImpactOpportunityLostToCompetitors"},"opportunityLostToCompetitorsPercentage":{"$ref":"#/components/schemas/EstimatedImpactOpportunityLostToCompetitorsPercentage"},"opportunityLostToCompetitorsSales":{"$ref":"#/components/schemas/EstimatedImpactOpportunityLostToCompetitorsSales"},"roas":{"$ref":"#/components/schemas/EstimatedImpactRoas"},"sales":{"$ref":"#/components/schemas/EstimatedImpactSales"},"timePeriodInDays":{"description":"Time period of the estimated impact in days.","type":"integer"},"topOfSearchImpressionShare":{"$ref":"#/components/schemas/EstimatedImpactTopOfSearchImpressionShare"}},"required":["timePeriodInDays"],"type":"object"},"ConsolidatedRecommendation":{"description":"Data for a group of recommendations.","properties":{"recommendationReasons":{"$ref":"#/components/schemas/RecommendationReasons"},"sevenDaysEstimatedOpportunities":{"$ref":"#/components/schemas/SevenDaysEstimatedOpportunities"}},"type":"object"},"DiagnosticContext":{"description":"Underlying diagnostic context behind generating the recommendation.","properties":{"asinAge":{"description":"The number of days since the ASIN was added to the advertiser’s catalog.","type":"number"},"benchmarkContext":{"$ref":"#/components/schemas/BenchmarkContext"},"diagnosticDate":{"description":"The date on which the campaign was diagnosed.","format":"date","type":"string"},"summary":{"$ref":"#/components/schemas/Summary"}},"type":"object"},"EstimatedImpact":{"description":"Estimated impact of the recommendation.","properties":{"campaign":{"$ref":"#/components/schemas/CampaignEstimatedImpact"}},"type":"object"},"EstimatedImpactClicks":{"description":"Estimated impact of the recommendation on clicks.","properties":{"forecastedCurrentLowerBound":{"description":"Lower bound of the forecasted number of clicks for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedCurrentUpperBound":{"description":"Upper bound of the forecasted number of clicks for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedLowerBound":{"description":"Lower bound of the forecasted number of clicks for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedUpperBound":{"description":"Upper bound of the forecasted number of clicks for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"incrementalLowerBound":{"description":"Lower bound of the estimated change in clicks seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in clicks seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"type":"object"},"EstimatedImpactCohortTopOfSearchImpressionShare":{"description":"Estimated impact of the recommendation on brand cohort top of search impression share.","properties":{"incrementalLowerBound":{"description":"Upper bound of the estimated change in cohort top of search impression share when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in cohort top of search impression share when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactCost":{"description":"Estimated impact of the recommendation on cost.","properties":{"forecastedCurrentLowerBound":{"description":"Lower bound of the forecasted cost for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedCurrentUpperBound":{"description":"Upper bound of the forecasted cost for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedLowerBound":{"description":"Lower bound of the forecasted cost for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedUpperBound":{"description":"Upper bound of the forecasted cost for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"incrementalLowerBound":{"description":"Lower bound of the estimated change in cost seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in cost seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"type":"object"},"EstimatedImpactImpressions":{"description":"Estimated impact of the recommendation on impressions.","properties":{"forecastedCurrentLowerBound":{"description":"Lower bound of the forecasted number of impressions for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedCurrentUpperBound":{"description":"Upper bound of the forecasted number of impressions for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedLowerBound":{"description":"Lower bound of the forecasted number of impressions for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedUpperBound":{"description":"Upper bound of the forecasted number of impressions for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"incrementalLowerBound":{"description":"Lower bound of the estimated change in impressions seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in impressions seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"type":"object"},"EstimatedImpactIncrementalSalesIncrementalCostRatio":{"description":"Estimated impact of the recommendation on incremental sales and incremental cost ratio.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in incremental sales to incremental cost ratio seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in incremental sales to incremental cost ratio seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactOpportunityLostPurchaseJourney":{"description":"Estimated impact of the recommendation on lost purchase journey opportunities.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in customers with no further engagement with brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in customers with no further engagement with brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactOpportunityLostToCompetitors":{"description":"Estimated impact of the recommendation on opportunity lost to competitors.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in customers who purchased from another category brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in customers who purchased from another category brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactOpportunityLostToCompetitorsPercentage":{"description":"Estimated impact of the recommendation on percentage of opportunity lost to competitors.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in percentage of customers who purchased from another category brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in percentage of customers who purchased from another category brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactOpportunityLostToCompetitorsSales":{"description":"Estimated impact of the recommendation on opportunity of sales lost to competitors.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in competitor revenue generated from customers purchasing from competing brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in competitor revenue generated from customers purchasing from competing brand when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"EstimatedImpactRoas":{"description":"Estimated impact of the recommendation on ROAS.","properties":{"forecastedCurrentLowerBound":{"description":"Lower bound of the forecasted ROAS for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedCurrentUpperBound":{"description":"Upper bound of the forecasted ROAS for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedLowerBound":{"description":"Lower bound of the forecasted ROAS for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedUpperBound":{"description":"Upper bound of the forecasted ROAS for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"incrementalLowerBound":{"description":"Lower bound of the estimated change in ROAS seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in ROAS seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"type":"object"},"EstimatedImpactSales":{"description":"Estimated impact of the recommendation on sales.","properties":{"forecastedCurrentLowerBound":{"description":"Lower bound of the forecasted sales for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedCurrentUpperBound":{"description":"Upper bound of the forecasted sales for the campaign, based on the current campaign settings and data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedLowerBound":{"description":"Lower bound of the forecasted sales for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"forecastedRecommendedUpperBound":{"description":"Upper bound of the forecasted sales for the campaign, if the recommendation is adopted, based on data from similar advertisers during the specified time period.","type":"number"},"incrementalLowerBound":{"description":"Lower bound of the estimated change in sales seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in sales seen for similar advertisers within the time period indicated when the recommendation is adopted.","type":"number"}},"type":"object"},"EstimatedImpactTopOfSearchImpressionShare":{"description":"Estimated impact of the recommendation on top of search impression share.","properties":{"incrementalLowerBound":{"description":"Lower bound of the estimated change in top of search impression share when the create grow brand impression share campaign recommendation is adopted.","type":"number"},"incrementalUpperBound":{"description":"Upper bound of the estimated change in top of search impression share when the create grow brand impression share campaign recommendation is adopted.","type":"number"}},"required":["incrementalLowerBound","incrementalUpperBound"],"type":"object"},"FilterField":{"description":"Field to filter by.","enum":["AD_PRODUCT","CAMPAIGN_ID","GROUPING_TYPE","RECOMMENDATION_ID","RECOMMENDATION_TYPE","STATUS"],"type":"string"},"FilterOperator":{"description":"Operator to filter field by.","enum":["EXACT"],"type":"string"},"GroupingType":{"description":"Type of grouping for consolidated recommendation data. \n | Type of grouping | Description |\n|---|---|\n| CAMPAIGN_INCREASE_CLICKS | Recommendation grouping type for generating additional clicks for cam...","enum":["ADD_TARGETS_CONTEXTUAL","CAMPAIGN_INCREASE_CLICKS","DECREASE_BID_CONTEXTUAL","INCREASE_BID_CONTEXTUAL","INCREASE_BUDGET_CONTEXTUAL","INCREASE_CLICKTHROUGH_RATE","INCREASE_CONVERSION_RATE","IN_SEASON_ASIN","NEW_ASIN","NEW_CAMPAIGN_ATTRIBUTED_ORDERS","NEW_CAMPAIGN_CLICKS","NEW_CAMPAIGN_GROW_BIS_IMAGE_GENERAL","NEW_CAMPAIGN_GROW_BIS_IMAGE_SPECIFIC","NEW_CAMPAIGN_GROW_BRAND_IMPRESSION_SHARE","NEW_CAMPAIGN_NEW_TO_BRAND_ORDERS","NEW_CAMPAIGN_PRE_COMPUTED_RECOMMENDATION_BUNDLE","OPTIMIZE_ATTRIBUTED_ORDERS","OPTIMIZE_BRANDED_SEARCHES","OPTIMIZE_CLICKS","OPTIMIZE_COST_PER_BRANDED_SEARCH","OPTIMIZE_COST_PER_CLICK","OPTIMIZE_COST_PER_DETAIL_PAGE_VIEW","OPTIMIZE_COST_PER_NEW_TO_BRAND_ORDERS","OPTIMIZE_DETAIL_PAGE_VIEWS","OPTIMIZE_NEW_TO_BRAND_ORDERS","OPTIMIZE_ROAS","UNDERPERFORMING_CAMPAIGN_INCREASE_CLICKS"],"type":"string"},"KeywordSortingDimension":{"description":"Sorting dimension for new keyword recommendations.","enum":["CLICK","CONVERSION"],"type":"string"},"ListRecommendationsFilter":{"properties":{"field":{"$ref":"#/components/schemas/FilterField"},"include":{"default":true,"description":"Flag to specify if the filter should be included or excluded.","type":"boolean"},"operator":{"$ref":"#/components/schemas/FilterOperator"},"values":{"items":{"description":"| Field | Data type |\n|---|---|\n| RECOMMENDATION_ID | string |\n| AD_PRODUCT | One of [ SP, SB, SD, ST ] |\n| RECOMMENDATION_TYPE | One of [ NEW_CAMPAIGN, NEW_VIDEO_CAMPAIGN, NEW_AD_GROUP, CAMPAIGN_BIDD...","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["field","operator","values"],"type":"object"},"ListRecommendationsRequest":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ListRecommendationsFilter"},"maxItems":10,"minItems":1,"type":"array"},"locale":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"description":"This will control the language of preference returned for the summary field."},"maxResults":{"default":500,"maximum":500,"minimum":1,"type":"integer"},"nextToken":{"description":"Token to retrieve the next page of results.","type":"string"}},"type":"object"},"ListRecommendationsResponse":{"properties":{"nextToken":{"description":"Token to retrieve the next page of results.","type":"string"},"recommendations":{"items":{"$ref":"#/components/schemas/Recommendation","properties":{}},"maxItems":500,"minItems":0,"type":"array"},"totalResults":{"description":"Total number of results.","type":"integer"}},"required":["recommendations","totalResults"],"type":"object"},"Locale":{"description":"Eligible language codes.","enum":["ar_AE","cs_CZ","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_CO","es_ES","es_MX","es_US","fr_CA","fr_FR","he_IL","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","zh_TW"],"type":"string"},"PublishMetadata":{"description":"Metadata for publishing the recommendation.","properties":{"publishedBy":{"$ref":"#/components/schemas/PublishedBy"},"publishedToAmazonAdConsole":{"description":"Indicates if recommendation was published to Amazon Ad Console.","type":"boolean"}},"required":["publishedBy","publishedToAmazonAdConsole"],"type":"object"},"PublishedBy":{"description":"Publisher of the recommendation.","enum":["AMAZON_ADS_ACCOUNT_TEAM"],"type":"string"},"Recommendation":{"properties":{"adGroupId":{"description":"Identifier of the ad group to which this recommendation is associated.","type":"string"},"adId":{"description":"Identifier of the product ad to which this recommendation is associated.","type":"string"},"adProduct":{"$ref":"#/components/schemas/AdProduct"},"applyFailureReason":{"description":"A human-readable description of why the recommendation failed to apply.","type":"string"},"asin":{"description":"ASIN associated with the product. Defined for vendors only.","type":"string"},"asinGroupTemplateId":{"description":"Identifier of the asin group template to which this recommendation is associated.","type":"string"},"budgetRecommendation":{"$ref":"#/components/schemas/BudgetRecommendation"},"budgetRule":{"$ref":"#/components/schemas/BudgetRule"},"campaignId":{"description":"Identifier of the campaign to which this recommendation is associated.","type":"string"},"campaignTemplateId":{"description":"Identifier of the campaign template to which this recommendation is associated.","type":"string"},"consolidatedRecommendation":{"$ref":"#/components/schemas/ConsolidatedRecommendation"},"currentValue":{"description":"Current value of the campaign entity to which this recommendation is associated. Will be null if the recommendation is for a new campaign entity.","type":"string"},"estimatedImpact":{"$ref":"#/components/schemas/EstimatedImpact"},"groupingType":{"$ref":"#/components/schemas/GroupingType"},"keywordSortingDimension":{"$ref":"#/components/schemas/KeywordSortingDimension"},"keywordSortingRank":{"description":"Sorting rank for new keyword recommendations.","type":"integer"},"publishMetadata":{"$ref":"#/components/schemas/PublishMetadata"},"recommendationContext":{"$ref":"#/components/schemas/RecommendationContext"},"recommendationId":{"description":"Recommendation identifier.","type":"string"},"recommendationType":{"$ref":"#/components/schemas/RecommendationType"},"recommendedValue":{"description":"Recommended value of the campaign entity to which this recommendation is associated.","type":"string"},"resolvedTargeting":{"description":"Resolved targeting expression to which this recommendation is associated.","type":"string"},"ruleBasedBidding":{"$ref":"#/components/schemas/RuleBasedBidding"},"sku":{"description":"SKU associated with the product. Defined for seller accounts only.","type":"string"},"status":{"$ref":"#/components/schemas/RecommendationStatus"},"targetId":{"description":"Identifier of the target to which this recommendation is associated.","type":"string"},"targeting":{"description":"Targeting expression to which this recommendation is associated.","type":"string"},"targetingMatchType":{"$ref":"#/components/schemas/TargetingMatchType"}},"required":["adProduct","recommendationId","recommendationType","status"],"type":"object"},"RecommendationContext":{"description":"Context of the recommendation.","properties":{"asinContext":{"$ref":"#/components/schemas/AsinContext"},"diagnosticContext":{"$ref":"#/components/schemas/DiagnosticContext"}},"type":"object"},"RecommendationReason":{"description":"Type of reason why the recommendation was created. \n | Type of reason | Description |\n|---|---|\n| AT_NOT_ALL_MATCH_TYPE_ENABLED | Auto targeting campaign does not have all match types enabled |\n| AT_B...","enum":["AT_BID_FALLBACK","AT_NOT_ALL_MATCH_TYPE_ENABLED","MT_BID_FALLBACK","MT_IRRELEVANT_KEYWORD_IMPRESSIONS","MT_KEYWORDS_HAVE_LOW_IMPRESSIONS","MT_KEYWORD_FALLBACK","MT_NOT_ENOUGH_TOP_IMPRESSIONS"],"type":"string"},"RecommendationReasons":{"description":"List of reasons why the recommendation was created","items":{"$ref":"#/components/schemas/RecommendationReason"},"maxItems":100,"minItems":0,"type":"array"},"RecommendationStatus":{"description":"Status of the recommendation.","enum":["APPLY_FAILED","APPLY_IN_PROGRESS","APPLY_SUCCESS","PUBLISHED","REJECTED"],"type":"string"},"RecommendationType":{"description":"Type of recommendation to apply certain changes to the advertiser's sponsored ads.","enum":["AD_GROUP_BID_OPTIMIZATION","AD_GROUP_DEFAULT_BID","AD_GROUP_STATE","AUDIENCE_TARGETING_BID","AUDIENCE_TARGETING_STATE","CAMPAIGN_BIDDING_RULE","CAMPAIGN_BIDDING_STRATEGY","CAMPAIGN_BUDGET","CAMPAIGN_BUDGET_RULE","CAMPAIGN_END_DATE","CAMPAIGN_PRODUCT_PLACEMENT","CAMPAIGN_STATE","CAMPAIGN_TOP_PLACEMENT","KEYWORD_BID","KEYWORD_STATE","NEGATIVE_AUDIENCE_TARGETING_STATE","NEGATIVE_KEYWORD_STATE","NEGATIVE_PRODUCT_TARGETING_STATE","NEW_AD_GROUP","NEW_AUDIENCE_TARGETING","NEW_CAMPAIGN","NEW_CAMPAIGN_BIDDING_RULE","NEW_CAMPAIGN_BUDGET_RULE","NEW_KEYWORD","NEW_NEGATIVE_AUDIENCE_TARGETING","NEW_NEGATIVE_KEYWORD","NEW_NEGATIVE_PRODUCT_TARGETING","NEW_PRODUCT_AD","NEW_PRODUCT_TARGETING","NEW_VIDEO_CAMPAIGN","PRODUCT_AD_STATE","PRODUCT_TARGETING_BID","PRODUCT_TARGETING_STATE"],"type":"string"},"RuleBasedBidding":{"description":"Rule based bidding for the campaign to which this recommendation is associated.","properties":{"campaignOptimizationId":{"description":"Identifier of the campaign optimization.","type":"string"},"currentBiddingStrategy":{"$ref":"#/components/schemas/BiddingStrategy"},"currentRuleRoas":{"description":"Current threshold of the RoAS performance metric.","type":"number"},"recommendedBiddingStrategy":{"$ref":"#/components/schemas/BiddingStrategy"},"recommendedRuleRoas":{"description":"Recommended threshold of the RoAS performance metric.","type":"number"}},"required":["recommendedBiddingStrategy","recommendedRuleRoas"],"type":"object"},"SevenDaysEstimatedOpportunities":{"description":"Seven days of estimated opportunities.","properties":{"endDate":{"description":"End date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","format":"date-time","type":"string"},"estimatedIncrementalClicksLower":{"description":"Lower bound of estimated incremental clicks that could be gained if all recommendations are applied.","type":"integer"},"estimatedIncrementalClicksUpper":{"description":"Upper bound of estimated incremental clicks that could be gained if all recommendations are applied.","type":"integer"},"startDate":{"description":"Start date of the opportunities date range in YYYY-MM-DDTHH:mm:ssZ format.","format":"date-time","type":"string"}},"required":["endDate","startDate"],"type":"object"},"SevenDaysMissedOpportunities":{"description":"Seven days of missed opportunities.","properties":{"endDate":{"description":"End date of the date range in local time and YYYY-MM-DD format for which missed opportunity metrics are provided.","format":"date","type":"string"},"estimatedMissedClicksLower":{"description":"Lower bound of estimated missed clicks.","type":"integer"},"estimatedMissedClicksUpper":{"description":"Upper bound of estimated missed clicks.","type":"integer"},"estimatedMissedImpressionsLower":{"description":"Lower bound of estimated missed impressions.","type":"integer"},"estimatedMissedImpressionsUpper":{"description":"Upper bound of estimated missed impressions.","type":"integer"},"estimatedMissedSalesLower":{"description":"Lower bound of estimated missed sales. Provided in local currency.","type":"number"},"estimatedMissedSalesUpper":{"description":"Upper bound of estimated missed sales. Provided in local currency.","type":"number"},"percentTimeInBudget":{"description":"Percentage of time the campaign is active with a budget.","type":"number"},"startDate":{"description":"Start date of the date range in local time and YYYY-MM-DD format for which missed opportunity metrics are provided. ","format":"date","type":"string"}},"type":"object"},"Summary":{"description":"An explanation of the campaign performance vis-a-vis relevant benchmarks, and why the recommendation was generated.","properties":{"code":{"description":"Summary Codes. \n | Code | Message |\n|---|---|\n| DECREASE_BID_CONTEXTUAL_SUMMARY | You have Sponsored Products campaigns with high impressions but low clickthrough rate, compared to similar campaigns.","enum":["ADD_TARGETS_CONTEXTUAL_SUMMARY","DECREASE_BID_CONTEXTUAL_SUMMARY","INCREASE_BID_CONTEXTUAL_SUMMARY","INCREASE_BUDGET_CONTEXTUAL_SUMMARY"],"type":"string"},"message":{"description":"A localized description of the summary.","type":"string"}},"type":"object"},"TargetingMatchType":{"description":"Match type of the target for keyword and targeting recommendations.","enum":["BROAD","EXACT","GROUP","NEGATIVE_BROAD","NEGATIVE_EXACT","NEGATIVE_PHRASE","PHRASE","TARGETING_EXPRESSION","TARGETING_EXPRESSION_PREDEFINED","THEME"],"type":"string"},"UpdateBudgetRule":{"description":"Can only be updated for recommendations with recommendationType NEW_CAMPAIGN_BUDGET_RULE or CAMPAIGN_BUDGET_RULE.","properties":{"ruleDetails":{"$ref":"#/components/schemas/UpdateBudgetRuleDetails"}},"required":["ruleDetails"],"type":"object"},"UpdateBudgetRuleDetails":{"properties":{"budgetIncreaseBy":{"$ref":"#/components/schemas/BudgetRuleIncreaseBy"},"duration":{"$ref":"#/components/schemas/UpdateBudgetRuleDuration"},"performanceMeasureCondition":{"$ref":"#/components/schemas/BudgetRulePerformanceMeasureCondition"},"ruleName":{"description":"Name of the budget rule. Required to be unique within a campaign.","maxLength":355,"minLength":1,"type":"string"}},"type":"object"},"UpdateBudgetRuleDuration":{"properties":{"dateRangeTypeDuration":{"$ref":"#/components/schemas/UpdateBudgetRuleDurationDateRange"}},"type":"object"},"UpdateBudgetRuleDurationDateRange":{"properties":{"endDate":{"description":"End date of the budget rule in YYYY-MM-DD format. The end date is inclusive.","format":"date","type":"string"}},"type":"object"},"UpdateRecommendationRequest":{"properties":{"budgetRule":{"$ref":"#/components/schemas/UpdateBudgetRule"},"recommendedValue":{"description":"Recommended value of the recommendation. Type of data expected for each recommendation type:\n| Recommendation type | Data type |\n|---|---|\n| CAMPAIGN_BUDGET, CAMPAIGN_TOP_PLACEMENT, CAMPAIGN_PRODUCT_P...","type":"string"},"ruleBasedBidding":{"$ref":"#/components/schemas/UpdateRuleBasedBidding"}},"required":["recommendationId"],"type":"object"},"UpdateRuleBasedBidding":{"description":"Can only be updated for recommendations with recommendationType NEW_CAMPAIGN_BIDDING_RULE or CAMPAIGN_BIDDING_RULE.","properties":{"recommendedRuleRoas":{"type":"number"}},"required":["recommendedRuleRoas"],"type":"object"}},"securitySchemes":{}},"info":{"title":"Recommendations","version":"3.0"},"openapi":"3.0.1","paths":{"/recommendations/apply":{"post":{"description":"Applies one or more recommendations.\n\nWhen applying recommendations with recommendationType NEW_CAMPAIGN or NEW_VIDEO_CAMPAIGN, this will return HTTP status code ACCEPTED to indicate that it has been...","operationId":"ApplyRecommendations","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":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.applyRecommendationsRequest.v1+json":{"schema":{"$ref":"#/components/schemas/ApplyRecommendationsRequest"}}},"required":true},"responses":{"207":{"content":{"application/vnd.applyRecommendationsResponse.v1+json":{"schema":{"$ref":"#/components/schemas/ApplyRecommendationsResponse"}}},"description":"Multi-status."},"400":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request."},"429":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests - Request was denied due to request throttling. Please try again later."},"500":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Internal server error - Something went wrong on the server."}},"summary":"Applies one or more recommendations.","tags":["Recommendations"]}},"/recommendations/list":{"post":{"description":"Retrieves a paginated list of recommendations with optional filtering.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"ListRecommendations","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. account.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.listRecommendationsRequest.v1+json":{"schema":{"$ref":"#/components/schemas/ListRecommendationsRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.listRecommendationsResponse.v1+json":{"schema":{"$ref":"#/components/schemas/ListRecommendationsResponse"}}},"description":"Success."},"400":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request."},"429":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests - Request was denied due to request throttling. Please try again later."},"500":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Internal server error - Something went wrong on the server."}},"summary":"Retrieves a list of recommendations.","tags":["Recommendations"]}},"/recommendations/{recommendationId}":{"put":{"description":"Updates a recommendation.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser 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":"UpdateRecommendation","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. account.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}},{"description":"The identifier of the recommendation.","in":"path","name":"recommendationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.updateRecommendationRequest.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateRecommendationRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.recommendation.v1+json":{"schema":{"$ref":"#/components/schemas/Recommendation"}}},"description":"Success."},"400":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request."},"404":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Bad request - Requested resource was not found."},"429":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Too many requests - Request was denied due to request throttling. Please try again later."},"500":{"content":{"application/vnd.recommendationApiError.v1+json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Internal server error - Something went wrong on the server."}},"summary":"Updates a recommendation.","tags":["Recommendations"]}}}}