Amazon Ads API MCP

{"components":{"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a 'Login with Amazon' account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ManagerAccountIdHeader":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}}},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"DSPBudget":{"properties":{"budgetValue":{"$ref":"#/components/schemas/DSPBudgetValue"}},"required":["budgetValue"],"type":"object"},"DSPBudgetValue":{"oneOf":[{"properties":{"monetaryBudgetValue":{"$ref":"#/components/schemas/DSPMonetaryBudgetValue"}},"required":["monetaryBudgetValue"],"type":"object"}]},"DSPCampaignForecast":{"properties":{"availableForecastFlights":{"description":"The combination of existing flight settings and proposed flight settings based on forecasting.","items":{"$ref":"#/components/schemas/DSPForecastFlight","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"campaignForecastDescription":{"$ref":"#/components/schemas/DSPCampaignForecastDescription"},"creationDateTime":{"description":"The creation date of the campaign forecast.","format":"date-time","type":"string"},"flightForecasts":{"description":"The forecast results of multiple flights of the campaign.","items":{"$ref":"#/components/schemas/DSPFlightForecast","properties":{}},"maxItems":5,"minItems":0,"type":"array"}},"required":["campaignForecastDescription","creationDateTime"],"type":"object"},"DSPCampaignForecastDescription":{"description":"The description of which campaign and what features are enabled for a forecast.","properties":{"campaignId":{"description":"The unique identifier of the campaign the ad group belongs to.","type":"string"},"enabledFeatures":{"$ref":"#/components/schemas/DSPEnabledFeaturesInCampaignForecast"},"flightIds":{"description":"The unique identifier of the flight.","items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"replanningSettings":{"$ref":"#/components/schemas/DSPReplanningSettings"}},"required":["campaignId"],"type":"object"},"DSPCampaignForecastMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/DSPCampaignForecastMultiStatusSuccess","properties":{}},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"DSPCampaignForecastMultiStatusSuccess":{"properties":{"campaignForecast":{"$ref":"#/components/schemas/DSPCampaignForecast"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["campaignForecast","index"],"type":"object"},"DSPCurrencyCode":{"description":"| CurrencyCode | Description |\n| --- | --- |\n| `AED` | |\n| `AUD` | |\n| `BRL` | |\n| `CAD` | |\n| `CHF` | |\n| `CNY` | |\n| `DKK` | |\n| `EGP` | |\n| `EUR` | |\n| `GBP` | |\n| `INR` | |\n| `JPY` | |...","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","PLN","NZD","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"DSPCurve":{"description":"The forecast curve of Bid/Spend vs the metric type based on periodicity.","properties":{"focusPoint":{"items":{"$ref":"#/components/schemas/DSPPoint","properties":{}},"maxItems":10,"minItems":0,"type":"array"},"periodicity":{"$ref":"#/components/schemas/DSPForecastPeriodicity"},"points":{"items":{"$ref":"#/components/schemas/DSPPoint","properties":{}},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"DSPDeliverInFullConfidence":{"description":"Description of how confident we delivery 100% of the ads for the specific metric.","properties":{"value":{"$ref":"#/components/schemas/DSPDeliverInFullConfidenceLevel"}},"required":["value"],"type":"object"},"DSPDeliverInFullConfidenceLevel":{"description":"| DeliverInFullConfidenceLevel | Description |\n| --- | --- |\n| `HIGH` | There is a high level of confidence that the campaign or flight will fully deliver its planned budget or impressions.","enum":["HIGH","MEDIUM","LOW","UNAVAILABLE"],"type":"string"},"DSPEnabledFeaturesInCampaignForecast":{"description":"For the user to specify which features to enable in the forecast result.","properties":{"campaignSettingsCache":{"description":"Describe if the forecast will use cached settings of a campaign.","type":"boolean"},"curve":{"description":"Describe if the user want to see curve or not.","type":"boolean"},"metrics":{"$ref":"#/components/schemas/DSPForecastMetricsDescription"},"replanning":{"description":"Describe if the forecast will show replanning recommendation.","type":"boolean"}},"type":"object"},"DSPFlightForecast":{"description":"The forecast result of a specific flight.","properties":{"curves":{"description":"The forecasting curves of a flight based on different periodicities.","items":{"$ref":"#/components/schemas/DSPCurve","properties":{}},"maxItems":4,"minItems":0,"type":"array"},"deliverInFullConfidence":{"$ref":"#/components/schemas/DSPDeliverInFullConfidence"},"flightId":{"description":"The flightId of the flight.","type":"string"},"forecastEndDateTime":{"description":"The endtime of the flight for forecasting.","format":"date-time","type":"string"},"forecastStartDateTime":{"description":"The starttime of the flight for forecasting.","format":"date-time","type":"string"},"metrics":{"description":"The different metrics to measure the performance of the flight.","items":{"$ref":"#/components/schemas/DSPForecastMetric","properties":{}},"maxItems":20,"minItems":0,"type":"array"},"replanning":{"description":"The recommendation for replanning.","items":{"$ref":"#/components/schemas/DSPReplanning","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"spend":{"description":"The amount of money spend for this flight.","format":"double","type":"number"},"totalBudget":{"$ref":"#/components/schemas/DSPMonetaryBudget"},"warnings":{"description":"Warnings of the campaign forecast.","items":{"$ref":"#/components/schemas/DSPWarning","properties":{}},"maxItems":10,"minItems":0,"type":"array"}},"required":["flightId","forecastEndDateTime","forecastStartDateTime"],"type":"object"},"DSPForecastFlight":{"properties":{"budget":{"$ref":"#/components/schemas/DSPBudget"},"endDateTime":{"format":"date-time","type":"string"},"flightId":{"description":"The ID associated with the flight.","type":"string"},"startDateTime":{"description":"The start date of the flight.","format":"date-time","type":"string"}},"required":["budget","endDateTime","startDateTime"],"type":"object"},"DSPForecastMetric":{"description":"The forecast based on metric and periodicity.","properties":{"metric":{"$ref":"#/components/schemas/DSPSelectedForecastMetric"},"periodicity":{"$ref":"#/components/schemas/DSPForecastPeriodicity"},"value":{"$ref":"#/components/schemas/DSPForecastValue"}},"required":["metric","value"],"type":"object"},"DSPForecastMetricsDescription":{"description":"Describe how user select to see all metrics or selected ones.","properties":{"allMetrics":{"description":"If it is true, all the supported metrics would return.","type":"boolean"},"selectedMetrics":{"description":"The list of selected metrics in order.","items":{"$ref":"#/components/schemas/DSPSelectedForecastMetric"},"maxItems":20,"minItems":0,"type":"array"}},"required":["allMetrics"],"type":"object"},"DSPForecastPeriodicity":{"description":"| ForecastPeriodicity | Description |\n| --- | --- |\n| `DAILY` | Forecast results are generated and presented for each individual day.","enum":["DAILY","LIFETIME","MONTHLY","WEEKLY"],"type":"string"},"DSPForecastValue":{"properties":{"high":{"format":"double","type":"number"},"low":{"format":"double","type":"number"},"mean":{"format":"double","type":"number"}},"required":["high","low","mean"],"type":"object"},"DSPMonetaryBudget":{"properties":{"currencyCode":{"$ref":"#/components/schemas/DSPCurrencyCode"},"value":{"description":"The monetary amount of the budget cap in the given currency.","format":"double","type":"number"}},"required":["currencyCode","value"],"type":"object"},"DSPMonetaryBudgetValue":{"properties":{"monetaryBudget":{"$ref":"#/components/schemas/DSPMonetaryBudget"}},"type":"object"},"DSPPoint":{"properties":{"pointType":{"type":"string"},"x":{"$ref":"#/components/schemas/DSPXPoint"},"y":{"items":{"$ref":"#/components/schemas/DSPYPoint","properties":{}},"maxItems":1000,"minItems":0,"type":"array"}},"required":["x"],"type":"object"},"DSPPointLabel":{"description":"| PointLabel | Description |\n| --- | --- |\n| `SPEND` | Spend in monetary value. |\n| `BID` | Bid in monetary value. |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend.","enum":["SPEND","BID","DC","TAS","AIMP","AREA","EIMP","EREA","CPC","CPA","CPM","ROAS","CAS"],"type":"string"},"DSPReplanning":{"description":"Recommendation for replanning.","properties":{"content":{"type":"string"},"curves":{"items":{"$ref":"#/components/schemas/DSPCurve","properties":{}},"maxItems":4,"minItems":0,"type":"array"},"deliverInFullConfidence":{"$ref":"#/components/schemas/DSPDeliverInFullConfidence"},"metrics":{"items":{"$ref":"#/components/schemas/DSPForecastMetric","properties":{}},"maxItems":20,"minItems":0,"type":"array"},"scenarioFlight":{"$ref":"#/components/schemas/DSPForecastFlight"},"scenarioType":{"type":"string"},"selectedMetrics":{"description":"| SelectedForecastMetric | Description |\n| --- | --- |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend. |\n| `AIMP` | Available impressions. |\n| `AREA` | Available reach.","items":{"$ref":"#/components/schemas/DSPSelectedForecastMetric","properties":{}},"maxItems":20,"minItems":0,"type":"array"},"title":{"type":"string"}},"required":["content","title"],"type":"object"},"DSPReplanningSettings":{"description":"Forecast request of a flight with adjusted settings.","properties":{"flights":{"items":{"$ref":"#/components/schemas/DSPForecastFlight"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"DSPRetrieveCampaignForecastRequest":{"properties":{"campaignForecastDescriptions":{"items":{"$ref":"#/components/schemas/DSPCampaignForecastDescription"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"DSPSelectedForecastMetric":{"description":"| SelectedForecastMetric | Description |\n| --- | --- |\n| `DC` | Delivery confidence. |\n| `TAS` | Total available spend. |\n| `AIMP` | Available impressions. |\n| `AREA` | Available reach.","enum":["DC","TAS","AIMP","AREA","EIMP","EREA","CPC","CPA","CPM","ROAS","CAS","IREA"],"type":"string"},"DSPWarning":{"description":"The warning message of a forecast.","properties":{"adGroupIds":{"items":{"properties":{},"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"code":{"type":"string"},"message":{"type":"string"},"warningLevel":{"format":"int32","type":"integer"}},"required":["code","message"],"type":"object"},"DSPXPoint":{"description":"The label and value on X axis of the curve.","properties":{"label":{"$ref":"#/components/schemas/DSPPointLabel"},"value":{"format":"double","type":"number"}},"required":["label","value"],"type":"object"},"DSPYPoint":{"description":"The label and value on Y axis of the curve.","properties":{"label":{"$ref":"#/components/schemas/DSPPointLabel"},"value":{"$ref":"#/components/schemas/DSPForecastValue"}},"required":["label","value"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"| ErrorCode | Description |\n| --- | --- |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |","enum":["BAD_REQUEST"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error","properties":{}},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}}},"info":{"title":"AmazonAdsAPI - Forecasts (beta)","version":"v1"},"openapi":"3.0.2","paths":{"/adsApi/v1/retrieve/campaignForecasts/dsp":{"post":{"description":"A retrieve by ID read. More performant than query.","operationId":"DSPRetrieveCampaignForecast","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPRetrieveCampaignForecastRequest"}}}},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPCampaignForecastMultiStatusResponse"}}},"description":"DSPRetrieveCampaignForecast 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"tags":["Campaign Forecasts"]}}},"tags":[{"name":"Campaign Forecasts"}]}