{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeader":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Budget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/BudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"BudgetType":{"enum":["IMPRESSION"],"type":"string"},"BudgetValue":{"oneOf":[{"properties":{"impressionBudgetValue":{"$ref":"#/components/schemas/ImpressionBudgetValue"}},"required":["impressionBudgetValue"],"title":"impressionBudgetValue","type":"object"}]},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CreateBudget":{"properties":{"budgetType":{"$ref":"#/components/schemas/BudgetType"},"budgetValue":{"$ref":"#/components/schemas/CreateBudgetValue"},"recurrenceTimePeriod":{"$ref":"#/components/schemas/Recurrence"}},"required":["budgetType","budgetValue","recurrenceTimePeriod"],"type":"object"},"CreateBudgetValue":{"oneOf":[{"properties":{"impressionBudgetValue":{"$ref":"#/components/schemas/CreateImpressionBudgetValue"}},"required":["impressionBudgetValue"],"title":"impressionBudgetValue","type":"object"}]},"CreateImpressionBudgetValue":{"properties":{"impression":{"description":"The impression cap of the budget cap.","format":"double","type":"number"}},"required":["impression"],"type":"object"},"CreateLinearTvIncrementalReachForecastRequest":{"properties":{"linearTvIncrementalReachForecasts":{"items":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["linearTvIncrementalReachForecasts"],"type":"object"},"CreateLinearTvInventoryAllocation":{"description":"Linear TV Inventory Allocation","properties":{"grossRatingPoint":{"description":"Gross Rating Point (GRP) for the Linear TV inventory.","format":"double","type":"number"},"inventoryType":{"$ref":"#/components/schemas/LinearTvInventoryType"},"linearTvDaypartId":{"description":"A unique identifier of the daypart associated with the Linear TV inventory.","type":"string"}},"required":["grossRatingPoint","inventoryType","linearTvDaypartId"],"type":"object"},"CreateReachForecastBudgetAllocation":{"properties":{"budget":{"$ref":"#/components/schemas/CreateBudget"},"reachForecastId":{"description":"The identifier for the Reach Forecast.","type":"string"}},"required":["budget","reachForecastId"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |","enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":99,"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"},"ImpressionBudgetValue":{"properties":{"impression":{"description":"The impression cap of the budget cap.","format":"double","type":"number"}},"required":["impression"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"LinearTvIncrementalReachForecast":{"properties":{"creationDateTime":{"description":"The date time that the reach forecast was created.","type":"string"},"deduplicatedReachPercent":{"description":"Total combined reach percentage across both channels.","format":"double","type":"number"},"endDate":{"description":"The end date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"linearTvIncrementalReachForecastId":{"description":"A unique identifier for a Linear TV Incremental Reach Forecast.","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Incremental Reach Forecast.","items":{"$ref":"#/components/schemas/LinearTvInventoryAllocation"},"maxItems":20,"minItems":0,"type":"array"},"linearTvOnlyReachPercent":{"description":"Linear TV Incremental (unique) reach percentage.","format":"double","type":"number"},"linearTvReachPercentOverride":{"description":"Override of TV reach percentage. If not provided, the service will calculate TV reach based on internal estimation.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"overlapReachPercent":{"description":"Overlapped reach percentage between Streaming TV and Linear TV.","format":"double","type":"number"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"streamingTvBudgetAllocation":{"description":"Budget allocation for the list of Reach Forecast to be compared on top of Linear TV reach.","items":{"$ref":"#/components/schemas/ReachForecastBudgetAllocation"},"maxItems":100,"minItems":1,"type":"array"},"streamingTvExclusiveReachRate":{"description":"The percentage of streaming TV reach that wasn\u0027t exposed to a linear TV campaign. streamingTvOnlyReachPercent / (streamingTvOnlyReachPercent + overlapReachPercent) * 100%","format":"double","type":"number"},"streamingTvIncrementalReachRate":{"description":"The percentage of unique households/individuals that were reached on streaming TV inventory compared to linear TV. Households/individuals that are included in linear TV reach aren\u0027t counted in Streaming TV reach. streamingTvOnlyReachPercent / (linearTvOnlyReachPercent + overlapReachPercent) * 100%","format":"double","type":"number"},"streamingTvOnlyReachPercent":{"description":"Streaming TV Incremental (unique) reach percentage.","format":"double","type":"number"}},"required":["creationDateTime","deduplicatedReachPercent","endDate","linearTvIncrementalReachForecastId","linearTvOnlyReachPercent","marketplace","overlapReachPercent","reachUnit","startDate","streamingTvBudgetAllocation","streamingTvExclusiveReachRate","streamingTvIncrementalReachRate","streamingTvOnlyReachPercent"],"type":"object"},"LinearTvIncrementalReachForecastCreate":{"properties":{"endDate":{"description":"The end date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"linearTvInventoryAllocation":{"description":"Inventory allocation for the Linear TV Incremental Reach Forecast.","items":{"$ref":"#/components/schemas/CreateLinearTvInventoryAllocation"},"maxItems":20,"minItems":0,"type":"array"},"linearTvReachPercentOverride":{"description":"Override of TV reach percentage. If not provided, the service will calculate TV reach based on internal estimation.","format":"double","type":"number"},"marketplace":{"$ref":"#/components/schemas/Marketplace"},"reachUnit":{"$ref":"#/components/schemas/ReachUnit"},"startDate":{"description":"The start date of the Linear TV Incremental Reach Forecast.","format":"date","type":"string"},"streamingTvBudgetAllocation":{"description":"Budget allocation for the list of Reach Forecast to be compared on top of Linear TV reach.","items":{"$ref":"#/components/schemas/CreateReachForecastBudgetAllocation"},"maxItems":100,"minItems":1,"type":"array"}},"required":["endDate","marketplace","reachUnit","startDate","streamingTvBudgetAllocation"],"type":"object"},"LinearTvIncrementalReachForecastMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"LinearTvIncrementalReachForecastMultiStatusSuccess":{"properties":{"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"},"linearTvIncrementalReachForecast":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecast"}},"required":["index","linearTvIncrementalReachForecast"],"type":"object"},"LinearTvInventoryAllocation":{"description":"Linear TV Inventory Allocation","properties":{"grossRatingPoint":{"description":"Gross Rating Point (GRP) for the Linear TV inventory.","format":"double","type":"number"},"inventoryType":{"$ref":"#/components/schemas/LinearTvInventoryType"},"linearTvDaypartId":{"description":"A unique identifier of the daypart associated with the Linear TV inventory.","type":"string"}},"required":["grossRatingPoint","inventoryType","linearTvDaypartId"],"type":"object"},"LinearTvInventoryType":{"description":"**LinearTvInventoryType Enum:**\n| LinearTvInventoryType | Description |\n| --- | --- |\n| `BROADCAST` | Inventory on broadcast TV Network. |\n| `CABLE` | Inventory on cable TV Network. |\n| `SYNDICATION` | Inventory within syndicated television programs. |","enum":["BROADCAST","CABLE","SYNDICATION"],"type":"string"},"Marketplace":{"description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BR","CA","DE","ES","FR","GB","IN","IT","JP","MX","NL","SA","SE","TR","US"],"type":"string"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ReachForecastBudgetAllocation":{"properties":{"budget":{"$ref":"#/components/schemas/Budget"},"reachForecastId":{"description":"The identifier for the Reach Forecast.","type":"string"}},"required":["budget","reachForecastId"],"type":"object"},"ReachUnit":{"description":"The unit of reach numbers.\n**ReachUnit Enum:**\n| ReachUnit | Description |\n| --- | --- |\n| `HOUSEHOLD` | Household which can be reached by ads. |\n| `INDIVIDUAL` | Individual people who can view ads. |","enum":["HOUSEHOLD","INDIVIDUAL"],"type":"string"},"Recurrence":{"enum":["LIFETIME"],"type":"string"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p_ALL.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p_ALL.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p_ALL.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p_ALL.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p_ALL.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p_ALL.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p_ALL.json))","title":"LinearTvIncrementalReachForecasts API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/linearTvIncrementalReachForecasts":{"post":{"description":"Generate Linear TV incremental reach forecast comparing with supported Streaming TV supplies\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateLinearTvIncrementalReachForecast","parameters":[{"$ref":"#/components/parameters/AccountIdHeader"},{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinearTvIncrementalReachForecastRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTvIncrementalReachForecastMultiStatusResponse"}}},"description":"CreateLinearTvIncrementalReachForecast 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["LinearTvIncrementalReachForecasts"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}