{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AudienceTargetTypeV1":{"enum":["AUDIENCE"],"type":"string"},"AudienceTargetV1":{"properties":{"audienceId":{"description":"The unique identifier for the audience.\nUse the [audiences](https://advertising.amazon.com/API/docs/en-us/audiences/#/Discovery/listAudiences) discovery resource to look up audience identifiers.\n\u003cli\u003eIncluded groups are joined by an intersection. Users must be in all of the groups specified to be included.\u003c/li\u003e\n\u003cli\u003eAudiences within an inclusion group are joined by OR/ANY logic. Audiences within the exclusion group are joined by AND/ALL logic. This means that users can be in any of the audiences inside a group to be included or excluded.\u003c/li\u003e\n\u003cli\u003eAll audiences within the same group must either be included or excluded.\u003c/li\u003e\n\u003cli\u003eYou can specify up to 10 groups to be included, but only 1 group to be excluded.\u003c/li\u003e\n\u003cli\u003eUp to 500 audience IDs can be specified per group.\u003c/li\u003e","minLength":1,"type":"string"},"groupId":{"description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g., \"1\").\nTo add audiences to a new group, choose any string not currently being used on this forecast.\nTo add audiences to an existing group, use the existing groupId from this forecast. You may specify up to 10 include groups and 1 exclude group.","pattern":"^[0-9]+$","type":"string"},"targetType":{"$ref":"#/components/schemas/AudienceTargetTypeV1"}},"required":["audienceId","targetType"],"type":"object"},"BadRequestExceptionResponseContent":{"description":"Bad Request.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"BiddingInfoV1":{"description":"The information about bidding cost.","properties":{"maxAvgCpm":{"description":"Maximum average CPM rate (cost per thousand impressions).\nIf not provided, we will assume default value based on historical measurement.","format":"double","minimum":0,"type":"number"},"maxCpc":{"description":"Maximum CPC (cost per click).\nIf not provided, we will assume default value based on historical measurement.","format":"double","minimum":0,"type":"number"},"maxVCpm":{"description":"Maximum vCPM rate (cost per thousand viewable impressions).\nIf not provided, we will assume default value based on historical measurement.","format":"double","minimum":0,"type":"number"}},"type":"object"},"BudgetAllocationV1":{"properties":{"reach":{"description":"The reach number of the selected data point of the reach forecast.","format":"int64","minimum":0,"type":"integer"},"reachForecastId":{"description":"The identifier of the Reach Forecast that the specified budget is allocated to.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"}},"required":["reach","reachForecastId"],"type":"object"},"ContentGenreTargetTypeV1":{"enum":["CONTENT_GENRE"],"type":"string"},"ContentGenreTargetV1":{"properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenreV1"},"targetType":{"$ref":"#/components/schemas/ContentGenreTargetTypeV1"}},"required":["contentGenre","targetType"],"type":"object"},"ContentGenreV1":{"description":"Include/Exclude content based on genre.\nContent with GENRE_NOT_AVAILABLE includes content where genre is unavailable or unknown.","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","GENRE_NOT_AVAILABLE","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN"],"type":"string"},"ContentRatingDetailsV1":{"oneOf":[{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingV1"}},"required":["dspContentRating"],"title":"dspContentRating","type":"object"}]},"ContentRatingTargetTypeV1":{"enum":["CONTENT_RATING"],"type":"string"},"ContentRatingTargetV1":{"properties":{"contentRatingDetails":{"$ref":"#/components/schemas/ContentRatingDetailsV1"},"contentRatingType":{"$ref":"#/components/schemas/ContentRatingTypeV1"},"targetType":{"$ref":"#/components/schemas/ContentRatingTargetTypeV1"}},"required":["contentRatingDetails","contentRatingType","targetType"],"type":"object"},"ContentRatingTypeV1":{"enum":["DSP_CONTENT_RATING"],"type":"string"},"CountryCodeV1":{"description":"The code of the country for the forecast.","enum":["AE","AT","AU","BR","CA","DE","ES","FR","GB","IN","IT","JP","MX","NL","NZ","SA","SE","TR","US"],"type":"string"},"CreateDeduplicatedReachForecastsV1RequestContent":{"properties":{"deduplicatedReachForecasts":{"description":"A list of Deduplicate Reach Forecasts to create.\nMaximum 100 unique Reach Forecasts can be involved in a single request.","items":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1RequestElement"},"maxItems":100,"minItems":1,"type":"array"}},"required":["deduplicatedReachForecasts"],"type":"object"},"CreateDeduplicatedReachForecastsV1RequestElement":{"properties":{"budgetAllocations":{"description":"The list of budget allocations for the Reach Forecasts to have their reach deduplicated.\nTotal number of unique Reach Forecast IDs in budgetAllocations in the same request\nmust be less than 100.","items":{"$ref":"#/components/schemas/BudgetAllocationV1"},"maxItems":100,"minItems":1,"type":"array"}},"required":["budgetAllocations"],"type":"object"},"CreateDeduplicatedReachForecastsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1ResponseError"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1ResponseSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"required":["error","success"],"type":"object"},"CreateDeduplicatedReachForecastsV1ResponseElement":{"properties":{"deduplicatedReach":{"description":"Forecasted deduplicated reach.","format":"int64","minimum":0,"type":"integer"},"deduplicatedReachForecastId":{"description":"This is the unique identifier of the Deduplicated Reach Forecast resource.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"}},"required":["deduplicatedReach","deduplicatedReachForecastId"],"type":"object"},"CreateDeduplicatedReachForecastsV1ResponseError":{"properties":{"error":{"$ref":"#/components/schemas/ReachPlanningServiceError"},"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["error","index"],"type":"object"},"CreateDeduplicatedReachForecastsV1ResponseSuccess":{"properties":{"deduplicatedReachForecast":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1ResponseElement"},"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["deduplicatedReachForecast","index"],"type":"object"},"CreateReachForecastsV1RequestContent":{"properties":{"commonTargets":{"description":"The list of common targets to be applied to all reach forecasts to be created in this request.\nThe common targets will be added into each forecast specific targets to obtain the final targeting.\nTargets of the same targetType and of the same negative boolean are combined using OR statements.\nTargets of different types are associated using AND statements.\nNote: Audience targets of the same group (as specified by groupId) are linked via an OR linkage.\nAudience target groups are linked via an AND linkage.\nAudience targets without groupId are consider as different group, thus are also linked via an AND linkage.","items":{"$ref":"#/components/schemas/PlanningTargetV1"},"maxItems":15000,"minItems":0,"type":"array"},"reachForecasts":{"description":"A list of reach forecast to be created.","items":{"$ref":"#/components/schemas/CreateReachForecastsV1RequestElement"},"maxItems":100,"minItems":1,"type":"array"}},"required":["reachForecasts"],"type":"object"},"CreateReachForecastsV1RequestElement":{"properties":{"advertisedProductCategoryIds":{"description":"The identifiers of the advertised product categories for the forecast.\nUse the DSP [ListAdvertisedProductCategories API](https://advertising.amazon.com/API/docs/en-us/dsp-discovery-advertised-product-categories#tag/Discovery-Advertised-Product-Categories/operation/DspListAdvertisedProductCategoriesV1) to look up advertised product category IDs.","items":{"maxLength":50,"minLength":1,"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"deliveryType":{"$ref":"#/components/schemas/DeliveryTypeV1"},"endDate":{"description":"The forecast end date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"reachType":{"$ref":"#/components/schemas/ReachTypeV1"},"startDate":{"description":"The forecast start date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"supplyPackage":{"description":"The combination of Ads supply.","items":{"$ref":"#/components/schemas/SupplyV1"},"maxItems":10,"minItems":1,"type":"array"},"targets":{"description":"The list of targets for the forecast.\nTargets of the same targetType and of the same negative boolean are combined using OR statements.\nTargets of different types are associated using AND statements.\nNote: Audience targets of the same group (as specified by groupId) are linked via an OR linkage.\nAudience target groups are linked via an AND linkage.\nAudience targets without groupId are consider as different group, thus are also linked via an AND linkage.","items":{"$ref":"#/components/schemas/PlanningTargetV1"},"maxItems":15000,"minItems":0,"type":"array"}},"required":["countryCode","deliveryType","endDate","reachType","startDate"],"type":"object"},"CreateReachForecastsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/CreateReachForecastsV1ResponseError"},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CreateReachForecastsV1ResponseSuccess"},"maxItems":100,"minItems":0,"type":"array"}},"required":["error","success"],"type":"object"},"CreateReachForecastsV1ResponseElement":{"properties":{"availableImpressions":{"description":"The number of impressions available for you to purchase after considering contention\n(G - booked demand) among the matchingImpressions","format":"int64","minimum":0,"type":"integer"},"avgCpm":{"description":"The CPM rate (cost per thousand impressions).","format":"double","minimum":0,"type":"number"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"cpc":{"description":"The CPC rate (cost per click).","format":"double","minimum":0,"type":"number"},"creationDateTime":{"description":"The date time that the reach forecast was created.","format":"date-time","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeV1"},"dataPoints":{"description":"The list of data points for the reach curve.","items":{"$ref":"#/components/schemas/ReachCurveDataPointV1"},"maxItems":120,"minItems":0,"type":"array"},"matchingImpressions":{"description":"The number of impressions that match your targeting","format":"int64","minimum":0,"type":"integer"},"maxCpm":{"description":"The maximum CPM rate (cost per thousand impressions).","format":"double","minimum":0,"type":"number"},"reachForecastId":{"description":"This is the unique identifier of the Reach Forecast resource.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"status":{"$ref":"#/components/schemas/ReachForecastStatusV1"}},"required":["countryCode","creationDateTime","currencyCode","dataPoints","reachForecastId","status"],"type":"object"},"CreateReachForecastsV1ResponseError":{"properties":{"error":{"$ref":"#/components/schemas/ReachPlanningServiceError"},"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":99,"minimum":0,"type":"integer"}},"required":["error","index"],"type":"object"},"CreateReachForecastsV1ResponseSuccess":{"properties":{"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":99,"minimum":0,"type":"integer"},"reachForecast":{"$ref":"#/components/schemas/CreateReachForecastsV1ResponseElement"}},"required":["index","reachForecast"],"type":"object"},"CurrencyCodeV1":{"description":"The currency for an associated monetary value.","enum":["AED","AUD","BRL","CAD","EUR","GBP","INR","JPY","MXN","SAR","SEK","TRY","USD"],"type":"string"},"DeliveryTypeV1":{"description":"The delivery method of the envisioned campaign.","enum":["GUARANTEED","NON_GUARANTEED"],"type":"string"},"DeviceTargetTypeV1":{"enum":["DEVICE"],"type":"string"},"DeviceTargetV1":{"properties":{"deviceType":{"$ref":"#/components/schemas/DeviceTypeV1"},"targetType":{"$ref":"#/components/schemas/DeviceTargetTypeV1"}},"required":["deviceType","targetType"],"type":"object"},"DeviceTypeV1":{"description":"The type of device being targeted.","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE"],"type":"string"},"DspContentRatingV1":{"description":"Exclude content based on available content rating options:\n\u003cli\u003e SUITABLE_FOR_ALL_AUDIENCES: Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game).\u003c/li\u003e\n\u003cli\u003e SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE: Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game).\u003c/li\u003e\n\u003cli\u003e SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES: Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game).\u003c/li\u003e\n\u003cli\u003e SUITABLE_FOR_MATURE_AUDIENCES: Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game).\u003c/li\u003e\n\u003cli\u003e SUITABLE_FOR_ADULTS: Ages 18+. Equivalent to content that is rated NC-17 (film).\u003c/li\u003e\n\u003cli\u003e RATING_NOT_AVAILABLE: Content where rating isn\u0027t available from the publisher.\u003c/li\u003e","enum":["RATING_NOT_AVAILABLE","SUITABLE_FOR_ADULTS","SUITABLE_FOR_ALL_AUDIENCES","SUITABLE_FOR_MATURE_AUDIENCES","SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE","SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES"],"type":"string"},"ErrorCode":{"description":"Error code.","enum":["INTERNAL_SERVER_ERROR","INVALID_MULTI_COUNTRY_LOCATION","MAX_CPC_TOO_LOW","PERFORMANCE_CURVE_ERROR","REACH_CURVE_DEDUPLICATION_ERROR","REACH_CURVE_ERROR","REACH_FORECAST_NOT_FOUND","REQUEST_VALIDATION_ERROR","SERVER_TIMEOUT","SERVICE_UNAVAILABLE","TARGETING_TOO_NARROW","UNAUTHORIZED_ERROR"],"type":"string"},"ForbiddenExceptionResponseContent":{"description":"Forbidden.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"FrequencyCapTimeUnitV1":{"description":"The time unit.","enum":["DAYS","MONTHS","WEEKS"],"type":"string"},"FrequencyCapTypeV1":{"description":"The type of advertising frequency cap. If UNCAPPED, no other fields are used.","enum":["CUSTOM","UNCAPPED"],"type":"string"},"FrequencyCapV1":{"description":"The limit of how many times ads appear to the same viewer.","properties":{"maxImpressions":{"description":"The maximum number of times an ad is displayed.","format":"int32","maximum":500,"minimum":1,"type":"integer"},"timeUnit":{"$ref":"#/components/schemas/FrequencyCapTimeUnitV1"},"timeUnitCount":{"description":"The count of time units.","format":"int32","maximum":30,"minimum":1,"type":"integer"},"type":{"allOf":[{"$ref":"#/components/schemas/FrequencyCapTypeV1"},{"default":"UNCAPPED"}]}},"type":"object"},"GeneratePerformanceForecastV1ResponseElement":{"description":"Performance curve for a specific metric","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"creationDateTime":{"description":"The date time that the performance forecast was created.","format":"date-time","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeV1"},"dataPoints":{"description":"List of data points for the curve","items":{"$ref":"#/components/schemas/PerformanceCurveDataPointV1"},"maxItems":120,"minItems":0,"type":"array"},"performanceMetric":{"$ref":"#/components/schemas/PerformanceMetricV1"}},"required":["countryCode","creationDateTime","currencyCode","dataPoints","performanceMetric"],"type":"object"},"GeneratePerformanceForecastsV1RequestContent":{"properties":{"performanceForecasts":{"items":{"$ref":"#/components/schemas/GeneratePerformanceForecastsV1RequestElement"},"maxItems":5,"minItems":1,"type":"array"}},"required":["performanceForecasts"],"type":"object"},"GeneratePerformanceForecastsV1RequestElement":{"properties":{"advertisedProductCategoryIds":{"description":"The identifiers of the advertised product categories for the forecast.\nUse the DSP [ListAdvertisedProductCategories API](https://advertising.amazon.com/API/docs/en-us/dsp-discovery-advertised-product-categories#tag/Discovery-Advertised-Product-Categories/operation/DspListAdvertisedProductCategoriesV1) to look up advertised product category IDs.","items":{"maxLength":50,"minLength":1,"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"biddingInfo":{"$ref":"#/components/schemas/BiddingInfoV1"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"deliveryType":{"$ref":"#/components/schemas/DeliveryTypeV1"},"endDate":{"description":"The forecast end date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"performanceMetric":{"$ref":"#/components/schemas/PerformanceMetricV1"},"reachType":{"$ref":"#/components/schemas/ReachTypeV1"},"startDate":{"description":"The forecast start date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"supplyPackage":{"description":"The combination of Ads supply.","items":{"$ref":"#/components/schemas/SupplyV1"},"maxItems":10,"minItems":1,"type":"array"},"targets":{"items":{"$ref":"#/components/schemas/PlanningTargetV1"},"maxItems":15000,"minItems":0,"type":"array"}},"required":["countryCode","deliveryType","endDate","performanceMetric","reachType","startDate"],"type":"object"},"GeneratePerformanceForecastsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/GeneratePerformanceForecastsV1ResponseError"},"maxItems":5,"minItems":0,"type":"array"},"success":{"description":"List of performance curves for each requested performance metric.","items":{"$ref":"#/components/schemas/GeneratePerformanceForecastsV1ResponseSuccess"},"maxItems":5,"minItems":0,"type":"array"}},"required":["error","success"],"type":"object"},"GeneratePerformanceForecastsV1ResponseError":{"properties":{"error":{"$ref":"#/components/schemas/ReachPlanningServiceError"},"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":4,"minimum":0,"type":"integer"}},"required":["error","index"],"type":"object"},"GeneratePerformanceForecastsV1ResponseSuccess":{"properties":{"index":{"description":"This is the index of the corresponding request element in the request payload.","format":"int32","maximum":4,"minimum":0,"type":"integer"},"performanceForecast":{"$ref":"#/components/schemas/GeneratePerformanceForecastV1ResponseElement"}},"required":["index","performanceForecast"],"type":"object"},"IABCategoryTargetTypeV1":{"enum":["IAB_CATEGORY"],"type":"string"},"IABCategoryTargetV1":{"properties":{"iabContentCategory":{"description":"The IAB content category to target.\nTo get the list of valid values, see https://advertising.amazon.com/API/docs/en-us/dsp-campaigns/#tag/Discovery/operation/getIabContentCategories","minLength":1,"type":"string"},"targetType":{"$ref":"#/components/schemas/IABCategoryTargetTypeV1"}},"required":["iabContentCategory","targetType"],"type":"object"},"InternalServerErrorExceptionResponseContent":{"description":"Internal Server Error.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"InventorySourceTargetTypeV1":{"enum":["INVENTORY_SOURCE"],"type":"string"},"InventorySourceTargetV1":{"properties":{"inventorySourceId":{"description":"The identifier of the inventory source.\nThese can be obtained from the inventory sources discovery endpoint.","minLength":1,"type":"string"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceTypeV1"},"targetType":{"$ref":"#/components/schemas/InventorySourceTargetTypeV1"}},"required":["inventorySourceId","inventorySourceType","targetType"],"type":"object"},"InventorySourceTypeV1":{"description":"The type of inventory source to be targeted.\n\u003cli\u003eDEAL: Deal inventory.","enum":["DEAL","PUBLISHER"],"type":"string"},"KeywordTargetMatchTypeV1":{"enum":["BROAD","EXACT","PHRASE"],"type":"string"},"KeywordTargetTypeV1":{"enum":["KEYWORD"],"type":"string"},"KeywordTargetV1":{"properties":{"keyword":{"maxLength":81,"minLength":1,"type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordTargetMatchTypeV1"},"targetType":{"$ref":"#/components/schemas/KeywordTargetTypeV1"}},"required":["keyword","matchType","targetType"],"type":"object"},"ListReachForecastTargetsV1RequestContent":{"properties":{"maxResults":{"default":"1000","description":"Number of records to include in the paginated response.","format":"int32","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value for navigating to the next response page.","type":"string"},"reachForecastId":{"description":"This is the unique identifier of the Reach Forecast resource.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"}},"required":["reachForecastId"],"type":"object"},"ListReachForecastTargetsV1ResponseContent":{"properties":{"nextToken":{"description":"Token value for navigating to the next response page.","type":"string"},"targets":{"items":{"$ref":"#/components/schemas/PlanningTargetV1"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["targets"],"type":"object"},"ListReachForecastsV1RequestContent":{"properties":{"maxResults":{"default":"100","description":"Number of records to include in the paginated response.","format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token value for navigating to the next response page.","type":"string"},"reachForecastIds":{"description":"The IDs of Reach Forecasts to be retrived.","items":{"description":"This is the unique identifier of the Reach Forecast resource.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["reachForecastIds"],"type":"object"},"ListReachForecastsV1ResponseContent":{"properties":{"nextToken":{"description":"Token value for navigating to the next response page.","type":"string"},"reachForecasts":{"items":{"$ref":"#/components/schemas/ListReachForecastsV1ResponseElement"},"maxItems":100,"minItems":0,"type":"array"}},"required":["reachForecasts"],"type":"object"},"ListReachForecastsV1ResponseElement":{"properties":{"advertisedProductCategoryIds":{"description":"The identifiers of the advertised product categories for the forecast.\nUse the DSP [ListAdvertisedProductCategories API](https://advertising.amazon.com/API/docs/en-us/dsp-discovery-advertised-product-categories#tag/Discovery-Advertised-Product-Categories/operation/DspListAdvertisedProductCategoriesV1) to look up advertised product category IDs.","items":{"maxLength":50,"minLength":1,"type":"string"},"maxItems":500,"minItems":0,"type":"array"},"availableImpressions":{"description":"The number of impressions available for you to purchase after considering contention\n(G - booked demand) among the matchingImpressions","format":"int64","minimum":0,"type":"integer"},"avgCpm":{"description":"The CPM rate (cost per thousand impressions).","format":"double","minimum":0,"type":"number"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"cpc":{"description":"The CPC rate (cost per click).","format":"double","minimum":0,"type":"number"},"creationDateTime":{"description":"The date time that the reach forecast was created.","format":"date-time","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeV1"},"dataPoints":{"description":"The list of data points for the reach curve.","items":{"$ref":"#/components/schemas/ReachCurveDataPointV1"},"maxItems":120,"minItems":0,"type":"array"},"deliveryType":{"$ref":"#/components/schemas/DeliveryTypeV1"},"endDate":{"description":"The forecast end date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"description":"The number of impressions that match your targeting","format":"int64","minimum":0,"type":"integer"},"maxCpm":{"description":"The maximum CPM rate (cost per thousand impressions).","format":"double","minimum":0,"type":"number"},"reachForecastId":{"description":"This is the unique identifier of the Reach Forecast resource.","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"reachType":{"$ref":"#/components/schemas/ReachTypeV1"},"startDate":{"description":"The forecast start date in YYYY-MM-DD format.","format":"date","pattern":"^(((19|20)([2468][048]|[13579][26]|0[48])|2000)-02-29|((19|20)[0-9]{2}-(0[469]|11)-(0[1-9]|[12][0-9]|30)|(19|20)[0-9]{2}-(0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(19|20)[0-9]{2}-02-(0[1-9]|1[0-9]|2[0-8])))$","type":"string"},"status":{"$ref":"#/components/schemas/ReachForecastStatusV1"},"supplyPackage":{"description":"The combination of Ads supply.","items":{"$ref":"#/components/schemas/SupplyV1"},"maxItems":10,"minItems":1,"type":"array"}},"required":["countryCode","creationDateTime","currencyCode","dataPoints","deliveryType","endDate","reachForecastId","reachType","startDate","status"],"type":"object"},"LocationTargetTypeV1":{"enum":["LOCATION"],"type":"string"},"LocationTargetV1":{"properties":{"geoLocation":{"description":"The location to target.\nUse the [GeoLocation API](https://advertising.amazon.com/API/docs/en-us/dsp-campaigns#tag/Discovery/operation/getGeoLocations) to obtain targetable location IDs.\nSupported location category are \"COUNTRY\" and \"DMA\".\nCurrently, only US DMA are supported. Search for \"US DMAs\" with textQuery to get only the DMAs in the US.","minLength":1,"type":"string"},"targetType":{"$ref":"#/components/schemas/LocationTargetTypeV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalV1"}},"required":["geoLocation","targetType"],"type":"object"},"NotFoundExceptionResponseContent":{"description":"Not Found.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"PerformanceCurveDataPointV1":{"properties":{"cpc":{"description":"Cost Per Click","format":"double","minimum":0,"type":"number"},"cpdpv":{"description":"Cost Per Detail Page View","format":"double","minimum":0,"type":"number"},"cpvc":{"description":"Cost Per Video Completion","format":"double","minimum":0,"type":"number"},"ctr":{"description":"Click-Through Rate","format":"double","maximum":1,"minimum":0,"type":"number"},"ecpm":{"description":"Effective Cost Per Mille","format":"double","minimum":0,"type":"number"},"prediction":{"description":"Prediction for the performance metric requested in the input.","format":"double","minimum":0,"type":"number"},"spend":{"description":"The monetary spend to achieve the provided prediction (in the currency specified).","format":"double","minimum":0,"type":"number"},"vcr":{"description":"Video Completion Rate","format":"double","maximum":1,"minimum":0,"type":"number"}},"required":["prediction","spend"],"type":"object"},"PerformanceMetricV1":{"description":"The performance metric to be forecasted.","enum":["CLICK","DETAIL_PAGE_VIEW","VIDEO_COMPLETION"],"type":"string"},"PlanningTargetDetailsV1":{"oneOf":[{"properties":{"audienceTarget":{"$ref":"#/components/schemas/AudienceTargetV1"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"contentGenreTarget":{"$ref":"#/components/schemas/ContentGenreTargetV1"}},"required":["contentGenreTarget"],"title":"contentGenreTarget","type":"object"},{"properties":{"contentRatingTarget":{"$ref":"#/components/schemas/ContentRatingTargetV1"}},"required":["contentRatingTarget"],"title":"contentRatingTarget","type":"object"},{"properties":{"deviceTarget":{"$ref":"#/components/schemas/DeviceTargetV1"}},"required":["deviceTarget"],"title":"deviceTarget","type":"object"},{"properties":{"iabContentCategoryTarget":{"$ref":"#/components/schemas/IABCategoryTargetV1"}},"required":["iabContentCategoryTarget"],"title":"iabContentCategoryTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/InventorySourceTargetV1"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"},{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTargetV1"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"locationTarget":{"$ref":"#/components/schemas/LocationTargetV1"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/ProductCategoryTargetV1"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","type":"object"},{"properties":{"productTarget":{"$ref":"#/components/schemas/ProductTargetV1"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTargetV1"}},"required":["themeTarget"],"title":"themeTarget","type":"object"}]},"PlanningTargetV1":{"properties":{"negative":{"default":"false","description":"Whether to target (false) or exclude (true) the given target.","type":"boolean"},"targetDetails":{"$ref":"#/components/schemas/PlanningTargetDetailsV1"}},"required":["negative","targetDetails"],"type":"object"},"ProductCategoryTargetTypeV1":{"enum":["PRODUCT_CATEGORY"],"type":"string"},"ProductCategoryTargetV1":{"properties":{"asinCategory":{"description":"The product category to target.","pattern":"^[0-9]+$","type":"string"},"targetType":{"$ref":"#/components/schemas/ProductCategoryTargetTypeV1"}},"required":["asinCategory","targetType"],"type":"object"},"ProductTargetTypeV1":{"enum":["PRODUCT"],"type":"string"},"ProductTargetV1":{"properties":{"asin":{"description":"The product asin to target.","minLength":1,"type":"string"},"targetType":{"$ref":"#/components/schemas/ProductTargetTypeV1"}},"required":["asin","targetType"],"type":"object"},"ReachCurveDataPointV1":{"properties":{"impressions":{"description":"The number of on-target impressions.","format":"int64","minimum":0,"type":"integer"},"reach":{"description":"The forecasted on-target reached.","format":"int64","minimum":0,"type":"integer"},"spend":{"description":"The forecasted spend in requested currency based on the estimated average CPM.","format":"double","minimum":0,"type":"number"}},"required":["impressions","reach","spend"],"type":"object"},"ReachForecastStatusV1":{"description":"The status of the reach forecast.\nSUCCESS: The forecast is run successful.\nEXPIRED: The forecast data is no longer up-to-date. In order to access the forecast you will need to submit a new request.","enum":["EXPIRED","SUCCESS"],"type":"string"},"ReachPlanningServiceError":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"ReachTypeV1":{"description":"The unit of reach represented in the data.","enum":["HOUSEHOLDS"],"type":"string"},"ServerTimeoutExceptionResponseContent":{"description":"Server Timeout.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"ServiceUnavailableExceptionResponseContent":{"description":"Service Unavailable. The service is temporarily unable to process this request due to high demand.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"SupplyV1":{"enum":["DSP_ALEXA_DISPLAY","DSP_AUDIO","DSP_DISPLAY","DSP_FIRE_TABLET","DSP_FIRE_TV","DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY","DSP_OLV","DSP_PRIME_VIDEO","DSP_STREAMING_TV","DSP_TWITCH_DISPLAY","DSP_TWITCH_VIDEO","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_PRODUCTS"],"type":"string"},"ThemeTargetMatchTypeV1":{"enum":["KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES"],"type":"string"},"ThemeTargetTypeV1":{"enum":["THEME"],"type":"string"},"ThemeTargetV1":{"properties":{"matchType":{"$ref":"#/components/schemas/ThemeTargetMatchTypeV1"},"targetType":{"$ref":"#/components/schemas/ThemeTargetTypeV1"}},"required":["matchType","targetType"],"type":"object"},"TooManyRequestsExceptionResponseContent":{"description":"Too Many Requests.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"UnauthorizedExceptionResponseContent":{"description":"Unauthorized.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"description":"Human readable response message.","type":"string"}},"type":"object"},"UserLocationSignalV1":{"enum":["CURRENT","HOME","MULTIPLE_SIGNALS"],"type":"string"}},"securitySchemes":{}},"info":{"description":"Reach Planning Service API provides insight for advertising media planning by forecasting for reach, incremental/deduplicated reach, and other performance metrics.","title":"Reach Planning Service","version":"3.0"},"openapi":"3.0.1","paths":{"/mediaPlan/v1/deduplicatedReachForecasts":{"post":{"description":"Creates a list of De-duplicated Reach Forecasts.\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[\"campaign_edit\"]","operationId":"CreateDeduplicatedReachForecastsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}},{"description":"The manager accounts associated to the ads accounts.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The manager accounts associated to the ads accounts.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"CreateDeduplicatedReachForecastsV1_example1":{"description":"This example is showing creation of two deduplicated reach forecasts.","summary":"Example of creating Deduplicated Reach Forecasts.","value":"amzn1.application-oa2-client.fakeClient1234567890"}},"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 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.","examples":{"CreateDeduplicatedReachForecastsV1_example1":{"description":"This example is showing creation of two deduplicated reach forecasts.","summary":"Example of creating Deduplicated Reach Forecasts.","value":"123123123123123"}},"in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateDeduplicatedReachForecastsV1_example1":{"description":"This example is showing creation of two deduplicated reach forecasts.","summary":"Example of creating Deduplicated Reach Forecasts.","value":{"deduplicatedReachForecasts":[{"budgetAllocations":[{"reach":"100000","reachForecastId":"24281a60-387f-4f9f-abb2-66378a8712e4"},{"reach":"100000","reachForecastId":"36e8f956-7126-4c12-3792-1ae1d372ef9c"}]},{"budgetAllocations":[{"reach":"120000","reachForecastId":"24281a60-387f-4f9f-abb2-66378a8712e4"},{"reach":"110000","reachForecastId":"36e8f956-7126-4c12-3792-1ae1d372ef9c"}]}]}}},"schema":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateDeduplicatedReachForecastsV1_example1":{"description":"This example is showing creation of two deduplicated reach forecasts.","summary":"Example of creating Deduplicated Reach Forecasts.","value":{"error":[],"success":[{"deduplicatedReachForecast":{"deduplicatedReach":"26758483","deduplicatedReachForecastId":"122d5a10-3ffe-6dc5-6127-19a02cb23765"},"index":"0"},{"deduplicatedReachForecast":{"deduplicatedReach":"28787878","deduplicatedReachForecastId":"f76e39cd-36a2-3b04-e126-c9e37fe53c23"},"index":"1"}]}}},"schema":{"$ref":"#/components/schemas/CreateDeduplicatedReachForecastsV1ResponseContent"}}},"description":"CreateDeduplicatedReachForecastsV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorExceptionResponseContent"}}},"description":"InternalServerErrorException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimeoutExceptionResponseContent"}}},"description":"ServerTimeoutException 504 response"}},"tags":["Forecast deduplication API"]}},"/mediaPlan/v1/performanceForecasts":{"post":{"description":"Generates forecast curve for the provided performance metric and targets.\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[\"campaign_edit\"]","operationId":"GeneratePerformanceForecastsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}},{"description":"The manager accounts associated to the ads accounts.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The manager accounts associated to the ads accounts.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"GeneratePerformanceForecastsV1_example1":{"description":"This example shows generation of an performance forecast for clicks, detail page view and video completion.","summary":"Example of generating an performance forecast.","value":"amzn1.application-oa2-client.fakeClient1234567890"},"GeneratePerformanceForecastsV1_example2":{"description":"This example shows a response where one metric succeeded and another failed.","summary":"Example with partial failure.","value":"amzn1.application-oa2-client.fakeClient1234567890"}},"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 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.","examples":{"GeneratePerformanceForecastsV1_example1":{"description":"This example shows generation of an performance forecast for clicks, detail page view and video completion.","summary":"Example of generating an performance forecast.","value":"123123123123123"},"GeneratePerformanceForecastsV1_example2":{"description":"This example shows a response where one metric succeeded and another failed.","summary":"Example with partial failure.","value":"123123123123123"}},"in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"GeneratePerformanceForecastsV1_example1":{"description":"This example shows generation of an performance forecast for clicks, detail page view and video completion.","summary":"Example of generating an performance forecast.","value":{"performanceForecasts":[{"advertisedProductCategoryIds":["335417915575420049"],"biddingInfo":{"maxAvgCpm":"25","maxCpc":"1.5","maxVCpm":"30"},"countryCode":"US","deliveryType":"GUARANTEED","endDate":"2025-12-20","frequencyCap":{"maxImpressions":"3","timeUnit":"DAYS","timeUnitCount":"1","type":"CUSTOM"},"performanceMetric":"CLICK","reachType":"HOUSEHOLDS","startDate":"2025-12-06","supplyPackage":["DSP_TWITCH_VIDEO"],"targets":[{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"111","groupId":"1","targetType":"AUDIENCE"}}},{"negative":"false","targetDetails":{"locationTarget":{"geoLocation":"1234","targetType":"LOCATION"}}}]},{"countryCode":"US","deliveryType":"NON_GUARANTEED","endDate":"2025-12-20","performanceMetric":"DETAIL_PAGE_VIEW","reachType":"HOUSEHOLDS","startDate":"2025-12-06","supplyPackage":["DSP_STREAMING_TV"]},{"countryCode":"US","deliveryType":"GUARANTEED","endDate":"2025-12-20","performanceMetric":"VIDEO_COMPLETION","reachType":"HOUSEHOLDS","startDate":"2025-12-06","supplyPackage":["DSP_PRIME_VIDEO"],"targets":[{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"111","groupId":"1","targetType":"AUDIENCE"}}}]}]}},"GeneratePerformanceForecastsV1_example2":{"description":"This example shows a response where one metric succeeded and another failed.","summary":"Example with partial failure.","value":{"performanceForecasts":[{"countryCode":"US","deliveryType":"NON_GUARANTEED","endDate":"2025-12-20","performanceMetric":"CLICK","reachType":"HOUSEHOLDS","startDate":"2025-12-06","supplyPackage":["DSP_STREAMING_TV"]},{"countryCode":"US","deliveryType":"GUARANTEED","endDate":"2025-12-20","performanceMetric":"VIDEO_COMPLETION","reachType":"HOUSEHOLDS","startDate":"2025-12-06","supplyPackage":["DSP_STREAMING_TV"]}]}}},"schema":{"$ref":"#/components/schemas/GeneratePerformanceForecastsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"GeneratePerformanceForecastsV1_example1":{"description":"This example shows generation of an performance forecast for clicks, detail page view and video completion.","summary":"Example of generating an performance forecast.","value":{"error":[],"success":[{"index":"0","performanceForecast":{"countryCode":"US","creationDateTime":"2025-09-02T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"cpc":"6.928674875740527","ctr":"0.004113340647543945","ecpm":"28.5","prediction":"7","spend":"54.15"},{"cpc":"6.928713977016345","ctr":"0.00411331743445307","ecpm":"28.5","prediction":"15","spend":"108.3"}],"performanceMetric":"CLICK"}},{"index":"1","performanceForecast":{"countryCode":"US","creationDateTime":"2025-09-02T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"cpdpv":"1","prediction":"0","spend":"88.11212292385102"},{"cpdpv":"174.40159131659834","prediction":"1","spend":"220.28562873268126"}],"performanceMetric":"DETAIL_PAGE_VIEW"}},{"index":"2","performanceForecast":{"countryCode":"US","creationDateTime":"2025-09-02T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"cpvc":"0.026002616574872007","prediction":"15925","spend":"414.098","vcr":"0.8651263973849037"},{"cpvc":"0.026000294298434187","prediction":"30405","spend":"790.56111365","vcr":"0.865203668150585"}],"performanceMetric":"VIDEO_COMPLETION"}}]}},"GeneratePerformanceForecastsV1_example2":{"description":"This example shows a response where one metric succeeded and another failed.","summary":"Example with partial failure.","value":{"error":[{"error":{"code":"INTERNAL_SERVER_ERROR","message":"Curve could not be generated."},"index":"1"}],"success":[{"index":"0","performanceForecast":{"countryCode":"US","creationDateTime":"2024-09-02T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"cpc":"1.25","ctr":"0.002","ecpm":"25","prediction":"8000","spend":"10000"}],"performanceMetric":"CLICK"}}]}}},"schema":{"$ref":"#/components/schemas/GeneratePerformanceForecastsV1ResponseContent"}}},"description":"GeneratePerformanceForecastsV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorExceptionResponseContent"}}},"description":"InternalServerErrorException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimeoutExceptionResponseContent"}}},"description":"ServerTimeoutException 504 response"}},"tags":["Performance Forecasting API"]}},"/mediaPlan/v1/reachForecasts":{"post":{"description":"Creates a list of new Reach Forecasts in bulk action.\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[\"campaign_edit\"]","operationId":"CreateReachForecastsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}},{"description":"The manager accounts associated to the ads accounts.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The manager accounts associated to the ads accounts.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"CreateReachForecastsV1_example1":{"description":"Thie example is showing creation of two reach forecasts with some common targeting parameters.","summary":"Example of creating Reach Forecasts.","value":"amzn1.application-oa2-client.fakeClient1234567890"}},"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 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.","examples":{"CreateReachForecastsV1_example1":{"description":"Thie example is showing creation of two reach forecasts with some common targeting parameters.","summary":"Example of creating Reach Forecasts.","value":"123123123123123"}},"in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateReachForecastsV1_example1":{"description":"Thie example is showing creation of two reach forecasts with some common targeting parameters.","summary":"Example of creating Reach Forecasts.","value":{"commonTargets":[{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"111","groupId":"1","targetType":"AUDIENCE"}}},{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"112","groupId":"1","targetType":"AUDIENCE"}}},{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"122","groupId":"2","targetType":"AUDIENCE"}}},{"negative":"true","targetDetails":{"audienceTarget":{"audienceId":"21","targetType":"AUDIENCE"}}},{"negative":"true","targetDetails":{"audienceTarget":{"audienceId":"22","targetType":"AUDIENCE"}}}],"reachForecasts":[{"advertisedProductCategoryIds":["335417915575420049"],"countryCode":"US","deliveryType":"GUARANTEED","endDate":"2025-12-26","reachType":"HOUSEHOLDS","startDate":"2025-12-12","supplyPackage":["DSP_STREAMING_TV"],"targets":[{"negative":"true","targetDetails":{"contentRatingTarget":{"contentRatingDetails":{"dspContentRating":"SUITABLE_FOR_ALL_AUDIENCES"},"contentRatingType":"DSP_CONTENT_RATING","targetType":"CONTENT_RATING"}}}]},{"advertisedProductCategoryIds":["335417915575420049"],"countryCode":"US","deliveryType":"GUARANTEED","endDate":"2025-12-26","frequencyCap":{"maxImpressions":"1","timeUnit":"DAYS","timeUnitCount":"1","type":"CUSTOM"},"reachType":"HOUSEHOLDS","startDate":"2025-12-12","supplyPackage":["DSP_TWITCH_VIDEO"],"targets":[{"negative":"true","targetDetails":{"deviceTarget":{"deviceType":"MOBILE","targetType":"DEVICE"}}}]}]}}},"schema":{"$ref":"#/components/schemas/CreateReachForecastsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateReachForecastsV1_example1":{"description":"Thie example is showing creation of two reach forecasts with some common targeting parameters.","summary":"Example of creating Reach Forecasts.","value":{"error":[],"success":[{"index":"0","reachForecast":{"avgCpm":"20","countryCode":"US","creationDateTime":"2024-06-01T23:36:09.973Z","currencyCode":"USD","dataPoints":[{"impressions":"14000","reach":"11000","spend":"280000"},{"impressions":"16000","reach":"12000","spend":"320000"}],"maxCpm":"40","reachForecastId":"24281a60-387f-4f9f-abb2-66378a8712e4","status":"SUCCESS"}},{"index":"1","reachForecast":{"avgCpm":"13","countryCode":"US","creationDateTime":"2024-06-01T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"impressions":"14000","reach":"10000","spend":"182000"},{"impressions":"16000","reach":"12000","spend":"208000"}],"maxCpm":"30","reachForecastId":"36e8f956-7126-4c12-3792-1ae1d372ef9c","status":"SUCCESS"}}]}}},"schema":{"$ref":"#/components/schemas/CreateReachForecastsV1ResponseContent"}}},"description":"CreateReachForecastsV1 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorExceptionResponseContent"}}},"description":"InternalServerErrorException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableExceptionResponseContent"}}},"description":"ServiceUnavailableException 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimeoutExceptionResponseContent"}}},"description":"ServerTimeoutException 504 response"}},"tags":["Reach Forecasting API"]}},"/mediaPlan/v1/reachForecasts/list":{"post":{"description":"Gets a list of Reach Forecasts by IDs\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[\"campaign_edit\"]","operationId":"ListReachForecastsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}},{"description":"The manager accounts associated to the ads accounts.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The manager accounts associated to the ads accounts.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"ListReachForecastsV1_example1":{"description":"This example is showing retrival of two reach forecast by their IDs.","summary":"Example of getting a list of Reach Forecasts by IDs.","value":"amzn1.application-oa2-client.fakeClient1234567890"}},"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 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.","examples":{"ListReachForecastsV1_example1":{"description":"This example is showing retrival of two reach forecast by their IDs.","summary":"Example of getting a list of Reach Forecasts by IDs.","value":"123123123123123"}},"in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListReachForecastsV1_example1":{"description":"This example is showing retrival of two reach forecast by their IDs.","summary":"Example of getting a list of Reach Forecasts by IDs.","value":{"reachForecastIds":["24281a60-387f-4f9f-abb2-66378a8712e4","36e8f956-7126-4c12-3792-1ae1d372ef9c"]}}},"schema":{"$ref":"#/components/schemas/ListReachForecastsV1RequestContent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"ListReachForecastsV1_example1":{"description":"This example is showing retrival of two reach forecast by their IDs.","summary":"Example of getting a list of Reach Forecasts by IDs.","value":{"reachForecasts":[{"advertisedProductCategoryIds":["335417915575420049"],"avgCpm":"20","countryCode":"US","creationDateTime":"2024-06-01T23:36:09.973Z","currencyCode":"USD","dataPoints":[{"impressions":"14000","reach":"11000","spend":"280000"},{"impressions":"16000","reach":"12000","spend":"320000"}],"deliveryType":"GUARANTEED","endDate":"2025-12-26","maxCpm":"40","reachForecastId":"24281a60-387f-4f9f-abb2-66378a8712e4","reachType":"HOUSEHOLDS","startDate":"2025-12-12","status":"SUCCESS","supplyPackage":["DSP_STREAMING_TV"]},{"advertisedProductCategoryIds":["335417915575420049"],"avgCpm":"13","countryCode":"US","creationDateTime":"2024-06-01T23:36:12.103Z","currencyCode":"USD","dataPoints":[{"impressions":"14000","reach":"10000","spend":"182000"},{"impressions":"16000","reach":"12000","spend":"208000"}],"deliveryType":"GUARANTEED","endDate":"2025-12-26","maxCpm":"30","reachForecastId":"36e8f956-7126-4c12-3792-1ae1d372ef9c","reachType":"HOUSEHOLDS","startDate":"2025-12-12","status":"SUCCESS","supplyPackage":["DSP_TWITCH_VIDEO"]}]}}},"schema":{"$ref":"#/components/schemas/ListReachForecastsV1ResponseContent"}}},"description":"ListReachForecastsV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorExceptionResponseContent"}}},"description":"InternalServerErrorException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimeoutExceptionResponseContent"}}},"description":"ServerTimeoutException 504 response"}},"tags":["Reach Forecasting API"]}},"/mediaPlan/v1/reachForecasts/targets/list":{"post":{"description":"Gets a list of targets of a Reach Forecast\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[\"campaign_edit\"]","operationId":"ListReachForecastTargetsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}},{"description":"The manager accounts associated to the ads accounts.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The manager accounts associated to the ads accounts.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"ListReachForecastTargetsV1_example1":{"description":"This example is showing retrival of the targeting parameters of a Reach Forecast.","summary":"Example of getting the list of targets of a Reach Forecast.","value":"amzn1.application-oa2-client.fakeClient1234567890"}},"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 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.","examples":{"ListReachForecastTargetsV1_example1":{"description":"This example is showing retrival of the targeting parameters of a Reach Forecast.","summary":"Example of getting the list of targets of a Reach Forecast.","value":"123123123123123"}},"in":"header","name":"Amazon-Advertising-API-Scope","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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListReachForecastTargetsV1_example1":{"description":"This example is showing retrival of the targeting parameters of a Reach Forecast.","summary":"Example of getting the list of targets of a Reach Forecast.","value":{"maxResults":10,"reachForecastId":"24281a60-387f-4f9f-abb2-66378a8712e4"}}},"schema":{"$ref":"#/components/schemas/ListReachForecastTargetsV1RequestContent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"ListReachForecastTargetsV1_example1":{"description":"This example is showing retrival of the targeting parameters of a Reach Forecast.","summary":"Example of getting the list of targets of a Reach Forecast.","value":{"targets":[{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"111","groupId":"1","targetType":"AUDIENCE"}}},{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"112","groupId":"1","targetType":"AUDIENCE"}}},{"negative":"false","targetDetails":{"audienceTarget":{"audienceId":"122","groupId":"2","targetType":"AUDIENCE"}}},{"negative":"true","targetDetails":{"audienceTarget":{"audienceId":"21","targetType":"AUDIENCE"}}},{"negative":"true","targetDetails":{"audienceTarget":{"audienceId":"22","targetType":"AUDIENCE"}}},{"negative":"true","targetDetails":{"deviceTarget":{"deviceType":"MOBILE","targetType":"DEVICE"}}}]}}},"schema":{"$ref":"#/components/schemas/ListReachForecastTargetsV1ResponseContent"}}},"description":"ListReachForecastTargetsV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorExceptionResponseContent"}}},"description":"InternalServerErrorException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimeoutExceptionResponseContent"}}},"description":"ServerTimeoutException 504 response"}},"tags":["Reach Forecasting API"]}}}}