{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"ActivationStateV1":{"description":"ADSP activation state for the media plan.\n\n`ELIGIBLE` - Plan is eligible but not activated yet. \n\n`NOT_ELIGIBLE` - Plan is not eligible for activation. \n\n`PROCESSING` - Activation in progress. \n\n`ACTIVATED` - Plan is activated successfully. \n\n`FAILED` - Activation failed - requires manual intervention. \n\n`CANCELLED` - Activated plan cancelled by user.","enum":["ACTIVATED","CANCELLED","ELIGIBLE","FAILED","NOT_ELIGIBLE","PROCESSING","READY"],"type":"string"},"AdProductV1":{"description":"The ad product of the planning item.","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS"],"type":"string"},"AdTypeV1":{"description":"The ad type of the planning item.","enum":["DISPLAY","VIDEO"],"type":"string"},"AdvertisingLocaleV1":{"description":"The advertising locale selection using the ISO language code.","enum":["ar-AE","de-DE","en-AU","en-CA","en-GB","en-IN","en-SG","en-US","es-CO","es-ES","es-MX","es-US","fr-CA","fr-FR","hi-IN","it-IT","ja-JP","ko-KR","nl-NL","pl-PL","pt-BR","sv-SE","ta-IN","th-TH","tr-TR","vi-VN","zh-CN","zh-TW"],"type":"string"},"AgeDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/AgeDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"AgeDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"},"range":{"$ref":"#/components/schemas/RangeV1"}},"required":["audienceId","metrics","range"],"type":"object"},"AudienceBehavioralInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/AudienceBehavioralInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"AudienceBehavioralInsightV1":{"properties":{"audienceCategory":{"$ref":"#/components/schemas/AudienceCategoryV1"},"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"}},"required":["audienceCategory","audienceId","metrics"],"type":"object"},"AudienceCategoryV1":{"enum":["INTEREST","IN_MARKET","LIFESTYLE","LIFE_EVENT"],"type":"string"},"AudienceOpportunitiesStateDetailsErrorTypeV1":{"description":"The type of error associated with an audience opportunity processing state.","enum":["AUDIENCE_TOO_LARGE","AUDIENCE_TOO_SMALL","INVALID_TARGET","NOT_AUTHORIZED_TARGET","UNEXPECTED_ERROR"],"type":"string"},"AudienceOpportunitiesStateDetailsErrorV1":{"description":"An error that contributed to the current audience opportunity processing state.","properties":{"message":{"description":"The error message.","type":"string"},"targetId":{"description":"The target associated with the error.","type":"string"},"type":{"$ref":"#/components/schemas/AudienceOpportunitiesStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"AudienceOpportunitiesStateDetailsV1":{"description":"The details associated with the audience opportunity processing state.","properties":{"errors":{"description":"The current processing state errors of the audience opportunity.","items":{"$ref":"#/components/schemas/AudienceOpportunitiesStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["errors"],"type":"object"},"AudienceOpportunityCreateV1":{"properties":{"audienceOpportunityLevel":{"$ref":"#/components/schemas/AudienceOpportunityLevelV1"},"audienceOpportunityType":{"$ref":"#/components/schemas/AudienceOpportunityTypeV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["audienceOpportunityLevel","audienceOpportunityType","mediaPlanVersionId"],"type":"object"},"AudienceOpportunityDeleteV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["audienceOpportunityId","mediaPlanVersionId"],"type":"object"},"AudienceOpportunityLevelV1":{"description":"The hierarchy level the audience opportunity is parented under.\n\n`MEDIA_PLAN` - The audience opportunity is parented under a media plan specified by the `mediaPlanId`\n\n`MARKETING_GOAL` - The audience opportunity is parented under a marketing goal specified by the `marketingGoalId`","enum":["MARKETING_GOAL","MEDIA_PLAN"],"type":"string"},"AudienceOpportunityTypeV1":{"description":"The audience opportunity type.\n\n`AUDIENCE_BASELINE` - This audience opportunity type will use associated audience targets in order to provide insights and sizing.\n\n`LOCATION_BASELINE` - This audience opportunity type will use associated location targets in order to provide insights and sizing.\n\n`MARKETING_GOAL` - This audience opportunity type will provide insights and sizing for the associated marketing goal. It will use targets associated with the linked `marketingGoalId`, subtract targets from lower marketing goals, and intersect with the baseline opportunity targets.","enum":["AUDIENCE_BASELINE","LOCATION_BASELINE","MARKETING_GOAL"],"type":"string"},"AudienceOpportunityUpdateV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"audienceOpportunityType":{"$ref":"#/components/schemas/AudienceOpportunityTypeV1"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["audienceOpportunityId","mediaPlanVersionId"],"type":"object"},"AudienceOpportunityV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"audienceOpportunityLevel":{"$ref":"#/components/schemas/AudienceOpportunityLevelV1"},"audienceOpportunityType":{"$ref":"#/components/schemas/AudienceOpportunityTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/AudienceOpportunitiesStateDetailsV1"}},"required":["audienceOpportunityId","audienceOpportunityLevel","audienceOpportunityType","creationDateTime","mediaPlanId","state","stateDetails"],"type":"object"},"AudienceSizePeriodV1":{"description":"The lookback period for the audience size.","enum":["ANNUAL"],"type":"string"},"AudienceSizeStateDetailsErrorTypeV1":{"description":"The type of error associated with an audience size processing state.","enum":["AUDIENCE_TOO_LARGE","AUDIENCE_TOO_SMALL","INVALID_TARGET","NOT_AUTHORIZED_TARGET","UNEXPECTED_ERROR"],"type":"string"},"AudienceSizeStateDetailsErrorV1":{"description":"An error that contributed to the current audience size processing state.","properties":{"message":{"description":"The error message.","type":"string"},"targetId":{"description":"The target associated with the error.","type":"string"},"type":{"$ref":"#/components/schemas/AudienceSizeStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"AudienceSizeStateDetailsV1":{"description":"The details associated with the audience size processing state.","properties":{"errors":{"description":"The current processing state errors of the audience size.","items":{"$ref":"#/components/schemas/AudienceSizeStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["errors"],"type":"object"},"AudienceSizeV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"audienceSizeId":{"description":"The ID of the resource.","type":"string"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"max":{"description":"The upper bound of estimated unique customers who are in the audience.","type":"integer"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"min":{"description":"The lower bound of estimated unique customers who are in the audience.","type":"integer"},"period":{"$ref":"#/components/schemas/AudienceSizePeriodV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/AudienceSizeStateDetailsV1"}},"required":["audienceOpportunityId","audienceSizeId","creationDateTime","mediaPlanId","period","state","stateDetails"],"type":"object"},"AudienceTargetV1":{"properties":{"audienceId":{"type":"string"},"groupId":{"description":"Groups audiences that should be targeted together.","type":"string"}},"required":["audienceId","groupId"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BehavioralInsightDetailsV1":{"oneOf":[{"properties":{"primeVideoBehavioralInsightDetails":{"$ref":"#/components/schemas/PrimeVideoBehavioralInsightDetailsV1"}},"required":["primeVideoBehavioralInsightDetails"],"title":"primeVideoBehavioralInsightDetails","type":"object"},{"properties":{"audienceBehavioralInsightDetails":{"$ref":"#/components/schemas/AudienceBehavioralInsightDetailsV1"}},"required":["audienceBehavioralInsightDetails"],"title":"audienceBehavioralInsightDetails","type":"object"},{"properties":{"productCategoryBehavioralInsightDetails":{"$ref":"#/components/schemas/ProductCategoryBehavioralInsightDetailsV1"}},"required":["productCategoryBehavioralInsightDetails"],"title":"productCategoryBehavioralInsightDetails","type":"object"}]},"BehavioralInsightStateDetailsErrorTypeV1":{"description":"The type of error associated with a behavioral insight processing state.","enum":["AUDIENCE_TOO_LARGE","AUDIENCE_TOO_SMALL","INVALID_TARGET","NOT_AUTHORIZED_TARGET","UNEXPECTED_ERROR"],"type":"string"},"BehavioralInsightStateDetailsErrorV1":{"description":"An error that contributed to the current behavioral insight processing state.","properties":{"message":{"description":"The error message.","type":"string"},"targetId":{"description":"The target associated with the error.","type":"string"},"type":{"$ref":"#/components/schemas/BehavioralInsightStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"BehavioralInsightStateDetailsV1":{"description":"The details associated with the behavioral insight processing state.","properties":{"errors":{"description":"The current processing state errors of the behavioral insight.","items":{"$ref":"#/components/schemas/BehavioralInsightStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["errors"],"type":"object"},"BehavioralInsightTypeV1":{"description":"The type of behavioral insight.","enum":["AUDIENCE","PRIME_VIDEO","PRODUCT_CATEGORY"],"type":"string"},"BehavioralInsightV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"behavioralInsightDetails":{"$ref":"#/components/schemas/BehavioralInsightDetailsV1"},"behavioralInsightId":{"description":"The ID of the resource.","type":"string"},"behavioralInsightType":{"$ref":"#/components/schemas/BehavioralInsightTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/BehavioralInsightStateDetailsV1"}},"required":["audienceOpportunityId","behavioralInsightDetails","behavioralInsightId","behavioralInsightType","creationDateTime","mediaPlanId","state","stateDetails"],"type":"object"},"BudgetAllocationCreateV1":{"properties":{"allocatedBudget":{"description":"The budget allocated by user. Applicable for `MEDIA_PLAN`, `MARKETING_GOAL` and `PLANNING_ITEM` budget allocation levels.","type":"integer"},"budgetAllocationDetails":{"$ref":"#/components/schemas/BudgetAllocationDetailsV1"},"budgetAllocationLevel":{"$ref":"#/components/schemas/BudgetAllocationLevelV1"},"budgetAllocationType":{"$ref":"#/components/schemas/BudgetAllocationTypeV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"planningItemId":{"description":"The ID of the resource.","type":"string"}},"required":["budgetAllocationLevel","mediaPlanVersionId"],"type":"object"},"BudgetAllocationDeleteV1":{"properties":{"budgetAllocationId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["budgetAllocationId","mediaPlanVersionId"],"type":"object"},"BudgetAllocationDetailsV1":{"oneOf":[{"properties":{"optimizedBudgetAllocationDetails":{"$ref":"#/components/schemas/OptimizedBudgetAllocationDetailsV1"}},"required":["optimizedBudgetAllocationDetails"],"title":"optimizedBudgetAllocationDetails","type":"object"},{"properties":{"seasonalBudgetAllocationDetails":{"$ref":"#/components/schemas/SeasonalBudgetAllocationDetailsV1"}},"required":["seasonalBudgetAllocationDetails"],"title":"seasonalBudgetAllocationDetails","type":"object"}]},"BudgetAllocationLevelV1":{"description":"The hierarchy level the budget allocation is parented under.\n\n`MEDIA_PLAN` - The budget allocation is parented under a media plan specified by the `mediaPlanId`\n\n`MARKETING_GOAL` - The budget allocation is parented under a marketing goal specified by the `marketingGoalId`\n\n`PLANNING_ITEM` - The budget allocation is parented under a planning item specified by the `planningItemId`","enum":["MARKETING_GOAL","MEDIA_PLAN","PLANNING_ITEM"],"type":"string"},"BudgetAllocationStateDetailsErrorTypeV1":{"description":"The type of error associated with a budget allocation processing state.","enum":["ALLOCATED_BUDGET_TOO_LARGE_TO_OPTIMIZE","BUDGET_UNSUPPORTED_ACCOUNT","UNEXPECTED_ERROR"],"type":"string"},"BudgetAllocationStateDetailsErrorV1":{"description":"An error that contributed to the current budget allocation processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/BudgetAllocationStateDetailsErrorTypeV1"}},"type":"object"},"BudgetAllocationStateDetailsV1":{"description":"The details associated with the budget allocation processing state.","properties":{"errors":{"description":"The current processing state errors of the budget allocation.","items":{"$ref":"#/components/schemas/BudgetAllocationStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"BudgetAllocationTypeV1":{"description":"The type of budget allocation.\n\n`SEASONAL_BUDGET_BREAKDOWN` - The budget allocation recommendation over flight periods\n\n`OPTIMIZED_TOTAL_BUDGET` - The optimized budget allocation recommendation","enum":["OPTIMIZED_TOTAL_BUDGET","SEASONAL_BUDGET_BREAKDOWN"],"type":"string"},"BudgetAllocationUpdateV1":{"properties":{"allocatedBudget":{"description":"The budget allocated by user. Applicable for `MEDIA_PLAN`, `MARKETING_GOAL` and `PLANNING_ITEM` budget allocation levels.","type":"integer"},"budgetAllocationDetails":{"$ref":"#/components/schemas/BudgetAllocationDetailsV1"},"budgetAllocationId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["budgetAllocationId","mediaPlanVersionId"],"type":"object"},"BudgetAllocationV1":{"properties":{"allocatedBudget":{"description":"The budget allocated by user. Applicable for `MEDIA_PLAN`, `MARKETING_GOAL` and `PLANNING_ITEM` budget allocation levels.","type":"integer"},"budgetAllocationDetails":{"$ref":"#/components/schemas/BudgetAllocationDetailsV1"},"budgetAllocationId":{"description":"The ID of the resource.","type":"string"},"budgetAllocationLevel":{"$ref":"#/components/schemas/BudgetAllocationLevelV1"},"budgetAllocationType":{"$ref":"#/components/schemas/BudgetAllocationTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"optimizedBudget":{"description":"The budget optimized by Amazon. Applicable only for `PLANNING_ITEM` level.","type":"integer"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/BudgetAllocationStateDetailsV1"}},"type":"object"},"BudgetMaximumStrategyV1":{"description":"Strategy used to determine the maximum budget for a funnel-channel combination:\n\n* MAX_REACH: Maximum budget capped by the reach curve for this funnel-channel\n* TOLERANCE: Maximum budget capped by intentional tolerance upper bound (e.g., GGS plans)","enum":["MAX_REACH","TOLERANCE"],"type":"string"},"BudgetMinimumStrategyV1":{"description":"Strategy used to determine the minimum budget for a funnel-channel combination:\n\n* STANDARD_HISTORIC: Minimum budget based on tight bound around historic spend\n* WIDE_RANGE: Minimum budget allowed to vary widely (e.g., Complete TV)","enum":["STANDARD_HISTORIC","WIDE_RANGE"],"type":"string"},"ChildrenAgeDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/ChildrenAgeDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"ChildrenAgeDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"},"range":{"$ref":"#/components/schemas/RangeV1"}},"required":["audienceId","metrics","range"],"type":"object"},"ChildrenCountDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/ChildrenCountDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"ChildrenCountDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"},"range":{"$ref":"#/components/schemas/RangeV1"}},"required":["audienceId","metrics","range"],"type":"object"},"ClickForecastDataPointV1":{"properties":{"cpc":{"format":"double","type":"number"},"ctr":{"format":"double","type":"number"},"ecpm":{"format":"double","type":"number"},"prediction":{"format":"double","type":"number"},"spend":{"format":"double","type":"number"}},"type":"object"},"ClickForecastV1":{"properties":{"availableImpressions":{"type":"integer"},"avgCpm":{"format":"double","type":"number"},"cpc":{"format":"double","type":"number"},"dataPoints":{"items":{"$ref":"#/components/schemas/ClickForecastDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"forecastId":{"type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"type":"integer"},"maxCpm":{"format":"double","type":"number"},"maxOnTargetImpressions":{"type":"integer"},"maxSpend":{"format":"double","type":"number"},"maxTotalImpressions":{"type":"integer"}},"type":"object"},"ConflictResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentGenreTargetV1":{"properties":{"contentGenre":{"$ref":"#/components/schemas/ContentGenreTypeV1"}},"required":["contentGenre"],"type":"object"},"ContentGenreTypeV1":{"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":{"dspContentRatingTarget":{"$ref":"#/components/schemas/DspContentRatingTargetV1"}},"required":["dspContentRatingTarget"],"title":"dspContentRatingTarget","type":"object"}]},"ContentRatingTargetV1":{"properties":{"contentRatingDetails":{"$ref":"#/components/schemas/ContentRatingDetailsV1"},"contentRatingType":{"$ref":"#/components/schemas/DspContentRatingTypeV1"}},"required":["contentRatingDetails","contentRatingType"],"type":"object"},"CountryCodeV1":{"description":"The country associated with the media plan. The audience targeted by the media plan will be limited to supply for the provided country.","enum":["AE","AU","BR","CA","DE","ES","FR","GB","IN","IT","JP","MX","NL","SA","SE","TR","US"],"type":"string"},"CreateAudienceOpportunitiesV1RequestContent":{"properties":{"audienceOpportunities":{"items":{"$ref":"#/components/schemas/AudienceOpportunityCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["audienceOpportunities"],"type":"object"},"CreateAudienceOpportunitiesV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedAudienceOpportunitiesSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"CreateBudgetAllocationsV1RequestContent":{"properties":{"budgetAllocations":{"items":{"$ref":"#/components/schemas/BudgetAllocationCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateBudgetAllocationsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedBudgetAllocationSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateMarketingGoalsV1RequestContent":{"properties":{"marketingGoals":{"items":{"$ref":"#/components/schemas/MarketingGoalCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["marketingGoals"],"type":"object"},"CreateMarketingGoalsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMarketingGoalSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"CreateMediaPlanExportsV1RequestContent":{"properties":{"mediaPlanExports":{"items":{"$ref":"#/components/schemas/MediaPlanExportCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["mediaPlanExports"],"type":"object"},"CreateMediaPlanExportsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMediaPlanExportSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateMediaPlansV1RequestContent":{"properties":{"mediaPlans":{"items":{"$ref":"#/components/schemas/MediaPlanCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["mediaPlans"],"type":"object"},"CreateMediaPlansV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMediaPlanSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"CreatePlanningItemsV1RequestContent":{"properties":{"planningItems":{"items":{"$ref":"#/components/schemas/PlanningItemCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreatePlanningItemsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedPlanningItemSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"CreateTargetsV1RequestContent":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetCreateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"CreateTargetsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedTargetSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"CurrencyCodeV1":{"description":"The currency which will be used throughout the media plan. All monetary values, such as budgets, are assumed to be in the media plan currency denomination.","enum":["AED","AUD","BRL","CAD","EUR","GBP","INR","JPY","MXN","SAR","SEK","TRY","USD"],"type":"string"},"DeleteAudienceOpportunitiesV1RequestContent":{"properties":{"audienceOpportunities":{"items":{"$ref":"#/components/schemas/AudienceOpportunityDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["audienceOpportunities"],"type":"object"},"DeleteAudienceOpportunitiesV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedAudienceOpportunitiesSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"DeleteBudgetAllocationsV1RequestContent":{"properties":{"budgetAllocations":{"items":{"$ref":"#/components/schemas/BudgetAllocationDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteBudgetAllocationsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedBudgetAllocationSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteMarketingGoalsV1RequestContent":{"properties":{"marketingGoals":{"items":{"$ref":"#/components/schemas/MarketingGoalDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["marketingGoals"],"type":"object"},"DeleteMarketingGoalsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMarketingGoalSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"DeleteMediaPlansV1RequestContent":{"properties":{"mediaPlans":{"items":{"$ref":"#/components/schemas/MediaPlanDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["mediaPlans"],"type":"object"},"DeleteMediaPlansV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMediaPlanSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"DeletePlanningItemsV1RequestContent":{"properties":{"planningItems":{"items":{"$ref":"#/components/schemas/PlanningItemDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeletePlanningItemsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedPlanningItemSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"DeleteTargetsV1RequestContent":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetDeleteV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"DeleteTargetsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedTargetSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"DeliveryTypeV1":{"description":"The delivery type of the planning item.","enum":["GUARANTEED","NONE","NON_GUARANTEED"],"type":"string"},"DemographicInsightDetailsV1":{"oneOf":[{"properties":{"genderDemographicInsightDetails":{"$ref":"#/components/schemas/GenderDemographicInsightDetailsV1"}},"required":["genderDemographicInsightDetails"],"title":"genderDemographicInsightDetails","type":"object"},{"properties":{"incomeDemographicInsightDetails":{"$ref":"#/components/schemas/IncomeDemographicInsightDetailsV1"}},"required":["incomeDemographicInsightDetails"],"title":"incomeDemographicInsightDetails","type":"object"},{"properties":{"educationDemographicInsightDetails":{"$ref":"#/components/schemas/EducationDemographicInsightDetailsV1"}},"required":["educationDemographicInsightDetails"],"title":"educationDemographicInsightDetails","type":"object"},{"properties":{"propertyOwnershipDemographicInsightDetails":{"$ref":"#/components/schemas/PropertyOwnershipDemographicInsightDetailsV1"}},"required":["propertyOwnershipDemographicInsightDetails"],"title":"propertyOwnershipDemographicInsightDetails","type":"object"},{"properties":{"ageDemographicInsightDetails":{"$ref":"#/components/schemas/AgeDemographicInsightDetailsV1"}},"required":["ageDemographicInsightDetails"],"title":"ageDemographicInsightDetails","type":"object"},{"properties":{"childrenCountDemographicInsightDetails":{"$ref":"#/components/schemas/ChildrenCountDemographicInsightDetailsV1"}},"required":["childrenCountDemographicInsightDetails"],"title":"childrenCountDemographicInsightDetails","type":"object"},{"properties":{"childrenAgeDemographicInsightDetails":{"$ref":"#/components/schemas/ChildrenAgeDemographicInsightDetailsV1"}},"required":["childrenAgeDemographicInsightDetails"],"title":"childrenAgeDemographicInsightDetails","type":"object"}]},"DemographicInsightStateDetailsErrorTypeV1":{"description":"The type of error associated with a demographic insight processing state.","enum":["AUDIENCE_TOO_LARGE","AUDIENCE_TOO_SMALL","INVALID_TARGET","NOT_AUTHORIZED_TARGET","UNEXPECTED_ERROR"],"type":"string"},"DemographicInsightStateDetailsErrorV1":{"description":"An error that contributed to the current demographic insight processing state.","properties":{"message":{"description":"The error message.","type":"string"},"targetId":{"description":"The target associated with the error.","type":"string"},"type":{"$ref":"#/components/schemas/DemographicInsightStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"DemographicInsightStateDetailsV1":{"description":"The details associated with the demographic insight processing state.","properties":{"errors":{"description":"The current processing state errors of the demographic insight.","items":{"$ref":"#/components/schemas/DemographicInsightStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["errors"],"type":"object"},"DemographicInsightTypeV1":{"description":"The type of demographic insight.","enum":["AGE","CHILDREN_AGE","CHILDREN_COUNT","EDUCATION","GENDER","INCOME","PROPERTY_OWNERSHIP"],"type":"string"},"DemographicInsightV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"demographicInsightDetails":{"$ref":"#/components/schemas/DemographicInsightDetailsV1"},"demographicInsightId":{"description":"The ID of the resource.","type":"string"},"demographicInsightType":{"$ref":"#/components/schemas/DemographicInsightTypeV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/DemographicInsightStateDetailsV1"}},"required":["audienceOpportunityId","creationDateTime","demographicInsightDetails","demographicInsightId","demographicInsightType","mediaPlanId","state","stateDetails"],"type":"object"},"DetailPageViewForecastDataPointV1":{"properties":{"cpdpv":{"format":"double","type":"number"},"prediction":{"format":"double","type":"number"},"spend":{"format":"double","type":"number"}},"type":"object"},"DetailPageViewForecastV1":{"properties":{"availableImpressions":{"type":"integer"},"avgCpm":{"format":"double","type":"number"},"cpc":{"format":"double","type":"number"},"dataPoints":{"items":{"$ref":"#/components/schemas/DetailPageViewForecastDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"forecastId":{"type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"type":"integer"},"maxCpm":{"format":"double","type":"number"},"maxOnTargetImpressions":{"type":"integer"},"maxSpend":{"format":"double","type":"number"},"maxTotalImpressions":{"type":"integer"}},"type":"object"},"DeviceTargetV1":{"properties":{"deviceType":{"$ref":"#/components/schemas/DeviceTypeV1"},"mobileEnvironment":{"$ref":"#/components/schemas/MobileEnvironmentV1"}},"required":["deviceType"],"type":"object"},"DeviceTypeV1":{"enum":["CONNECTED_TV","DESKTOP","MOBILE"],"type":"string"},"DspContentRatingTargetV1":{"properties":{"dspContentRating":{"$ref":"#/components/schemas/DspContentRatingV1"}},"required":["dspContentRating"],"type":"object"},"DspContentRatingTypeV1":{"enum":["DSP_CONTENT_RATING"],"type":"string"},"DspContentRatingV1":{"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"},"EducationDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/EducationDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"EducationDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"education":{"$ref":"#/components/schemas/EducationV1"},"metrics":{"$ref":"#/components/schemas/MetricsV1"}},"required":["audienceId","education","metrics"],"type":"object"},"EducationV1":{"enum":["BACHELORS_DEGREE","GRADUATE_DEGREE","HIGH_SCHOOL","SOME_COLLEGE"],"type":"string"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"| 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. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |","enum":["BAD_REQUEST","CONFLICT","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ExclusiveReachForecastV1":{"properties":{"exclusiveReachPercent":{"description":"Exclusive reach percentage.","format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["exclusiveReachPercent"],"type":"object"},"ExportMediaTypeV1":{"description":"The file format for a media plan export.","enum":["CSV","EXCEL","JSON","POWERPOINT"],"type":"string"},"ExportScopeV1":{"description":"The scope of data to include in an export.","enum":["SEASONAL_BUDGET"],"type":"string"},"FilterOperatorV1":{"enum":["CONTAINS","EQUALS","IN","IS_AFTER","IS_BEFORE","NOT_CONTAIN","NOT_EQUAL","NOT_IN","SEARCH","STARTS_WITH"],"type":"string"},"FilterV1":{"description":"A filter to apply to a list operation.","properties":{"field":{"description":"The field to filter on.","type":"string"},"operator":{"$ref":"#/components/schemas/FilterOperatorV1"},"values":{"description":"The values to filter by.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"FlightConstraintTypeV1":{"description":"The type of flight constraint.","enum":["CUSTOM","EQUAL","RECOMMENDED"],"type":"string"},"FlightConstraintV1":{"properties":{"budgetPercentage":{"format":"float","maximum":100,"minimum":0,"type":"number"},"customPercentage":{"format":"float","maximum":100,"minimum":0,"type":"number"},"endDate":{"description":"The end date for the planning period.","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"},"equalDistributionPercentage":{"format":"float","maximum":100,"minimum":0,"type":"number"},"startDate":{"description":"The start date for the planning period.","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"}},"required":["budgetPercentage","endDate","startDate"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"FrequencyCapTimeUnitV1":{"description":"The time unit for the frequency cap.","enum":["DAYS","MONTHS","WEEKS"],"type":"string"},"FrequencyCapTypeV1":{"description":"The type of advertising frequency cap.","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.","type":"integer"},"timeUnit":{"$ref":"#/components/schemas/FrequencyCapTimeUnitV1"},"timeUnitCount":{"description":"The count of time units.","type":"integer"},"type":{"$ref":"#/components/schemas/FrequencyCapTypeV1"}},"type":"object"},"GenderDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/GenderDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"GenderDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"gender":{"$ref":"#/components/schemas/GenderV1"},"metrics":{"$ref":"#/components/schemas/MetricsV1"}},"required":["audienceId","gender","metrics"],"type":"object"},"GenderV1":{"enum":["BOTH","FEMALE","MALE","UNKNOWN"],"type":"string"},"GoalSettingV1":{"description":"Contains goal-related settings.","properties":{"goal":{"$ref":"#/components/schemas/GoalV1"},"kpi":{"$ref":"#/components/schemas/KpiV1"},"linearTvReachInputData":{"$ref":"#/components/schemas/LinearTvReachInputDataV1"},"seasonalFlightConstraintInputData":{"$ref":"#/components/schemas/SeasonalFlightConstraintInputDataV1"}},"required":["goal","kpi"],"type":"object"},"GoalV1":{"description":"The goal determines which stage of the marketing funnel the marketing goal is targeting.\n\n`AWARENESS` - The marketing goal is targeting customers to raise awareness of the product(s).\n\n`CONSIDERATION` - The marketing goal is targeting customers to raise consideration for buying the product(s).\n\n`CONVERSIONS` - The marketing goal is targeting customers to raise first-time buying of the product(s).\n\n`LOYALTY` - The marketing goal is targeting customers to raise repeat buying of the product(s).","enum":["AWARENESS","CONSIDERATION","CONVERSIONS","LOYALTY"],"type":"string"},"IncomeDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/IncomeDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"IncomeDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"},"range":{"$ref":"#/components/schemas/RangeV1"}},"required":["audienceId","metrics","range"],"type":"object"},"IncrementalReachMetricsV1":{"properties":{"deduplicatedReachPercent":{"format":"double","maximum":100,"minimum":0,"type":"number"},"linearTvOnlyReachPercent":{"format":"double","maximum":100,"minimum":0,"type":"number"},"overlapReachPercent":{"format":"double","maximum":100,"minimum":0,"type":"number"},"streamingTvExclusiveReachRate":{"format":"double","maximum":100,"minimum":0,"type":"number"},"streamingTvIncrementalReachRate":{"format":"double","maximum":100,"minimum":0,"type":"number"},"streamingTvOnlyReachPercent":{"format":"double","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"IncrementalReachOverLinearTvForecastV1":{"properties":{"deduplicatedReachPercent":{"description":"Total combined reach percentage across both channels.","format":"double","maximum":100,"minimum":0,"type":"number"},"linearTvOnlyReachPercent":{"description":"Linear TV only reach percentage.","format":"double","maximum":100,"minimum":0,"type":"number"},"metricsByReachType":{"$ref":"#/components/schemas/MetricsByReachTypeV1"},"overlapReachPercent":{"description":"Audience overlap percentage between STV and LTV.","format":"double","maximum":100,"minimum":0,"type":"number"},"planningItemIds":{"description":"List of planning item IDs that the incremental reach calculation is based on.","items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"streamingTvExclusiveReachRate":{"description":"The percentage of streaming TV reach that wasn\u0027t exposed to a linear TV campaign.","format":"double","maximum":100,"minimum":0,"type":"number"},"streamingTvIncrementalReachRate":{"description":"The percentage of unique households that were reached on streaming TV inventory compared to linear TV. Households that are included in linear TV reach aren\u0027t counted in streaming TV reach.","format":"double","maximum":100,"minimum":0,"type":"number"},"streamingTvOnlyReachPercent":{"description":"Streaming TV only reach percentage.","format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["deduplicatedReachPercent","linearTvOnlyReachPercent","overlapReachPercent","planningItemIds","streamingTvExclusiveReachRate","streamingTvIncrementalReachRate","streamingTvOnlyReachPercent"],"type":"object"},"IndexedAudienceOpportunitiesSuccessV1":{"properties":{"audienceOpportunity":{"$ref":"#/components/schemas/AudienceOpportunityV1"},"index":{"type":"integer"}},"required":["audienceOpportunity","index"],"type":"object"},"IndexedBudgetAllocationSuccessV1":{"properties":{"budgetAllocation":{"$ref":"#/components/schemas/BudgetAllocationV1"},"index":{"type":"integer"}},"type":"object"},"IndexedError":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":1000,"minItems":0,"type":"array"},"index":{"type":"integer"}},"type":"object"},"IndexedMarketingGoalSuccessV1":{"properties":{"index":{"type":"integer"},"marketingGoal":{"$ref":"#/components/schemas/MarketingGoalV1"}},"required":["index","marketingGoal"],"type":"object"},"IndexedMediaPlanExportSuccessV1":{"properties":{"index":{"type":"integer"},"mediaPlanExport":{"$ref":"#/components/schemas/MediaPlanExportV1"}},"type":"object"},"IndexedMediaPlanSuccessV1":{"properties":{"index":{"type":"integer"},"mediaPlan":{"$ref":"#/components/schemas/MediaPlanV1"}},"required":["index","mediaPlan"],"type":"object"},"IndexedPlanningItemSuccessV1":{"properties":{"index":{"type":"integer"},"planningItem":{"$ref":"#/components/schemas/PlanningItemV1"}},"type":"object"},"IndexedTargetSuccessV1":{"properties":{"index":{"type":"integer"},"target":{"$ref":"#/components/schemas/TargetV1"}},"required":["index","target"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InventorySourceTargetV1":{"properties":{"inventorySourceId":{"$ref":"#/components/schemas/MarketplaceStringValueV1"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceTypeV1"}},"required":["inventorySourceId","inventorySourceType"],"type":"object"},"InventorySourceTypeV1":{"enum":["AMAZON","APD","PARENT_PUBLISHER","PUBLISHER","THIRD_PARTY_EXCHANGE"],"type":"string"},"InventoryTypeV1":{"description":"The inventory type of the planning item.","enum":["AUDIO","DISPLAY","ONLINE_VIDEO","STREAMING_TV"],"type":"string"},"KeywordTargetMatchTypeV1":{"enum":["BROAD","EXACT","PHRASE"],"type":"string"},"KeywordTargetV1":{"properties":{"keyword":{"description":"The keyword text to target.","type":"string"},"matchType":{"$ref":"#/components/schemas/KeywordTargetMatchTypeV1"}},"required":["keyword","matchType"],"type":"object"},"KpiV1":{"description":"The KPI that the marketing goal is working to optimize.\n\n`REACH` - Optimize for the number of unique users exposed to the creative during its flight.\n\n`COST_PER_CLICK` - Optimize for the cost paid per click-through.\n\n`COST_PER_DETAIL_PAGE_VIEW` - Optimize for the cost to acquire a detail page view for a promoted product.\n\n`COST_PER_VIDEO_COMPLETION` - Optimize for the cost paid per video completion.\n\n`RETURN_ON_AD_SPEND` - Optimize for the return on ad spend.\n\n`LONG_TERM_SALES` - Optimize for long term sales.","enum":["COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_VIDEO_COMPLETION","LONG_TERM_SALES","REACH","RETURN_ON_AD_SPEND"],"type":"string"},"LinearTvDaypartDistributionV1":{"properties":{"linearTvDaypartId":{"$ref":"#/components/schemas/LinearTvDaypartIdV1"},"ratio":{"description":"Percentage ratio for this daypart. All ratios must sum to 100.0.","format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["linearTvDaypartId","ratio"],"type":"object"},"LinearTvDaypartIdV1":{"description":"Daypart identifiers for linear TV reach calculations.","enum":["BROADCAST_EF","BROADCAST_LF","BROADCAST_PRI","BROADCAST_WED","BROADCAST_WKD","BROADCAST_WKM","CABLE_EF","CABLE_LF","CABLE_PRI","CABLE_WED","CABLE_WKD","CABLE_WKM","SYNDICATION_ALL_DAY"],"type":"string"},"LinearTvReachForecastV1":{"properties":{"estimatedLinearTvReachPercent":{"description":"Estimated Linear TV reach percentage.","format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["estimatedLinearTvReachPercent"],"type":"object"},"LinearTvReachInputDataV1":{"properties":{"linearTvDayparts":{"description":"Distribution of GRPs across different linear TV dayparts.","items":{"$ref":"#/components/schemas/LinearTvDaypartDistributionV1"},"maxItems":13,"minItems":1,"type":"array"},"linearTvGrp":{"description":"Gross Rating Point for TV reach calculation.","maximum":5000,"minimum":1,"type":"integer"},"reachType":{"$ref":"#/components/schemas/ReachTypeV1"},"userOverrideLinearTvReachPercent":{"description":"User-provided override for estimated TV reach percentage.","format":"double","maximum":100,"minimum":0,"type":"number"}},"required":["reachType"],"type":"object"},"ListAudienceOpportunitiesV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`mediaPlanId`: `EQUALS`\n\n`audienceOpportunityLevel`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListAudienceOpportunitiesV1ResponseContent":{"properties":{"audienceOpportunities":{"items":{"$ref":"#/components/schemas/AudienceOpportunityV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["audienceOpportunities"],"type":"object"},"ListAudienceSizesV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`audienceOpportunityId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListAudienceSizesV1ResponseContent":{"properties":{"audienceSizes":{"items":{"$ref":"#/components/schemas/AudienceSizeV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["audienceSizes"],"type":"object"},"ListBehavioralInsightsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`audienceOpportunityId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`behavioralInsightType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListBehavioralInsightsV1ResponseContent":{"properties":{"behavioralInsights":{"items":{"$ref":"#/components/schemas/BehavioralInsightV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["behavioralInsights"],"type":"object"},"ListBudgetAllocationsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`planningItemId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`budgetAllocationLevel`: `EQUALS`\n\n`budgetAllocationType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListBudgetAllocationsV1ResponseContent":{"properties":{"budgetAllocations":{"items":{"$ref":"#/components/schemas/BudgetAllocationV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"type":"object"},"ListDemographicInsightsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`audienceOpportunityId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`demographicInsightType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListDemographicInsightsV1ResponseContent":{"properties":{"demographicInsights":{"items":{"$ref":"#/components/schemas/DemographicInsightV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["demographicInsights"],"type":"object"},"ListMarketingGoalsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`mediaPlanId`: `EQUALS`\n\n`goal`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListMarketingGoalsV1ResponseContent":{"properties":{"marketingGoals":{"items":{"$ref":"#/components/schemas/MarketingGoalV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["marketingGoals"],"type":"object"},"ListMediaPlansV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`name`: `CONTAINS`, `EQUALS`, `STARTS_WITH`, `NOT_CONTAIN`, `NOT_EQUAL`, `SEARCH`\n\n`state`: `CONTAINS`, `EQUALS`, `STARTS_WITH`, `NOT_CONTAIN`, `NOT_EQUAL`\n\n`countryCode`: `IN`\n\n`dspAdvertiserName`: `CONTAINS`, `EQUALS`, `STARTS_WITH`, `NOT_CONTAIN`, `NOT_EQUAL`\n\n`sponsoredAdvertiserName`: `CONTAINS`, `EQUALS`, `STARTS_WITH`, `NOT_CONTAIN`, `NOT_EQUAL`\n\n`creationDateTime`: `IS_BEFORE`, `IS_AFTER`, `EQUALS`\n\n`isDraft`: `EQUALS`, `NOT_EQUAL`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListMediaPlansV1ResponseContent":{"properties":{"mediaPlans":{"description":"The media plans which satisfy the filtering criteria and pagination control parameters.","items":{"$ref":"#/components/schemas/MediaPlanV1"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["mediaPlans"],"type":"object"},"ListPerformanceForecastsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`planningItemId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`performanceForecastType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListPerformanceForecastsV1ResponseContent":{"properties":{"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"performanceForecasts":{"items":{"$ref":"#/components/schemas/PerformanceForecastV1"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"type":"object"},"ListPlanningItemsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`planningItemType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListPlanningItemsV1ResponseContent":{"properties":{"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"planningItems":{"items":{"$ref":"#/components/schemas/PlanningItemV1"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"type":"object"},"ListTargetsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`audienceOpportunityId`: `EQUALS`\n\n`planningItemId`: `EQUALS`\n\n`marketingGoalId`: `EQUALS`\n\n`mediaPlanId`: `EQUALS`\n\n`targetLevel`: `EQUALS`\n\n`targetType`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListTargetsV1ResponseContent":{"properties":{"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"targets":{"items":{"$ref":"#/components/schemas/TargetV1"},"maxItems":1000,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"}},"required":["targets"],"type":"object"},"ListTrafficInsightsV1RequestContent":{"properties":{"filters":{"description":"Supported Filters - format: `\u003cfield\u003e`: `\u003coperator1\u003e`, `\u003coperator2\u003e`, ...\n\n`mediaPlanId`: `EQUALS`\n\n`trafficInsightType`: `EQUALS`\n\n`timeUnit`: `EQUALS`","items":{"$ref":"#/components/schemas/FilterV1"},"maxItems":50,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of records to include in the paginated response.","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListTrafficInsightsV1ResponseContent":{"properties":{"nextToken":{"description":"A token that can be used in a subsequent call to get the next page of data in the collection, if more results are available.","type":"string"},"totalResults":{"description":"The total number of results which satisfy the filtering criteria.","type":"integer"},"trafficInsights":{"items":{"$ref":"#/components/schemas/TrafficInsightV1"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"LocationTargetV1":{"properties":{"geoLocation":{"description":"The unique identifier for the location.","type":"string"}},"required":["geoLocation"],"type":"object"},"LongTermSalesForecastDataPointV1":{"properties":{"prediction":{"format":"double","type":"number"},"spend":{"format":"double","type":"number"}},"type":"object"},"LongTermSalesForecastV1":{"properties":{"availableImpressions":{"type":"integer"},"avgCpm":{"format":"double","type":"number"},"cpc":{"format":"double","type":"number"},"dataPoints":{"items":{"$ref":"#/components/schemas/LongTermSalesForecastDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"forecastId":{"type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"type":"integer"},"maxCpm":{"format":"double","type":"number"},"maxOnTargetImpressions":{"type":"integer"},"maxSpend":{"format":"double","type":"number"},"maxTotalImpressions":{"type":"integer"}},"type":"object"},"MarketingGoalCreateV1":{"properties":{"goalSetting":{"$ref":"#/components/schemas/GoalSettingV1"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MarketingGoalProcessingOptionsV1"},"untargeted":{"description":"This determines whether marketing goal should have targets.","type":"boolean"}},"required":["goalSetting","mediaPlanId","mediaPlanVersionId"],"type":"object"},"MarketingGoalDeleteV1":{"properties":{"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["marketingGoalId","mediaPlanVersionId"],"type":"object"},"MarketingGoalProcessingOptionsV1":{"properties":{"skipIncrementalReachOverLinearTv":{"description":"Whether to skip incremental reach analysis for this marketing goal. Only applicable to AWARENESS goals.","type":"boolean"},"skipLinearTvReach":{"description":"Whether to skip Linear TV reach for this marketing goal. Only applicable to AWARENESS goals.","type":"boolean"},"skipSeasonalBudgetsCompleteTv":{"description":"Whether to skip seasonal budgets for this marketing goal. Only applicable to AWARENESS goals.","type":"boolean"}},"required":["skipIncrementalReachOverLinearTv","skipLinearTvReach"],"type":"object"},"MarketingGoalStateDetailsErrorTypeV1":{"description":"The type of error associated with a marketing goal processing state.","enum":["UNEXPECTED_ERROR"],"type":"string"},"MarketingGoalStateDetailsErrorV1":{"description":"An error that contributed to the current marketing goal processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/MarketingGoalStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"MarketingGoalStateDetailsV1":{"properties":{"errors":{"description":"The current state errors of the marketing goal.","items":{"$ref":"#/components/schemas/MarketingGoalStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"},"isIncrementalReachOverLinearTvComplete":{"description":"Indicates if incremental reach calculation is complete. Only used when marketing goal is updated with Linear TV input data.","type":"boolean"},"isLinearTvReachComplete":{"description":"Indicates if linear TV reach calculation is complete. Only used when marketing goal is updated with Linear TV input data.","type":"boolean"}},"required":["errors"],"type":"object"},"MarketingGoalUpdateV1":{"properties":{"goalSetting":{"$ref":"#/components/schemas/GoalSettingV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MarketingGoalProcessingOptionsV1"},"untargeted":{"description":"This determines whether marketing goal should have targets.","type":"boolean"}},"required":["goalSetting","marketingGoalId","mediaPlanVersionId"],"type":"object"},"MarketingGoalV1":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"deduplicatedReach":{"description":"The total audience size which can be reached by the marketing goal.","format":"int64","type":"integer"},"goalSetting":{"$ref":"#/components/schemas/GoalSettingV1"},"longTermSales":{"description":"The rolled-up Long-Term Sales (LTS) value for the marketing goal: the sum of the LTS values of its enabled planning items.","type":"integer"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MarketingGoalProcessingOptionsV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/MarketingGoalStateDetailsV1"},"untargeted":{"description":"This determines whether marketing goal should have targets.","type":"boolean"}},"required":["creationDateTime","goalSetting","marketingGoalId","mediaPlanId","state","stateDetails"],"type":"object"},"MarketplaceStringValueV1":{"properties":{"defaultValue":{"type":"string"}},"required":["defaultValue"],"type":"object"},"MediaPlanAutoCreationSettingsV1":{"properties":{"autoCreateSubResources":{"type":"boolean"}},"required":["autoCreateSubResources"],"type":"object"},"MediaPlanConflictBehaviorV1":{"description":"How the service resolves the write when the destination media plan has changed since the client\u0027s basis for it.\n\n`REJECT` - The request fails with a conflict error if the destination media plan has concurrent edits; nothing is written. On failure, re-read the media plan and re-apply the edits, or resubmit with OVERWRITE.\n\n`OVERWRITE` - The write always succeeds over concurrent edits (last write wins); version conflict checks are skipped.","enum":["OVERWRITE","REJECT"],"type":"string"},"MediaPlanCreateCopyMediaPlanV1":{"properties":{"autoCreationSettings":{"$ref":"#/components/schemas/MediaPlanAutoCreationSettingsV1"},"copyFromMediaPlanId":{"description":"The ID of the resource.","type":"string"},"isDraft":{"description":"Indicates whether or not the media plan is a draft. Draft media plans are automatically deleted after a few days.","type":"boolean"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["autoCreationSettings","copyFromMediaPlanId","versionId"],"type":"object"},"MediaPlanCreateCreateMediaPlanV1":{"properties":{"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised.","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"agreementId":{"description":"The identifier of the direct advertiser agreement linked to this media plan. Internal only, static after creation.","type":"string"},"brandIds":{"description":"Brands associated with the media plan.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"crossBorderTag":{"description":"TEMPORARY: The cross-border routing tag (CN2US, CN2EU5, CN2CA, or CN2JP) for an agreement builder plan, read from the deeplink query params and stored here as an interim solution. Long term this will be fetched on demand from the AgreementBuilder team\u0027s API, after which reading it from the deeplink and persisting it will no longer be needed. Internal only, static after creation.","type":"string"},"dspAdvertiserId":{"description":"The identifier of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspProspection":{"type":"boolean"},"endDate":{"description":"The end date for the planning period.","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"},"initialBudget":{"type":"integer"},"isDraft":{"description":"Indicates whether or not the media plan is a draft. Draft media plans are automatically deleted after a few days.","type":"boolean"},"name":{"description":"The name of the media plan. This value is user-provided and only intended to help differentiate media plans.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MediaPlanProcessingOptionsV1"},"productLocation":{"$ref":"#/components/schemas/ProductLocationV1"},"spendingTier":{"description":"TEMPORARY: The spending tier (Core, Elevated, or Advanced) for an agreement builder plan, read from the deeplink query params and stored here as an interim solution. Long term this will be fetched on demand from the AgreementBuilder team\u0027s API, after which reading it from the deeplink and persisting it will no longer be needed. Internal only, static after creation.","type":"string"},"sponsoredAdvertiserId":{"description":"The identifier of the Sponsored advertiser account associated with the media plan.","type":"string"},"startDate":{"description":"The start date for the planning period.","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"},"template":{"$ref":"#/components/schemas/MediaPlanTemplateV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalV1"}},"required":["countryCode","endDate","name","productLocation","startDate","template"],"type":"object"},"MediaPlanCreateDetailsV1":{"oneOf":[{"properties":{"createMediaPlan":{"$ref":"#/components/schemas/MediaPlanCreateCreateMediaPlanV1"}},"required":["createMediaPlan"],"title":"createMediaPlan","type":"object"},{"properties":{"copyMediaPlan":{"$ref":"#/components/schemas/MediaPlanCreateCopyMediaPlanV1"}},"required":["copyMediaPlan"],"title":"copyMediaPlan","type":"object"}]},"MediaPlanCreateTypeV1":{"enum":["COPY","CREATE"],"type":"string"},"MediaPlanCreateV1":{"properties":{"mediaPlanCreateDetails":{"$ref":"#/components/schemas/MediaPlanCreateDetailsV1"},"mediaPlanCreateType":{"$ref":"#/components/schemas/MediaPlanCreateTypeV1"}},"required":["mediaPlanCreateDetails","mediaPlanCreateType"],"type":"object"},"MediaPlanDeleteV1":{"properties":{"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["mediaPlanId"],"type":"object"},"MediaPlanExportCreateV1":{"properties":{"advertisingLocale":{"$ref":"#/components/schemas/AdvertisingLocaleV1"},"exportScope":{"$ref":"#/components/schemas/ExportScopeV1"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"deprecated":true,"description":"This shape is deprecated since 02/04/2026: Read operations no longer require version id. Latest version will be fetched automatically","type":"string"},"mediaType":{"$ref":"#/components/schemas/ExportMediaTypeV1"}},"required":["advertisingLocale","mediaPlanId","mediaType"],"type":"object"},"MediaPlanExportV1":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"fileUrl":{"description":"The URL for the file, generated as an AWS S3 presigned URL.","type":"string"},"mediaPlanExportId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"mediaType":{"$ref":"#/components/schemas/ExportMediaTypeV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"}},"type":"object"},"MediaPlanProcessingOptionsV1":{"description":"Contains options for processing the media plan.","properties":{"refreshReachCurves":{"description":"Indicates whether or not to refresh the forecast data associated with the media plan and the resources contained within it.","type":"boolean"},"skipProcessingSystemBudgetAllocations":{"description":"Indicates whether or not to skip processing system budget allocations.","type":"boolean"}},"required":["refreshReachCurves","skipProcessingSystemBudgetAllocations"],"type":"object"},"MediaPlanStateDetailsErrorTypeV1":{"description":"The type of error associated with a media plan processing state.","enum":["UNEXPECTED_ERROR"],"type":"string"},"MediaPlanStateDetailsErrorV1":{"description":"An error that contributed to the current media plan processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/MediaPlanStateDetailsErrorTypeV1"}},"required":["message","type"],"type":"object"},"MediaPlanStateDetailsV1":{"description":"The details associated with the media plan processing state.","properties":{"errors":{"description":"The current processing state errors of the media plan.","items":{"$ref":"#/components/schemas/MediaPlanStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["errors"],"type":"object"},"MediaPlanTemplateV1":{"description":"The template field indicates whether the media plan covers all marketing goals, complete TV marketing, or is specific to just the awareness marketing goal.","enum":["ALL_MARKETING_GOALS","AWARENESS_ONLY","COMPLETE_TV"],"type":"string"},"MediaPlanUpdateDetailsV1":{"oneOf":[{"properties":{"updateMediaPlan":{"$ref":"#/components/schemas/MediaPlanUpdateUpdateMediaPlanV1"}},"required":["updateMediaPlan"],"title":"updateMediaPlan","type":"object"},{"properties":{"replaceMediaPlan":{"$ref":"#/components/schemas/MediaPlanUpdateReplaceMediaPlanV1"}},"required":["replaceMediaPlan"],"title":"replaceMediaPlan","type":"object"}]},"MediaPlanUpdateReplaceMediaPlanV1":{"properties":{"autoCreationSettings":{"$ref":"#/components/schemas/MediaPlanAutoCreationSettingsV1"},"conflictBehavior":{"$ref":"#/components/schemas/MediaPlanConflictBehaviorV1"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"replaceFromMediaPlanId":{"description":"The ID of the resource.","type":"string"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["autoCreationSettings","mediaPlanId","replaceFromMediaPlanId","versionId"],"type":"object"},"MediaPlanUpdateTypeV1":{"enum":["REPLACE","UPDATE"],"type":"string"},"MediaPlanUpdateUpdateMediaPlanV1":{"properties":{"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised.","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"brandIds":{"description":"Brands associated with the media plan.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"dspAdvertiserId":{"description":"The identifier of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspProspection":{"type":"boolean"},"endDate":{"description":"The end date for the planning period.","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"},"initialBudget":{"type":"integer"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"name":{"description":"The name of the media plan. This value is user-provided and only intended to help differentiate media plans.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MediaPlanProcessingOptionsV1"},"productLocation":{"$ref":"#/components/schemas/ProductLocationV1"},"sponsoredAdvertiserId":{"description":"The identifier of the Sponsored advertiser account associated with the media plan.","type":"string"},"startDate":{"description":"The start date for the planning period.","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"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"template":{"$ref":"#/components/schemas/MediaPlanTemplateV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalV1"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["mediaPlanId","versionId"],"type":"object"},"MediaPlanUpdateV1":{"properties":{"mediaPlanUpdateDetails":{"$ref":"#/components/schemas/MediaPlanUpdateDetailsV1"},"mediaPlanUpdateType":{"$ref":"#/components/schemas/MediaPlanUpdateTypeV1"}},"required":["mediaPlanUpdateDetails","mediaPlanUpdateType"],"type":"object"},"MediaPlanV1":{"properties":{"activationState":{"$ref":"#/components/schemas/ActivationStateV1"},"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised.","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"aggregateSovYoY":{"description":"Plan-level aggregate Share of Voice year-over-year percentage. Same scaling as the per-variant values. Null when SoV has not yet been computed.","type":"integer"},"brandIds":{"description":"Brands associated with the media plan.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeV1"},"dspAdvertiserId":{"description":"The identifier of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspAdvertiserName":{"description":"The name of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspProspection":{"type":"boolean"},"endDate":{"description":"The end date for the planning period.","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"},"initialBudget":{"type":"integer"},"isDraft":{"description":"Indicates whether or not the media plan is a draft. Draft media plans are automatically deleted after a few days.","type":"boolean"},"longTermSales":{"description":"The rolled-up Long-Term Sales (LTS) value for the media plan: the sum of the LTS values of its marketing goals.","type":"integer"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"name":{"description":"The name of the media plan. This value is user-provided and only intended to help differentiate media plans.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MediaPlanProcessingOptionsV1"},"productLocation":{"$ref":"#/components/schemas/ProductLocationV1"},"sourceMediaPlanId":{"description":"The ID of the resource.","type":"string"},"sovYoYByAdProduct":{"$ref":"#/components/schemas/SovAdProductYoYMapV1"},"sponsoredAdvertiserId":{"description":"The identifier of the Sponsored advertiser account associated with the media plan.","type":"string"},"sponsoredAdvertiserName":{"description":"The name of the Sponsored advertiser account associated with the media plan.","type":"string"},"startDate":{"description":"The start date for the planning period.","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"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/MediaPlanStateDetailsV1"},"template":{"$ref":"#/components/schemas/MediaPlanTemplateV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalV1"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["advertisedProductCategoryIds","countryCode","creationDateTime","currencyCode","endDate","isDraft","mediaPlanId","name","processingOptions","productLocation","startDate","state","stateDetails","template","userLocationSignal"],"type":"object"},"MetricsByReachTypeV1":{"additionalProperties":{"$ref":"#/components/schemas/IncrementalReachMetricsV1"},"type":"object"},"MetricsV1":{"description":"Metrics associated with audience insights.","properties":{"affinity":{"description":"The affinity score between audiences.","format":"double","type":"number"},"overlapPercentage":{"description":"The overlap percentage between audiences.","format":"double","type":"number"}},"type":"object"},"MobileEnvironmentV1":{"enum":["APP","WEB"],"type":"string"},"MultiFormatReachUpliftForecastV1":{"properties":{"upliftPercent":{"description":"The de-duplicated reach uplift from adding all missing formats at the existing awareness budget.","format":"double","minimum":0,"type":"number"}},"required":["upliftPercent"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"OptimizedBudgetAllocationDetailsV1":{"properties":{"allocatedBudget":{"description":"The budget allocated by user. Applicable for `MEDIA_PLAN`, `MARKETING_GOAL` and `PLANNING_ITEM` budget allocation levels.","type":"integer"},"budgetMaximum":{"format":"double","type":"number"},"budgetMaximumStrategy":{"$ref":"#/components/schemas/BudgetMaximumStrategyV1"},"budgetMinimum":{"format":"double","type":"number"},"budgetMinimumStrategy":{"$ref":"#/components/schemas/BudgetMinimumStrategyV1"},"historicBudgetAllocation":{"format":"double","type":"number"},"optimizedBudget":{"description":"The budget optimized by Amazon. Applicable only for `PLANNING_ITEM` level.","type":"integer"}},"required":["allocatedBudget"],"type":"object"},"PerformanceForecastDetailsV1":{"oneOf":[{"properties":{"reachForecast":{"$ref":"#/components/schemas/ReachForecastV1"}},"required":["reachForecast"],"title":"reachForecast","type":"object"},{"properties":{"clickForecast":{"$ref":"#/components/schemas/ClickForecastV1"}},"required":["clickForecast"],"title":"clickForecast","type":"object"},{"properties":{"videoCompletionForecast":{"$ref":"#/components/schemas/VideoCompletionForecastV1"}},"required":["videoCompletionForecast"],"title":"videoCompletionForecast","type":"object"},{"properties":{"detailPageViewForecast":{"$ref":"#/components/schemas/DetailPageViewForecastV1"}},"required":["detailPageViewForecast"],"title":"detailPageViewForecast","type":"object"},{"properties":{"linearTvReachForecast":{"$ref":"#/components/schemas/LinearTvReachForecastV1"}},"required":["linearTvReachForecast"],"title":"linearTvReachForecast","type":"object"},{"properties":{"incrementalReachOverLinearTvForecast":{"$ref":"#/components/schemas/IncrementalReachOverLinearTvForecastV1"}},"required":["incrementalReachOverLinearTvForecast"],"title":"incrementalReachOverLinearTvForecast","type":"object"},{"properties":{"exclusiveReachForecast":{"$ref":"#/components/schemas/ExclusiveReachForecastV1"}},"required":["exclusiveReachForecast"],"title":"exclusiveReachForecast","type":"object"},{"properties":{"publisherIncrementalReachForecast":{"$ref":"#/components/schemas/PublisherIncrementalReachForecastV1"}},"required":["publisherIncrementalReachForecast"],"title":"publisherIncrementalReachForecast","type":"object"},{"properties":{"longTermSalesForecast":{"$ref":"#/components/schemas/LongTermSalesForecastV1"}},"required":["longTermSalesForecast"],"title":"longTermSalesForecast","type":"object"},{"properties":{"multiFormatReachUpliftForecast":{"$ref":"#/components/schemas/MultiFormatReachUpliftForecastV1"}},"required":["multiFormatReachUpliftForecast"],"title":"multiFormatReachUpliftForecast","type":"object"}]},"PerformanceForecastLevelV1":{"description":"The hierarchy level of the performance forecast.","enum":["MARKETING_GOAL","PLANNING_ITEM"],"type":"string"},"PerformanceForecastStateDetailsErrorTypeV1":{"description":"The type of error associated with a performance forecast processing state.","enum":["AUDIENCE_TOO_SMALL","MAX_CPC_IS_TOO_SMALL","TARGETING_TOO_NARROW","UNEXPECTED_ERROR"],"type":"string"},"PerformanceForecastStateDetailsErrorV1":{"description":"An error that contributed to the current performance forecast processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/PerformanceForecastStateDetailsErrorTypeV1"}},"type":"object"},"PerformanceForecastStateDetailsV1":{"description":"The details associated with the performance forecast processing state.","properties":{"errors":{"description":"The current processing state errors of the performance forecast.","items":{"$ref":"#/components/schemas/PerformanceForecastStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"PerformanceForecastTypeV1":{"description":"The type of performance forecast.","enum":["CLICK","DETAIL_PAGE_VIEW","EXCLUSIVE_REACH","INCREMENTAL_REACH_OVER_LINEAR_TV","LINEAR_TV_REACH","LONG_TERM_SALES","MULTI_FORMAT_REACH_UPLIFT","PUBLISHER_INCREMENTAL_REACH","REACH","VIDEO_COMPLETION"],"type":"string"},"PerformanceForecastV1":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"performanceForecastDetails":{"$ref":"#/components/schemas/PerformanceForecastDetailsV1"},"performanceForecastDetailsList":{"items":{"$ref":"#/components/schemas/PerformanceForecastDetailsV1"},"maxItems":6,"minItems":1,"type":"array"},"performanceForecastId":{"description":"The ID of the resource.","type":"string"},"performanceForecastLevel":{"$ref":"#/components/schemas/PerformanceForecastLevelV1"},"performanceForecastType":{"$ref":"#/components/schemas/PerformanceForecastTypeV1"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/PerformanceForecastStateDetailsV1"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"}},"type":"object"},"PerformanceMetricScopeV1":{"description":"The scope of the performance metric.","enum":["ADVERTISER","CROSS_ADVERTISER","NONE","PRODUCT"],"type":"string"},"PerformanceMetricTypeV1":{"description":"The type of performance metric.","enum":["MEDIAN_CPC","MEDIAN_CTR","MEDIAN_DPVR","MEDIAN_ECPM","MEDIAN_ROAS","TOTAL_COST","TOTAL_ROAS","TOTAL_SALES","VIDEO_COMPLETION_RATE"],"type":"string"},"PerformanceMetricV1":{"description":"A forecasted performance metric for the planning item.","properties":{"scope":{"$ref":"#/components/schemas/PerformanceMetricScopeV1"},"type":{"$ref":"#/components/schemas/PerformanceMetricTypeV1"},"value":{"description":"The forecasted value of the performance metric.","format":"float","type":"number"}},"type":"object"},"PlanningItemCreateV1":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProductV1"},"adType":{"$ref":"#/components/schemas/AdTypeV1"},"enabled":{"description":"This determines whether the planning item is enabled, or toggled to active.","type":"boolean"},"forecastSettings":{"$ref":"#/components/schemas/PlanningItemForecastSettingsV1"},"hidden":{"description":"This determines whether the planning item should be displayed.","type":"boolean"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypeV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"parentPlanningItemId":{"description":"The ID of the resource.","type":"string"},"planningItemLevel":{"$ref":"#/components/schemas/PlanningItemLevelV1"},"planningItemType":{"$ref":"#/components/schemas/PlanningItemTypeV1"}},"required":["marketingGoalId","mediaPlanVersionId","planningItemLevel","planningItemType"],"type":"object"},"PlanningItemDeleteV1":{"properties":{"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"planningItemId":{"description":"The ID of the resource.","type":"string"}},"required":["mediaPlanVersionId","planningItemId"],"type":"object"},"PlanningItemForecastSettingsV1":{"description":"A collection of settings for forecasting the planning item.","properties":{"averageCpm":{"description":"The average CPM specified for the planning item. Only applicable when `deliveryType` is `NON_GUARANTEED`.","format":"float","type":"number"},"cpm":{"description":"The CPM specified for the planning item. Only applicable when `deliveryType` is `GUARANTEED`.","format":"float","type":"number"},"deliveryType":{"$ref":"#/components/schemas/DeliveryTypeV1"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"maxAverageCpm":{"description":"The max average CPM specified for the planning item. Only applicable when `deliveryType` is `NON_GUARANTEED`.","format":"float","type":"number"},"maxCpc":{"description":"The max CPC specified for the planning item. Only applicable when targeting Sponsored Products, Sponsored Brands or Sponsored Brands Video.","format":"float","type":"number"},"maxVCpm":{"description":"The max viewable CPM specified for the planning item. Only applicable when targeting Sponsored Display.","format":"float","type":"number"},"selectedPerformanceForecastKpi":{"$ref":"#/components/schemas/KpiV1"},"supplyPackage":{"description":"Optionally defined array of supply.","items":{"$ref":"#/components/schemas/SupplyV1"},"maxItems":10,"minItems":0,"type":"array"}},"required":["deliveryType","frequencyCap"],"type":"object"},"PlanningItemLevelV1":{"description":"The hierarchical level of the planning item.","enum":["MARKETING_GOAL","PLANNING_ITEM"],"type":"string"},"PlanningItemStateDetailsErrorTypeV1":{"description":"The type of error associated with a planning item processing state.","enum":["UNEXPECTED_ERROR"],"type":"string"},"PlanningItemStateDetailsErrorV1":{"description":"An error that contributed to the current planning item processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/PlanningItemStateDetailsErrorTypeV1"}},"type":"object"},"PlanningItemStateDetailsV1":{"description":"The details associated with the planning item processing state.","properties":{"errors":{"description":"The current processing state errors of the planning item.","items":{"$ref":"#/components/schemas/PlanningItemStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"PlanningItemTypeV1":{"description":"The type of the planning item.","enum":["DSP_AUDIO","DSP_DISPLAY","DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY","DSP_OLV","DSP_PRIME_VIDEO","DSP_PRIME_VIDEO_WATCH_FOR_FREE","DSP_STREAMING_TV","DSP_TWITCH","DSP_TWITCH_DISPLAY","DSP_TWITCH_VIDEO","PARENT_PUBLISHER","PARENT_SUPPLY","PUBLISHER","SPONSORED_BRANDS","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SUPPLY"],"type":"string"},"PlanningItemUpdateV1":{"properties":{"enabled":{"description":"This determines whether the planning item is enabled, or toggled to active.","type":"boolean"},"forecastSettings":{"$ref":"#/components/schemas/PlanningItemForecastSettingsV1"},"hidden":{"description":"This determines whether the planning item should be displayed.","type":"boolean"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"planningItemId":{"description":"The ID of the resource.","type":"string"}},"required":["mediaPlanVersionId","planningItemId"],"type":"object"},"PlanningItemV1":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProductV1"},"adType":{"$ref":"#/components/schemas/AdTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"deduplicatedReach":{"description":"The total audience size which can be reached by the planning item.","type":"integer"},"enabled":{"description":"This determines whether the planning item is enabled, or toggled to active.","type":"boolean"},"forecastSettings":{"$ref":"#/components/schemas/PlanningItemForecastSettingsV1"},"hidden":{"description":"This determines whether the planning item should be displayed.","type":"boolean"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypeV1"},"longTermSales":{"type":"integer"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"name":{"description":"The name of the planning item. This value is user-provided and only intended to help differentiate planning items.","type":"string"},"parentPlanningItemId":{"description":"The ID of the resource.","type":"string"},"performanceMetrics":{"items":{"$ref":"#/components/schemas/PerformanceMetricV1"},"maxItems":50,"minItems":0,"type":"array"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"planningItemLevel":{"$ref":"#/components/schemas/PlanningItemLevelV1"},"planningItemType":{"$ref":"#/components/schemas/PlanningItemTypeV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/PlanningItemStateDetailsV1"}},"type":"object"},"PrimeVideoBehavioralInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/PrimeVideoBehavioralInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"PrimeVideoBehavioralInsightV1":{"properties":{"metrics":{"$ref":"#/components/schemas/MetricsV1"},"name":{"type":"string"},"primeVideoInterest":{"$ref":"#/components/schemas/PrimeVideoInterestV1"}},"required":["metrics","name","primeVideoInterest"],"type":"object"},"PrimeVideoInterestV1":{"enum":["ACTORS","DIRECTORS","GENRES","MOVIES","SERIES"],"type":"string"},"ProductCategoryBehavioralInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/ProductCategoryBehavioralInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"ProductCategoryBehavioralInsightV1":{"properties":{"metrics":{"$ref":"#/components/schemas/MetricsV1"},"productCategoryId":{"type":"string"}},"required":["metrics","productCategoryId"],"type":"object"},"ProductCategoryTargetV1":{"properties":{"asinCategory":{"description":"The product category to target.","type":"string"}},"required":["asinCategory"],"type":"object"},"ProductLocationV1":{"description":"The location of the products being advertised as part of the media plan.","enum":["NOT_SOLD_ON_AMAZON","SOLD_ON_AMAZON"],"type":"string"},"ProductTargetMatchTypeV1":{"enum":["PRODUCT_EXACT"],"type":"string"},"ProductTargetV1":{"properties":{"asin":{"description":"The product asin to target.","type":"string"},"matchType":{"$ref":"#/components/schemas/ProductTargetMatchTypeV1"}},"required":["asin","matchType"],"type":"object"},"PropertyOwnershipDemographicInsightDetailsV1":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/PropertyOwnershipDemographicInsightV1"},"maxItems":50,"minItems":0,"type":"array"}},"required":["insights"],"type":"object"},"PropertyOwnershipDemographicInsightV1":{"properties":{"audienceId":{"type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsV1"},"propertyOwnership":{"$ref":"#/components/schemas/PropertyOwnershipV1"}},"required":["audienceId","metrics","propertyOwnership"],"type":"object"},"PropertyOwnershipV1":{"enum":["OWNING","RENTING"],"type":"string"},"PublisherIncrementalReachForecastV1":{"properties":{"incrementalReach":{"description":"The incremental de-duplicated users gained by adding this publisher to the plan in priority order.","minimum":0,"type":"integer"}},"type":"object"},"RangeV1":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"ReachForecastDataPointV1":{"description":"Represents a data point on the reach curve.","properties":{"impressions":{"description":"The number of on-target impressions.","type":"integer"},"internalSeasonalBudgetDeDupedReach":{"type":"integer"},"reach":{"description":"The forecasted on-target reach.","type":"integer"},"reachPercent":{"description":"The forecasted on-target reach percentage.","format":"double","type":"number"},"spend":{"description":"The forecasted spend in requested currency.","format":"double","type":"number"}},"type":"object"},"ReachForecastV1":{"properties":{"availableImpressions":{"type":"integer"},"avgCpm":{"format":"double","type":"number"},"cpc":{"format":"double","type":"number"},"dataPoints":{"items":{"$ref":"#/components/schemas/ReachForecastDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"endDate":{"type":"string"},"forecastId":{"type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"type":"integer"},"maxCpm":{"format":"double","type":"number"},"maxOnTargetImpressions":{"type":"integer"},"maxSpend":{"format":"double","type":"number"},"maxTotalImpressions":{"type":"integer"},"startDate":{"type":"string"}},"type":"object"},"ReachTypeV1":{"description":"Reach type for TV calculations.","enum":["HOUSEHOLD","INDIVIDUAL"],"type":"string"},"ReadAudienceOpportunityV1ResponseContent":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"audienceOpportunityLevel":{"$ref":"#/components/schemas/AudienceOpportunityLevelV1"},"audienceOpportunityType":{"$ref":"#/components/schemas/AudienceOpportunityTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/AudienceOpportunitiesStateDetailsV1"}},"required":["audienceOpportunityId","audienceOpportunityLevel","audienceOpportunityType","creationDateTime","mediaPlanId","state","stateDetails"],"type":"object"},"ReadAudienceSizeV1ResponseContent":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"audienceSizeId":{"description":"The ID of the resource.","type":"string"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"max":{"description":"The upper bound of estimated unique customers who are in the audience.","type":"integer"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"min":{"description":"The lower bound of estimated unique customers who are in the audience.","type":"integer"},"period":{"$ref":"#/components/schemas/AudienceSizePeriodV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/AudienceSizeStateDetailsV1"}},"required":["audienceOpportunityId","audienceSizeId","creationDateTime","mediaPlanId","period","state","stateDetails"],"type":"object"},"ReadBehavioralInsightV1ResponseContent":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"behavioralInsightDetails":{"$ref":"#/components/schemas/BehavioralInsightDetailsV1"},"behavioralInsightId":{"description":"The ID of the resource.","type":"string"},"behavioralInsightType":{"$ref":"#/components/schemas/BehavioralInsightTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/BehavioralInsightStateDetailsV1"}},"required":["audienceOpportunityId","behavioralInsightDetails","behavioralInsightId","behavioralInsightType","creationDateTime","mediaPlanId","state","stateDetails"],"type":"object"},"ReadBudgetAllocationV1ResponseContent":{"properties":{"allocatedBudget":{"description":"The budget allocated by user. Applicable for `MEDIA_PLAN`, `MARKETING_GOAL` and `PLANNING_ITEM` budget allocation levels.","type":"integer"},"budgetAllocationDetails":{"$ref":"#/components/schemas/BudgetAllocationDetailsV1"},"budgetAllocationId":{"description":"The ID of the resource.","type":"string"},"budgetAllocationLevel":{"$ref":"#/components/schemas/BudgetAllocationLevelV1"},"budgetAllocationType":{"$ref":"#/components/schemas/BudgetAllocationTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"optimizedBudget":{"description":"The budget optimized by Amazon. Applicable only for `PLANNING_ITEM` level.","type":"integer"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/BudgetAllocationStateDetailsV1"}},"type":"object"},"ReadDemographicInsightV1ResponseContent":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"demographicInsightDetails":{"$ref":"#/components/schemas/DemographicInsightDetailsV1"},"demographicInsightId":{"description":"The ID of the resource.","type":"string"},"demographicInsightType":{"$ref":"#/components/schemas/DemographicInsightTypeV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/DemographicInsightStateDetailsV1"}},"required":["audienceOpportunityId","creationDateTime","demographicInsightDetails","demographicInsightId","demographicInsightType","mediaPlanId","state","stateDetails"],"type":"object"},"ReadMarketingGoalV1ResponseContent":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"deduplicatedReach":{"description":"The total audience size which can be reached by the marketing goal.","format":"int64","type":"integer"},"goalSetting":{"$ref":"#/components/schemas/GoalSettingV1"},"longTermSales":{"description":"The rolled-up Long-Term Sales (LTS) value for the marketing goal: the sum of the LTS values of its enabled planning items.","type":"integer"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MarketingGoalProcessingOptionsV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/MarketingGoalStateDetailsV1"},"untargeted":{"description":"This determines whether marketing goal should have targets.","type":"boolean"}},"required":["creationDateTime","goalSetting","marketingGoalId","mediaPlanId","state","stateDetails"],"type":"object"},"ReadMediaPlanV1ResponseContent":{"properties":{"activationState":{"$ref":"#/components/schemas/ActivationStateV1"},"advertisedProductCategoryIds":{"description":"We use categories to determine whether a campaign is eligible to run on a given set of inventory. These categories are used as metadata passed to ad exchanges. We recommend choosing a subcategory that best aligns with the products being advertised.","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"aggregateSovYoY":{"description":"Plan-level aggregate Share of Voice year-over-year percentage. Same scaling as the per-variant values. Null when SoV has not yet been computed.","type":"integer"},"brandIds":{"description":"Brands associated with the media plan.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"countryCode":{"$ref":"#/components/schemas/CountryCodeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCodeV1"},"dspAdvertiserId":{"description":"The identifier of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspAdvertiserName":{"description":"The name of the Amazon DSP advertiser associated with the media plan.","type":"string"},"dspProspection":{"type":"boolean"},"endDate":{"description":"The end date for the planning period.","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"},"initialBudget":{"type":"integer"},"isDraft":{"description":"Indicates whether or not the media plan is a draft. Draft media plans are automatically deleted after a few days.","type":"boolean"},"longTermSales":{"description":"The rolled-up Long-Term Sales (LTS) value for the media plan: the sum of the LTS values of its marketing goals.","type":"integer"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"name":{"description":"The name of the media plan. This value is user-provided and only intended to help differentiate media plans.","type":"string"},"processingOptions":{"$ref":"#/components/schemas/MediaPlanProcessingOptionsV1"},"productLocation":{"$ref":"#/components/schemas/ProductLocationV1"},"sourceMediaPlanId":{"description":"The ID of the resource.","type":"string"},"sovYoYByAdProduct":{"$ref":"#/components/schemas/SovAdProductYoYMapV1"},"sponsoredAdvertiserId":{"description":"The identifier of the Sponsored advertiser account associated with the media plan.","type":"string"},"sponsoredAdvertiserName":{"description":"The name of the Sponsored advertiser account associated with the media plan.","type":"string"},"startDate":{"description":"The start date for the planning period.","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"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/MediaPlanStateDetailsV1"},"template":{"$ref":"#/components/schemas/MediaPlanTemplateV1"},"userLocationSignal":{"$ref":"#/components/schemas/UserLocationSignalV1"},"versionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"}},"required":["advertisedProductCategoryIds","countryCode","creationDateTime","currencyCode","endDate","isDraft","mediaPlanId","name","processingOptions","productLocation","startDate","state","stateDetails","template","userLocationSignal"],"type":"object"},"ReadPerformanceForecastV1ResponseContent":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"performanceForecastDetails":{"$ref":"#/components/schemas/PerformanceForecastDetailsV1"},"performanceForecastDetailsList":{"items":{"$ref":"#/components/schemas/PerformanceForecastDetailsV1"},"maxItems":6,"minItems":1,"type":"array"},"performanceForecastId":{"description":"The ID of the resource.","type":"string"},"performanceForecastLevel":{"$ref":"#/components/schemas/PerformanceForecastLevelV1"},"performanceForecastType":{"$ref":"#/components/schemas/PerformanceForecastTypeV1"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/PerformanceForecastStateDetailsV1"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"}},"type":"object"},"ReadPlanningItemV1ResponseContent":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProductV1"},"adType":{"$ref":"#/components/schemas/AdTypeV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"deduplicatedReach":{"description":"The total audience size which can be reached by the planning item.","type":"integer"},"enabled":{"description":"This determines whether the planning item is enabled, or toggled to active.","type":"boolean"},"forecastSettings":{"$ref":"#/components/schemas/PlanningItemForecastSettingsV1"},"hidden":{"description":"This determines whether the planning item should be displayed.","type":"boolean"},"inventoryType":{"$ref":"#/components/schemas/InventoryTypeV1"},"longTermSales":{"type":"integer"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"name":{"description":"The name of the planning item. This value is user-provided and only intended to help differentiate planning items.","type":"string"},"parentPlanningItemId":{"description":"The ID of the resource.","type":"string"},"performanceMetrics":{"items":{"$ref":"#/components/schemas/PerformanceMetricV1"},"maxItems":50,"minItems":0,"type":"array"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"planningItemLevel":{"$ref":"#/components/schemas/PlanningItemLevelV1"},"planningItemType":{"$ref":"#/components/schemas/PlanningItemTypeV1"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/PlanningItemStateDetailsV1"}},"type":"object"},"ReadTargetV1ResponseContent":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"bid":{"$ref":"#/components/schemas/TargetBidV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"negative":{"type":"boolean"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/TargetDetailsV1"},"targetId":{"description":"The ID of the resource.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/TargetLevelV1"},"targetType":{"$ref":"#/components/schemas/TargetTypeV1"}},"required":["creationDateTime","mediaPlanId","negative","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"ReadTrafficInsightV1ResponseContent":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/TrafficInsightStateDetailsV1"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"},"trafficInsightDetails":{"$ref":"#/components/schemas/TrafficInsightDetailsV1"},"trafficInsightId":{"description":"The ID of the resource.","type":"string"},"trafficInsightLevel":{"$ref":"#/components/schemas/TrafficInsightLevelV1"},"trafficInsightTargetingType":{"$ref":"#/components/schemas/TrafficInsghtTargetingTypeV1"},"trafficInsightType":{"$ref":"#/components/schemas/TrafficInsightTypeV1"}},"required":["creationDateTime","mediaPlanId","state","stateDetails","timeUnit","trafficInsightDetails","trafficInsightId","trafficInsightLevel","trafficInsightTargetingType","trafficInsightType"],"type":"object"},"ResourceStateV1":{"description":"The current state of the resource.\n\n`NEW` - The resource is created but not processed.\n\n`PENDING` - The resource is requested to be processed.\n\n`PROCESSING` - The resource or its sub-resources are currently processing.\n\n`SUCCESS` - The resource and all of its sub-resources were processed without issues.\n\n`PARTIAL_SUCCESS` - The resource or some of its sub-resources failed to be processed.\n\n`FAILED` - The resource and all of its sub-resources failed to be processed.\n\n`TIMED_OUT` - The attempt to process the resource and its sub-resources has timed out.\n\n`UPDATED` - The settings for the resource have been updated since the last attempt to process.\n\n`DELETED` - The resource has been deleted. This is only shown on API responses for successful delete requests.","enum":["DELETED","FAILED","NEW","PARTIAL_SUCCESS","PENDING","PROCESSING","SUCCESS","TIMED_OUT","UPDATED"],"type":"string"},"SeasonalBudgetAllocationDetailsV1":{"properties":{"dataPoints":{"items":{"$ref":"#/components/schemas/SeasonalBudgetDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"seasonalBudgetTimeUnit":{"$ref":"#/components/schemas/SeasonalBudgetTimeUnitV1"}},"required":["dataPoints","seasonalBudgetTimeUnit"],"type":"object"},"SeasonalBudgetDataPointV1":{"properties":{"appliedBudget":{"type":"integer"},"budget":{"type":"integer"},"dedupedReach":{"type":"integer"},"endDate":{"description":"The end date for the planning period.","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"},"startDate":{"description":"The start date for the planning period.","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"}},"required":["budget","endDate","startDate"],"type":"object"},"SeasonalBudgetTimeUnitV1":{"description":"This is the time unit used for specifying the granularity of the flight periods within the Seasonal Budget Allocation Breakdown.","enum":["MONTH","PLANNING_PERIOD","QUARTER"],"type":"string"},"SeasonalFlightConstraintInputDataV1":{"description":"Contains seasonal flight input data for the marketing goal.","properties":{"flightConstraintType":{"$ref":"#/components/schemas/FlightConstraintTypeV1"},"flightConstraints":{"description":"List of seasonal flight constraints.","items":{"$ref":"#/components/schemas/FlightConstraintV1"},"maxItems":6,"minItems":1,"type":"array"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"}},"required":["flightConstraints","timeUnit"],"type":"object"},"ShopperTrafficForecastDataPointV1":{"properties":{"endDate":{"type":"string"},"percent":{"format":"float","maximum":100,"minimum":0,"type":"number"},"startDate":{"type":"string"}},"required":["endDate","percent","startDate"],"type":"object"},"ShopperTrafficForecastDetailsV1":{"properties":{"dataPoints":{"items":{"$ref":"#/components/schemas/ShopperTrafficForecastDataPointV1"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["dataPoints"],"type":"object"},"SovAdProductYoYMapV1":{"additionalProperties":{"type":"integer"},"description":"Per-variant Share of Voice year-over-year percentages, keyed by ad-product variant name (SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO). Raw integer percentages (e.g. 50 represents +50%).","type":"object"},"SupplyV1":{"enum":["DSP_ALEXA_DISPLAY","DSP_FIRE_TABLET","DSP_FIRE_TV","DSP_PRIME_VIDEO","DSP_STREAMING_TV","DSP_TWITCH_VIDEO"],"type":"string"},"TargetBidV1":{"properties":{"bid":{"description":"The bid for the target.","format":"float","type":"number"}},"required":["bid"],"type":"object"},"TargetCreateV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"bid":{"$ref":"#/components/schemas/TargetBidV1"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"negative":{"type":"boolean"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/TargetDetailsV1"},"targetLevel":{"$ref":"#/components/schemas/TargetLevelV1"},"targetType":{"$ref":"#/components/schemas/TargetTypeV1"}},"required":["mediaPlanId","mediaPlanVersionId","negative","targetDetails","targetLevel","targetType"],"type":"object"},"TargetDeleteV1":{"properties":{"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"targetId":{"description":"The ID of the resource.","type":"string"}},"required":["mediaPlanVersionId","targetId"],"type":"object"},"TargetDetailsV1":{"oneOf":[{"properties":{"productTarget":{"$ref":"#/components/schemas/ProductTargetV1"}},"required":["productTarget"],"title":"productTarget","type":"object"},{"properties":{"audienceTarget":{"$ref":"#/components/schemas/AudienceTargetV1"}},"required":["audienceTarget"],"title":"audienceTarget","type":"object"},{"properties":{"productCategoryTarget":{"$ref":"#/components/schemas/ProductCategoryTargetV1"}},"required":["productCategoryTarget"],"title":"productCategoryTarget","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":{"locationTarget":{"$ref":"#/components/schemas/LocationTargetV1"}},"required":["locationTarget"],"title":"locationTarget","type":"object"},{"properties":{"keywordTarget":{"$ref":"#/components/schemas/KeywordTargetV1"}},"required":["keywordTarget"],"title":"keywordTarget","type":"object"},{"properties":{"themeTarget":{"$ref":"#/components/schemas/ThemeTargetV1"}},"required":["themeTarget"],"title":"themeTarget","type":"object"},{"properties":{"inventorySourceTarget":{"$ref":"#/components/schemas/InventorySourceTargetV1"}},"required":["inventorySourceTarget"],"title":"inventorySourceTarget","type":"object"}]},"TargetLevelV1":{"description":"The hierarchy level the target is parented under.\n\n`MEDIA_PLAN` - The target is parented under a media plan specified by the `mediaPlanId`\n\n`MARKETING_GOAL` - The target is parented under a marketing goal specified by the `marketingGoalId`\n\n`PLANNING_ITEM` - The target is parented under a planning item specified by the `planningItemId`\n\n`AUDIENCE_OPPORTUNITY` - The target is parented under a audience opportunity specified by the `audienceOpportunityId`","enum":["AUDIENCE_OPPORTUNITY","MARKETING_GOAL","MEDIA_PLAN","PLANNING_ITEM"],"type":"string"},"TargetTypeV1":{"enum":["AUDIENCE","CONTENT_GENRE","CONTENT_RATING","DEVICE","INVENTORY_SOURCE","KEYWORD","LOCATION","PRODUCT","PRODUCT_CATEGORY","THEME"],"type":"string"},"TargetUpdateV1":{"properties":{"bid":{"$ref":"#/components/schemas/TargetBidV1"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"negative":{"type":"boolean"},"targetDetails":{"$ref":"#/components/schemas/TargetDetailsV1"},"targetId":{"description":"The ID of the resource.","type":"string"}},"required":["mediaPlanVersionId","targetId"],"type":"object"},"TargetV1":{"properties":{"audienceOpportunityId":{"description":"The ID of the resource.","type":"string"},"bid":{"$ref":"#/components/schemas/TargetBidV1"},"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"marketingGoalId":{"description":"The ID of the resource.","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"negative":{"type":"boolean"},"planningItemId":{"description":"The ID of the resource.","type":"string"},"targetDetails":{"$ref":"#/components/schemas/TargetDetailsV1"},"targetId":{"description":"The ID of the resource.","type":"string"},"targetLevel":{"$ref":"#/components/schemas/TargetLevelV1"},"targetType":{"$ref":"#/components/schemas/TargetTypeV1"}},"required":["creationDateTime","mediaPlanId","negative","targetDetails","targetId","targetLevel","targetType"],"type":"object"},"ThemeTargetMatchTypeV1":{"enum":["KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES"],"type":"string"},"ThemeTargetV1":{"properties":{"matchType":{"$ref":"#/components/schemas/ThemeTargetMatchTypeV1"}},"required":["matchType"],"type":"object"},"TimeUnitV1":{"description":"The time unit for planning periods.","enum":["MONTH","PLANNING_PERIOD","QUARTER","WEEK"],"type":"string"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TrafficInsghtTargetingTypeV1":{"description":"The targeting type used for the traffic insight.","enum":["MARKETING_GOAL_AUDIENCE","RETAIL_PRODUCT_CATEGORIES"],"type":"string"},"TrafficInsightDetailsV1":{"oneOf":[{"properties":{"shopperTrafficForecastDetails":{"$ref":"#/components/schemas/ShopperTrafficForecastDetailsV1"}},"required":["shopperTrafficForecastDetails"],"title":"shopperTrafficForecastDetails","type":"object"}]},"TrafficInsightLevelV1":{"description":"The hierarchy level of the traffic insight.","enum":["MEDIA_PLAN"],"type":"string"},"TrafficInsightStateDetailsErrorTypeV1":{"description":"The type of error associated with a traffic insight processing state.","enum":["UNEXPECTED_ERROR"],"type":"string"},"TrafficInsightStateDetailsErrorV1":{"description":"An error that contributed to the current traffic insight processing state.","properties":{"message":{"description":"The error message.","type":"string"},"type":{"$ref":"#/components/schemas/TrafficInsightStateDetailsErrorTypeV1"}},"type":"object"},"TrafficInsightStateDetailsV1":{"description":"The details associated with the traffic insight processing state.","properties":{"errors":{"description":"The current processing state errors of the traffic insight.","items":{"$ref":"#/components/schemas/TrafficInsightStateDetailsErrorV1"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"TrafficInsightTypeV1":{"description":"The type of traffic insight.","enum":["SHOPPER_TRAFFIC_FORECAST"],"type":"string"},"TrafficInsightV1":{"properties":{"creationDateTime":{"description":"The date and time in ISO 8601 format at which the resource was created.","format":"date-time","type":"string"},"mediaPlanId":{"description":"The ID of the resource.","type":"string"},"mediaPlanVersionId":{"description":"The version ID of the media plan the resource is related to.","type":"string"},"state":{"$ref":"#/components/schemas/ResourceStateV1"},"stateDetails":{"$ref":"#/components/schemas/TrafficInsightStateDetailsV1"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"},"trafficInsightDetails":{"$ref":"#/components/schemas/TrafficInsightDetailsV1"},"trafficInsightId":{"description":"The ID of the resource.","type":"string"},"trafficInsightLevel":{"$ref":"#/components/schemas/TrafficInsightLevelV1"},"trafficInsightTargetingType":{"$ref":"#/components/schemas/TrafficInsghtTargetingTypeV1"},"trafficInsightType":{"$ref":"#/components/schemas/TrafficInsightTypeV1"}},"required":["creationDateTime","mediaPlanId","state","stateDetails","timeUnit","trafficInsightDetails","trafficInsightId","trafficInsightLevel","trafficInsightTargetingType","trafficInsightType"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UpdateAudienceOpportunitiesV1RequestContent":{"properties":{"audienceOpportunities":{"items":{"$ref":"#/components/schemas/AudienceOpportunityUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["audienceOpportunities"],"type":"object"},"UpdateAudienceOpportunitiesV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedAudienceOpportunitiesSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"UpdateBudgetAllocationsV1RequestContent":{"properties":{"budgetAllocations":{"items":{"$ref":"#/components/schemas/BudgetAllocationUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateBudgetAllocationsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedBudgetAllocationSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateMarketingGoalsV1RequestContent":{"properties":{"marketingGoals":{"items":{"$ref":"#/components/schemas/MarketingGoalUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["marketingGoals"],"type":"object"},"UpdateMarketingGoalsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMarketingGoalSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"UpdateMediaPlansV1RequestContent":{"properties":{"mediaPlans":{"items":{"$ref":"#/components/schemas/MediaPlanUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["mediaPlans"],"type":"object"},"UpdateMediaPlansV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedMediaPlanSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"UpdatePlanningItemsV1RequestContent":{"properties":{"planningItems":{"items":{"$ref":"#/components/schemas/PlanningItemUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdatePlanningItemsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedPlanningItemSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"UpdateTargetsV1RequestContent":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetUpdateV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"UpdateTargetsV1ResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/IndexedError"},"maxItems":1000,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/IndexedTargetSuccessV1"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["error","success"],"type":"object"},"UserLocationSignalV1":{"description":"The type of signal used to determine a users location when geo location targeting is applied.\n\n`CURRENT` - Includes people who are currently in this location.\n\n`MULTIPLE_SIGNALS` - Multiple location signals are used, including current and home location.","enum":["CURRENT","MULTIPLE_SIGNALS"],"type":"string"},"VideoCompletionForecastDataPointV1":{"properties":{"cpvc":{"format":"double","type":"number"},"prediction":{"format":"double","type":"number"},"spend":{"format":"double","type":"number"},"vcr":{"format":"double","type":"number"}},"type":"object"},"VideoCompletionForecastV1":{"properties":{"availableImpressions":{"type":"integer"},"avgCpm":{"format":"double","type":"number"},"cpc":{"format":"double","type":"number"},"dataPoints":{"items":{"$ref":"#/components/schemas/VideoCompletionForecastDataPointV1"},"maxItems":200,"minItems":0,"type":"array"},"forecastId":{"type":"string"},"frequencyCap":{"$ref":"#/components/schemas/FrequencyCapV1"},"matchingImpressions":{"type":"integer"},"maxCpm":{"format":"double","type":"number"},"maxOnTargetImpressions":{"type":"integer"},"maxSpend":{"format":"double","type":"number"},"maxTotalImpressions":{"type":"integer"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"APIs for creating and processing media plans.","title":"Media Planning API","version":"3.0"},"openapi":"3.0.1","paths":{"/mediaPlan/v1/audienceOpportunities":{"post":{"description":"This API is for creating audience opportunities for a given manager account.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreateAudienceOpportunitiesV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateAudienceOpportunitiesV1_example1":{"summary":"Create a audience opportunity","value":{"audienceOpportunities":[{"audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/CreateAudienceOpportunitiesV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateAudienceOpportunitiesV1_example1":{"summary":"Create a audience opportunity","value":{"error":[],"success":[{"audienceOpportunity":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/CreateAudienceOpportunitiesV1ResponseContent"}}},"description":"CreateAudienceOpportunitiesV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Opportunities V1"]},"put":{"description":"Update audience opportunities.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdateAudienceOpportunitiesV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateAudienceOpportunitiesV1_example1":{"summary":"Update a audience opportunity","value":{"audienceOpportunities":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityType":"AUDIENCE_BASELINE","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/UpdateAudienceOpportunitiesV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"UpdateAudienceOpportunitiesV1_example1":{"summary":"Update a audience opportunity","value":{"error":[],"success":[{"audienceOpportunity":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/UpdateAudienceOpportunitiesV1ResponseContent"}}},"description":"UpdateAudienceOpportunitiesV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Opportunities V1"]}},"/mediaPlan/v1/audienceOpportunities/delete":{"post":{"description":"Delete audience opportunities.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeleteAudienceOpportunitiesV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeleteAudienceOpportunitiesV1_example1":{"summary":"Delete an audience opportunity","value":{"audienceOpportunities":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/DeleteAudienceOpportunitiesV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"DeleteAudienceOpportunitiesV1_example1":{"summary":"Delete an audience opportunity","value":{"error":[],"success":[{"audienceOpportunity":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"DELETED","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/DeleteAudienceOpportunitiesV1ResponseContent"}}},"description":"DeleteAudienceOpportunitiesV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Opportunities V1"]}},"/mediaPlan/v1/audienceOpportunities/list":{"post":{"description":"This API is for listing audience opportunities for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListAudienceOpportunitiesV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListAudienceOpportunitiesV1_example1":{"summary":"List all audience opportunities","value":{"maxResults":1}},"ListAudienceOpportunitiesV1_example2":{"summary":"Filter audience opportunities by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListAudienceOpportunitiesV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListAudienceOpportunitiesV1_example1":{"summary":"List all audience opportunities","value":{"audienceOpportunities":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"NEW","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListAudienceOpportunitiesV1_example2":{"summary":"Filter audience opportunities by media plan ID","value":{"audienceOpportunities":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"NEW","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListAudienceOpportunitiesV1ResponseContent"}}},"description":"ListAudienceOpportunitiesV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Opportunities V1"]}},"/mediaPlan/v1/audienceOpportunities/{audienceOpportunityId}":{"get":{"description":"This API is for reading a audience opportunity.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadAudienceOpportunityV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadAudienceOpportunityV1_example1":{"summary":"Read a audience opportunity","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"audienceOpportunityId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.audience-opportunity\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadAudienceOpportunityV1_example1":{"summary":"Read a audience opportunity","value":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceOpportunityLevel":"MEDIA_PLAN","audienceOpportunityType":"AUDIENCE_BASELINE","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"NEW","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadAudienceOpportunityV1ResponseContent"}}},"description":"ReadAudienceOpportunityV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Opportunities V1"]}},"/mediaPlan/v1/audienceSizes/list":{"post":{"description":"This API is for listing audience sizes for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListAudienceSizesV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListAudienceSizesV1_example1":{"summary":"List all audience sizes","value":{"maxResults":1}},"ListAudienceSizesV1_example2":{"summary":"Filter audience sizes by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListAudienceSizesV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListAudienceSizesV1_example1":{"summary":"List all audience sizes","value":{"audienceSizes":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceSizeId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-size.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","period":"ANNUAL","state":"SUCCESS","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListAudienceSizesV1_example2":{"summary":"Filter audience sizes by media plan ID","value":{"audienceSizes":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceSizeId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-size.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","period":"ANNUAL","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListAudienceSizesV1ResponseContent"}}},"description":"ListAudienceSizesV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Sizes V1"]}},"/mediaPlan/v1/audienceSizes/{audienceSizeId}":{"get":{"description":"This API is for reading an audience size.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadAudienceSizeV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadAudienceSizeV1_example1":{"summary":"Read an audience size","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-size.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"audienceSizeId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.audience-size\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadAudienceSizeV1_example1":{"summary":"Read an audience size","value":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","audienceSizeId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-size.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"period":"ANNUAL","state":"SUCCESS","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadAudienceSizeV1ResponseContent"}}},"description":"ReadAudienceSizeV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Audience Sizes V1"]}},"/mediaPlan/v1/behavioralInsights/list":{"post":{"description":"This API is for listing behavioral insights for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListBehavioralInsightsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListBehavioralInsightsV1_example1":{"summary":"List all behavioral insights","value":{"maxResults":1}},"ListBehavioralInsightsV1_example2":{"summary":"Query for a behavioral insight by ID","value":{"filters":[{"field":"behavioralInsightId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.behavioral-insight.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListBehavioralInsightsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListBehavioralInsightsV1_example1":{"summary":"List all behavioral insights","value":{"behavioralInsights":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","behavioralInsightDetails":{"primeVideoBehavioralInsightDetails":{"insights":[{"metrics":{"affinity":1.5,"overlapPercentage":50},"name":"abc123","primeVideoInterest":"MOVIES"}]}},"behavioralInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.behavioral-insight.00000000-0000-0000-0000-000000000000","behavioralInsightType":"PRIME_VIDEO","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListBehavioralInsightsV1_example2":{"summary":"Query for a behavioral insight by ID","value":{"behavioralInsights":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","behavioralInsightDetails":{"primeVideoBehavioralInsightDetails":{"insights":[{"metrics":{"affinity":1.5,"overlapPercentage":50},"name":"abc123","primeVideoInterest":"MOVIES"}]}},"behavioralInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.behavioral-insight.00000000-0000-0000-0000-000000000000","behavioralInsightType":"PRIME_VIDEO","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListBehavioralInsightsV1ResponseContent"}}},"description":"ListBehavioralInsightsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Behavioral Insights V1"]}},"/mediaPlan/v1/behavioralInsights/{behavioralInsightId}":{"get":{"description":"This API is for reading a behavioral insight.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadBehavioralInsightV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadBehavioralInsightV1_example1":{"summary":"Read a behavioral insight","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.behavioral-insight.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"behavioralInsightId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.behavioral-insight\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadBehavioralInsightV1_example1":{"summary":"Read a behavioral insight","value":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","behavioralInsightDetails":{"primeVideoBehavioralInsightDetails":{"insights":[{"metrics":{"affinity":1.5,"overlapPercentage":50},"name":"abc123","primeVideoInterest":"MOVIES"}]}},"behavioralInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.behavioral-insight.00000000-0000-0000-0000-000000000000","behavioralInsightType":"PRIME_VIDEO","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"SUCCESS","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadBehavioralInsightV1ResponseContent"}}},"description":"ReadBehavioralInsightV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Behavioral Insights V1"]}},"/mediaPlan/v1/budgetAllocations":{"post":{"description":"This API is for creating budget allocations for a given manager account.\n\nOnly one budget allocation can be created for each `budgetAllocationType`.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreateBudgetAllocationsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateBudgetAllocationsV1_example1":{"summary":"Create an optimized budget allocation","value":{"budgetAllocations":[{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000}},"budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}},"CreateBudgetAllocationsV1_example2":{"summary":"Create a seasonal budget allocation","value":{"budgetAllocations":[{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":1000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":1000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"SEASONAL_BUDGET_BREAKDOWN","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/CreateBudgetAllocationsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"CreateBudgetAllocationsV1_example1":{"summary":"Create an optimized budget allocation","value":{"error":[],"success":[{"budgetAllocation":{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}},"CreateBudgetAllocationsV1_example2":{"summary":"Create a seasonal budget allocation","value":{"error":[],"success":[{"budgetAllocation":{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":1000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":1000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"SEASONAL_BUDGET_BREAKDOWN","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/CreateBudgetAllocationsV1ResponseContent"}}},"description":"CreateBudgetAllocationsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Budget Allocations V1"]},"put":{"description":"Update budget allocations.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdateBudgetAllocationsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateBudgetAllocationsV1_example1":{"summary":"Update an optimized budget allocation","value":{"budgetAllocations":[{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":2000000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}},"UpdateBudgetAllocationsV1_example2":{"summary":"Update a seasonal budget allocation","value":{"budgetAllocations":[{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":2000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":2000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/UpdateBudgetAllocationsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"UpdateBudgetAllocationsV1_example1":{"summary":"Update an optimized budget allocation","value":{"error":[],"success":[{"budgetAllocation":{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":200000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}},"UpdateBudgetAllocationsV1_example2":{"summary":"Update a seasonal budget allocation","value":{"error":[],"success":[{"budgetAllocation":{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":2000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":2000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"SEASONAL_BUDGET_BREAKDOWN","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"NEW","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/UpdateBudgetAllocationsV1ResponseContent"}}},"description":"UpdateBudgetAllocationsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Budget Allocations V1"]}},"/mediaPlan/v1/budgetAllocations/delete":{"post":{"description":"Delete budget allocations.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeleteBudgetAllocationsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeleteBudgetAllocationsV1_example1":{"summary":"Delete a budget allocation","value":{"budgetAllocations":[{"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/DeleteBudgetAllocationsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"DeleteBudgetAllocationsV1_example1":{"summary":"Delete a budget allocation","value":{"error":[],"success":[{"budgetAllocation":{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000,"optimizedBudget":120000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","state":"DELETED","stateDetails":{"errors":[]}},"index":0}]}}},"schema":{"$ref":"#/components/schemas/DeleteBudgetAllocationsV1ResponseContent"}}},"description":"DeleteBudgetAllocationsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Budget Allocations V1"]}},"/mediaPlan/v1/budgetAllocations/list":{"post":{"description":"This API is for listing budget allocations for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListBudgetAllocationsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListBudgetAllocationsV1_example1":{"summary":"List all budget allocations","value":{"maxResults":1}},"ListBudgetAllocationsV1_example2":{"summary":"Filter budget allocations by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}},"ListBudgetAllocationsV1_example3":{"summary":"List all seasonal budget allocations","value":{"maxResults":1}}},"schema":{"$ref":"#/components/schemas/ListBudgetAllocationsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListBudgetAllocationsV1_example1":{"summary":"List all budget allocations","value":{"budgetAllocations":[{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000,"optimizedBudget":120000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"NEW","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListBudgetAllocationsV1_example2":{"summary":"Filter budget allocations by media plan ID","value":{"budgetAllocations":[{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000,"optimizedBudget":120000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"NEW","stateDetails":{"errors":[]}}],"totalResults":1}},"ListBudgetAllocationsV1_example3":{"summary":"List all seasonal budget allocations","value":{"budgetAllocations":[{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":1000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":1000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"SEASONAL_BUDGET_BREAKDOWN","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"NEW","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}}},"schema":{"$ref":"#/components/schemas/ListBudgetAllocationsV1ResponseContent"}}},"description":"ListBudgetAllocationsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Budget Allocations V1"]}},"/mediaPlan/v1/budgetAllocations/{budgetAllocationId}":{"get":{"description":"This API is for reading a budget allocation.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadBudgetAllocationV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadBudgetAllocationV1_example1":{"summary":"Read an optimized budget allocation","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000"},"ReadBudgetAllocationV1_example2":{"summary":"Read a seasonal budget allocation","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"budgetAllocationId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.budget-allocation\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadBudgetAllocationV1_example1":{"summary":"Read an optimized budget allocation","value":{"budgetAllocationDetails":{"optimizedBudgetAllocationDetails":{"allocatedBudget":100000,"optimizedBudget":120000}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"OPTIMIZED_TOTAL_BUDGET","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"NEW","stateDetails":{"errors":[]}}},"ReadBudgetAllocationV1_example2":{"summary":"Read a seasonal budget allocation","value":{"budgetAllocationDetails":{"seasonalBudgetAllocationDetails":{"dataPoints":[{"budget":1000,"dedupedReach":1000,"endDate":"2024-02-01","startDate":"2024-01-01"},{"budget":1000,"dedupedReach":1000,"endDate":"2024-03-01","startDate":"2024-01-01"}],"seasonalBudgetTimeUnit":"MONTH"}},"budgetAllocationId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.budget-allocation.00000000-0000-0000-0000-000000000000","budgetAllocationLevel":"MEDIA_PLAN","budgetAllocationType":"SEASONAL_BUDGET_BREAKDOWN","creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"NEW","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadBudgetAllocationV1ResponseContent"}}},"description":"ReadBudgetAllocationV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Budget Allocations V1"]}},"/mediaPlan/v1/demographicInsights/list":{"post":{"description":"This API is for listing demographic insights for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListDemographicInsightsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListDemographicInsightsV1_example1":{"summary":"List all demographic insights","value":{"maxResults":1}},"ListDemographicInsightsV1_example2":{"summary":"Filter demographic insights by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListDemographicInsightsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListDemographicInsightsV1_example1":{"summary":"List all demographic insights","value":{"demographicInsights":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","demographicInsightDetails":{"educationDemographicInsightDetails":{"insights":[{"audienceId":"abc123","education":"HIGH_SCHOOL","metrics":{"affinity":1.5,"overlapPercentage":50}}]}},"demographicInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.demographic-insight.00000000-0000-0000-0000-000000000000","demographicInsightType":"EDUCATION","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListDemographicInsightsV1_example2":{"summary":"Filter demographic insights by media plan ID","value":{"demographicInsights":[{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","demographicInsightDetails":{"educationDemographicInsightDetails":{"insights":[{"audienceId":"abc123","education":"HIGH_SCHOOL","metrics":{"affinity":1.5,"overlapPercentage":50}}]}},"demographicInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.demographic-insight.00000000-0000-0000-0000-000000000000","demographicInsightType":"EDUCATION","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListDemographicInsightsV1ResponseContent"}}},"description":"ListDemographicInsightsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Demographic Insights V1"]}},"/mediaPlan/v1/demographicInsights/{demographicInsightId}":{"get":{"description":"This API is for reading a demographic insight.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadDemographicInsightV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadDemographicInsightV1_example1":{"summary":"Read a demographic insight","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.demographic-insight.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"demographicInsightId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.demographic-insight\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadDemographicInsightV1_example1":{"summary":"Read a demographic insight","value":{"audienceOpportunityId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.audience-opportunity.00000000-0000-0000-0000-000000000000","creationDateTime":"2024-01-01T00:00:00.000Z","demographicInsightDetails":{"educationDemographicInsightDetails":{"insights":[{"audienceId":"abc123","education":"HIGH_SCHOOL","metrics":{"affinity":1.5,"overlapPercentage":50}}]}},"demographicInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.demographic-insight.00000000-0000-0000-0000-000000000000","demographicInsightType":"EDUCATION","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"SUCCESS","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadDemographicInsightV1ResponseContent"}}},"description":"ReadDemographicInsightV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Demographic Insights V1"]}},"/mediaPlan/v1/exports/mediaPlans":{"post":{"description":"This API is for creating an export for media plans into a document for a given manager account.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"CreateMediaPlanExportsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateMediaPlanExportsV1_example1":{"summary":"Export a media plan","value":{"mediaPlanExports":[{"advertisingLocale":"en-US","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","mediaType":"POWERPOINT"}]}}},"schema":{"$ref":"#/components/schemas/CreateMediaPlanExportsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateMediaPlanExportsV1_example1":{"summary":"Export a media plan","value":{"success":[{"index":0,"mediaPlanExport":{"creationDateTime":"2024-01-01T00:00:00.000Z","fileUrl":"https://Plan-Exports-us-east-1.s3.us-east-1.amazonaws.com/amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.export.00000000-0000-0000-0000-000000000000/plan-export.ppt","mediaPlanExportId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.export.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","mediaType":"POWERPOINT","state":"SUCCESS"}}]}}},"schema":{"$ref":"#/components/schemas/CreateMediaPlanExportsV1ResponseContent"}}},"description":"CreateMediaPlanExportsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Exports V1"]}},"/mediaPlan/v1/marketingGoals":{"post":{"description":"This API is for creating marketing goals for a given manager account.\n\nOnly one marketing goal may be created for each `goal` within a given media plan.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreateMarketingGoalsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateMarketingGoalsV1_example1":{"summary":"Create a marketing goal","value":{"marketingGoals":[{"goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/CreateMarketingGoalsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateMarketingGoalsV1_example1":{"summary":"Create a marketing goal","value":{"error":[],"success":[{"index":0,"marketingGoal":{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"NEW","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/CreateMarketingGoalsV1ResponseContent"}}},"description":"CreateMarketingGoalsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Marketing Goals V1"]},"put":{"description":"Update marketing goals.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdateMarketingGoalsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateMarketingGoalsV1_example1":{"summary":"Update a marketing goal","value":{"marketingGoals":[{"goalSetting":{"goal":"AWARENESS","kpi":"COST_PER_CLICK"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false}}]}}},"schema":{"$ref":"#/components/schemas/UpdateMarketingGoalsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"UpdateMarketingGoalsV1_example1":{"summary":"Update a marketing goal","value":{"error":[],"success":[{"index":0,"marketingGoal":{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"COST_PER_CLICK"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"NEW","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/UpdateMarketingGoalsV1ResponseContent"}}},"description":"UpdateMarketingGoalsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Marketing Goals V1"]}},"/mediaPlan/v1/marketingGoals/delete":{"post":{"description":"Delete marketing goals.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeleteMarketingGoalsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeleteMarketingGoalsV1_example1":{"summary":"Delete a marketing goal","value":{"marketingGoals":[{"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/DeleteMarketingGoalsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"DeleteMarketingGoalsV1_example1":{"summary":"Delete a marketing goal","value":{"error":[],"success":[{"index":0,"marketingGoal":{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"DELETED","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/DeleteMarketingGoalsV1ResponseContent"}}},"description":"DeleteMarketingGoalsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Marketing Goals V1"]}},"/mediaPlan/v1/marketingGoals/list":{"post":{"description":"This API is for listing marketing goals for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListMarketingGoalsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListMarketingGoalsV1_example1":{"summary":"List all marketing goals","value":{"maxResults":1}},"ListMarketingGoalsV1_example2":{"summary":"Filter marketingGoals by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListMarketingGoalsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListMarketingGoalsV1_example1":{"summary":"List all marketing goals","value":{"marketingGoals":[{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"NEW","stateDetails":{"errors":[]}}],"nextToken":"abc123","totalResults":2}},"ListMarketingGoalsV1_example2":{"summary":"Filter marketingGoals by media plan ID","value":{"marketingGoals":[{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"NEW","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListMarketingGoalsV1ResponseContent"}}},"description":"ListMarketingGoalsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Marketing Goals V1"]}},"/mediaPlan/v1/marketingGoals/{marketingGoalId}":{"get":{"description":"This API is for reading a marketing goal.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadMarketingGoalV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadMarketingGoalV1_example1":{"summary":"Read a marketing goal","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"marketingGoalId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.marketing-goal\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadMarketingGoalV1_example1":{"summary":"Read a marketing goal","value":{"creationDateTime":"2024-01-01T00:00:00.000Z","goalSetting":{"goal":"AWARENESS","kpi":"REACH"},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"processingOptions":{"skipIncrementalReachOverLinearTv":false,"skipLinearTvReach":false},"state":"NEW","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadMarketingGoalV1ResponseContent"}}},"description":"ReadMarketingGoalV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Marketing Goals V1"]}},"/mediaPlan/v1/mediaPlans":{"post":{"description":"This API is for creating media plans for a given manager account.\n\nMedia plans must have a provided Amazon DSP advertiser ID, Sponsored advertiser ID, or both. Media plans are also associated with a single country specified by the `countryCode` field.\n\nMedia plans may be processed by updating the media plan `state` field to `PENDING`. The current values of the options in the `processingOptions` field will inform how the processing behaves.\n\nMedia plans may not be updated via API calls while they are in the `PENDING` or `PROCESSING` states.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreateMediaPlansV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateMediaPlansV1_example1":{"summary":"Create a media plan","value":{"mediaPlans":[{"mediaPlanCreateDetails":{"createMediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","dspAdvertiserId":"abc123","endDate":"2024-03-01","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","startDate":"2024-02-01","template":"ALL_MARKETING_GOALS"}},"mediaPlanCreateType":"CREATE"}]}},"CreateMediaPlansV1_example2":{"summary":"Copy a media plan","value":{"mediaPlans":[{"mediaPlanCreateDetails":{"copyMediaPlan":{"autoCreationSettings":{"autoCreateSubResources":true},"copyFromMediaPlanId":"amzn1.ads-planner.media-plan.11111111-1111-1111-1111-111111111111","isDraft":true,"versionId":"1"}},"mediaPlanCreateType":"COPY"}]}}},"schema":{"$ref":"#/components/schemas/CreateMediaPlansV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateMediaPlansV1_example1":{"summary":"Create a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"1"}}]}},"CreateMediaPlansV1_example2":{"summary":"Copy a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":true,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"1"}}]}}},"schema":{"$ref":"#/components/schemas/CreateMediaPlansV1ResponseContent"}}},"description":"CreateMediaPlansV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Media Plans V1"]},"put":{"description":"This API is for updating media plans for a given manager account.\n\nAll media plan fields provided by the user may be updated after media plan creation.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdateMediaPlansV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateMediaPlansV1_example1":{"summary":"Update a media plan","value":{"mediaPlans":[{"mediaPlanUpdateDetails":{"updateMediaPlan":{"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","productLocation":"NOT_SOLD_ON_AMAZON","versionId":"1"}},"mediaPlanUpdateType":"UPDATE"}]}},"UpdateMediaPlansV1_example2":{"summary":"Process a media plan","value":{"mediaPlans":[{"mediaPlanUpdateDetails":{"updateMediaPlan":{"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","state":"PENDING","versionId":"1"}},"mediaPlanUpdateType":"UPDATE"}]}},"UpdateMediaPlansV1_example3":{"summary":"Replace a media plan","value":{"mediaPlans":[{"mediaPlanUpdateDetails":{"replaceMediaPlan":{"autoCreationSettings":{"autoCreateSubResources":true},"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","replaceFromMediaPlanId":"amzn1.ads-planner.media-plan.11111111-1111-1111-1111-111111111111","versionId":"1"}},"mediaPlanUpdateType":"REPLACE"}]}}},"schema":{"$ref":"#/components/schemas/UpdateMediaPlansV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"UpdateMediaPlansV1_example1":{"summary":"Update a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"NOT_SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"2"}}]}},"UpdateMediaPlansV1_example2":{"summary":"Process a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"PENDING","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"2"}}]}},"UpdateMediaPlansV1_example3":{"summary":"Replace a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"PENDING","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"2"}}]}}},"schema":{"$ref":"#/components/schemas/UpdateMediaPlansV1ResponseContent"}}},"description":"UpdateMediaPlansV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Media Plans V1"]}},"/mediaPlan/v1/mediaPlans/delete":{"post":{"description":"This API is for deleting media plans for a given manager account.\n\nAll sub-resources of a media plan will be deleted as well.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeleteMediaPlansV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeleteMediaPlansV1_example1":{"summary":"Delete a media plan","value":{"mediaPlans":[{"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","versionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/DeleteMediaPlansV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"DeleteMediaPlansV1_example1":{"summary":"Delete a media plan","value":{"error":[],"success":[{"index":0,"mediaPlan":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"DELETED","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"2"}}]}}},"schema":{"$ref":"#/components/schemas/DeleteMediaPlansV1ResponseContent"}}},"description":"DeleteMediaPlansV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Media Plans V1"]}},"/mediaPlan/v1/mediaPlans/list":{"post":{"description":"This API is for listing media plans for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListMediaPlansV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListMediaPlansV1_example1":{"summary":"List all media plans","value":{"maxResults":1}},"ListMediaPlansV1_example2":{"summary":"Filter media plans by name","value":{"filters":[{"field":"name","operator":"EQUALS","values":["abc123"]}]}}},"schema":{"$ref":"#/components/schemas/ListMediaPlansV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListMediaPlansV1_example1":{"summary":"List all media plans","value":{"mediaPlans":[{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"1"}],"nextToken":"abc123","totalResults":2}},"ListMediaPlansV1_example2":{"summary":"Filter media plans by name","value":{"mediaPlans":[{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":"1"}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListMediaPlansV1ResponseContent"}}},"description":"ListMediaPlansV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Media Plans V1"]}},"/mediaPlan/v1/mediaPlans/{mediaPlanId}":{"get":{"description":"This API is for reading a media plan.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadMediaPlanV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadMediaPlanV1_example1":{"summary":"Read a media plan","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"mediaPlanId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadMediaPlanV1_example1":{"summary":"Read a media plan","value":{"advertisedProductCategoryIds":[],"countryCode":"US","creationDateTime":"2024-01-01T00:00:00.000Z","currencyCode":"USD","dspAdvertiserId":"abc123","dspAdvertiserName":"My Amazon DSP advertiser","endDate":"2024-03-01","isDraft":false,"mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","name":"abc123","processingOptions":{"refreshReachCurves":false,"skipProcessingSystemBudgetAllocations":false},"productLocation":"SOLD_ON_AMAZON","sponsoredAdvertiserId":"abc123","sponsoredAdvertiserName":"My sponsored advertiser","startDate":"2024-02-01","state":"NEW","stateDetails":{"errors":[]},"template":"ALL_MARKETING_GOALS","userLocationSignal":"MULTIPLE_SIGNALS","versionId":1}}},"schema":{"$ref":"#/components/schemas/ReadMediaPlanV1ResponseContent"}}},"description":"ReadMediaPlanV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Media Plans V1"]}},"/mediaPlan/v1/performanceForecasts/list":{"post":{"description":"This API is for listing performance forecasts for a given account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListPerformanceForecastsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListPerformanceForecastsV1_example1":{"summary":"List all performance forecasts","value":{"maxResults":1}},"ListPerformanceForecastsV1_example2":{"summary":"Filter performance forecasts by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}},"ListPerformanceForecastsV1_example3":{"summary":"Filter performance forecasts by type","value":{"filters":[{"field":"performanceForecastType","operator":"EQUALS","values":["REACH"]}]}}},"schema":{"$ref":"#/components/schemas/ListPerformanceForecastsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListPerformanceForecastsV1_example1":{"summary":"List all performance forecasts","value":{"nextToken":"abc123","performanceForecasts":[{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","performanceForecastDetails":{"reachForecast":{"availableImpressions":2000,"avgCpm":10,"cpc":0.5,"dataPoints":[{"impressions":10000,"reach":500,"reachPercent":5,"spend":100}],"forecastId":"forecast-123","frequencyCap":{"type":"UNCAPPED"},"matchingImpressions":1000,"maxCpm":10,"maxOnTargetImpressions":750,"maxSpend":100,"maxTotalImpressions":1000}},"performanceForecastId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.performance-forecast.00000000-0000-0000-0000-000000000000","performanceForecastLevel":"PLANNING_ITEM","performanceForecastType":"REACH","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":2}},"ListPerformanceForecastsV1_example2":{"summary":"Filter performance forecasts by media plan ID","value":{"performanceForecasts":[{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","performanceForecastDetails":{"reachForecast":{"availableImpressions":2000,"avgCpm":10,"cpc":0.5,"dataPoints":[{"impressions":10000,"reach":500,"reachPercent":5,"spend":100}],"forecastId":"forecast-123","frequencyCap":{"type":"UNCAPPED"},"matchingImpressions":1000,"maxCpm":10,"maxOnTargetImpressions":750,"maxSpend":100,"maxTotalImpressions":1000}},"performanceForecastId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.performance-forecast.00000000-0000-0000-0000-000000000000","performanceForecastLevel":"PLANNING_ITEM","performanceForecastType":"REACH","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":1}},"ListPerformanceForecastsV1_example3":{"summary":"Filter performance forecasts by type","value":{"performanceForecasts":[{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","performanceForecastDetails":{"reachForecast":{"availableImpressions":2000,"avgCpm":10,"cpc":0.5,"dataPoints":[{"impressions":10000,"reach":500,"reachPercent":5,"spend":100}],"forecastId":"forecast-123","frequencyCap":{"type":"UNCAPPED"},"matchingImpressions":1000,"maxCpm":10,"maxOnTargetImpressions":750,"maxSpend":100,"maxTotalImpressions":1000}},"performanceForecastId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.performance-forecast.00000000-0000-0000-0000-000000000001","performanceForecastLevel":"PLANNING_ITEM","performanceForecastType":"REACH","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","state":"SUCCESS","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListPerformanceForecastsV1ResponseContent"}}},"description":"ListPerformanceForecastsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Performance Forecasts V1"]}},"/mediaPlan/v1/performanceForecasts/{performanceForecastId}":{"get":{"description":"This API is for reading a performance forecast.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadPerformanceForecastV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadPerformanceForecastV1_example1":{"summary":"Read a performance forecast","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.performance-forecast.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"performanceForecastId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.performance-forecast\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadPerformanceForecastV1_example1":{"summary":"Read a performance forecast","value":{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"performanceForecastDetails":{"reachForecast":{"availableImpressions":2000,"avgCpm":10,"cpc":0.5,"dataPoints":[{"impressions":10000,"reach":500,"reachPercent":5,"spend":100}],"forecastId":"forecast-123","frequencyCap":{"type":"UNCAPPED"},"matchingImpressions":1000,"maxCpm":10,"maxOnTargetImpressions":750,"maxSpend":100,"maxTotalImpressions":1000}},"performanceForecastId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.performance-forecast.00000000-0000-0000-0000-000000000000","performanceForecastLevel":"PLANNING_ITEM","performanceForecastType":"REACH","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","state":"SUCCESS","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadPerformanceForecastV1ResponseContent"}}},"description":"ReadPerformanceForecastV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Performance Forecasts V1"]}},"/mediaPlan/v1/planningItems":{"post":{"description":"This API is for creating planning items for a given manager account.\n\nPlanning items are related to a marketing goal. Only one planning item may be created for a marketing goal given the same `planningItemType` and `deliveryType`.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreatePlanningItemsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreatePlanningItemsV1_example1":{"summary":"Create a planning item","value":{"planningItems":[{"forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO"}]}},"CreatePlanningItemsV1_example2":{"summary":"Create a planning item with PUBLISHER planningItemType","value":{"planningItems":[{"enabled":true,"forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","parentPlanningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.11111111-1111-1111-1111-111111111111","planningItemLevel":"PLANNING_ITEM","planningItemType":"PUBLISHER"}]}}},"schema":{"$ref":"#/components/schemas/CreatePlanningItemsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"CreatePlanningItemsV1_example1":{"summary":"Create a planning item","value":{"error":[],"success":[{"index":0,"planningItem":{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"NEW","stateDetails":{"errors":[]}}}]}},"CreatePlanningItemsV1_example2":{"summary":"Create a planning item with PUBLISHER planningItemType","value":{"error":[],"success":[{"index":0,"planningItem":{"creationDateTime":"2024-01-01T00:00:00.000Z","enabled":true,"forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","name":"ABC","parentPlanningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.11111111-1111-1111-1111-111111111111","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"PLANNING_ITEM","planningItemType":"PUBLISHER","state":"NEW","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/CreatePlanningItemsV1ResponseContent"}}},"description":"CreatePlanningItemsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Planning Items V1"]},"put":{"description":"Update planning items.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdatePlanningItemsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdatePlanningItemsV1_example1":{"summary":"Update a planning item","value":{"planningItems":[{"kpis":[{"type":"MEDIAN_CPC","value":1}],"mediaPlanVersionId":"1","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000"}]}}},"schema":{"$ref":"#/components/schemas/UpdatePlanningItemsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"UpdatePlanningItemsV1_example1":{"summary":"Update a planning item","value":{"error":[],"success":[{"index":0,"planningItem":{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"kpis":[{"type":"MEDIAN_CPC","value":1}],"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"NEW","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/UpdatePlanningItemsV1ResponseContent"}}},"description":"UpdatePlanningItemsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Planning Items V1"]}},"/mediaPlan/v1/planningItems/delete":{"post":{"description":"Delete planning items.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeletePlanningItemsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeletePlanningItemsV1_example1":{"summary":"Delete a planning item","value":{"planningItems":[{"mediaPlanVersionId":"1","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000"}]}}},"schema":{"$ref":"#/components/schemas/DeletePlanningItemsV1RequestContent"}}}},"responses":{"207":{"content":{"application/json":{"examples":{"DeletePlanningItemsV1_example1":{"summary":"Delete a planning item","value":{"error":[],"success":[{"index":0,"planningItem":{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"DELETED","stateDetails":{"errors":[]}}}]}}},"schema":{"$ref":"#/components/schemas/DeletePlanningItemsV1ResponseContent"}}},"description":"DeletePlanningItemsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Planning Items V1"]}},"/mediaPlan/v1/planningItems/list":{"post":{"description":"This API is for listing planning items for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListPlanningItemsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListPlanningItemsV1_example1":{"summary":"List all planning items","value":{"maxResults":1}},"ListPlanningItemsV1_example2":{"summary":"Filter planning items by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListPlanningItemsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListPlanningItemsV1_example1":{"summary":"List all planning items","value":{"nextToken":"abc123","planningItems":[{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"NEW","stateDetails":{"errors":[]}}],"totalResults":2}},"ListPlanningItemsV1_example2":{"summary":"Filter planning items by media plan ID","value":{"planningItems":[{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"NEW","stateDetails":{"errors":[]}}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListPlanningItemsV1ResponseContent"}}},"description":"ListPlanningItemsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Planning Items V1"]}},"/mediaPlan/v1/planningItems/{planningItemId}":{"get":{"description":"This API is for reading a planning item.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadPlanningItemV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadPlanningItemV1_example1":{"summary":"Read a planning item","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"planningItemId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.planning-item\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadPlanningItemV1_example1":{"summary":"Read a planning item","value":{"creationDateTime":"2024-01-01T00:00:00.000Z","forecastSettings":{"cpm":10,"deliveryType":"GUARANTEED","frequencyCap":{"type":"UNCAPPED"}},"hidden":false,"marketingGoalId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"planningItemId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.planning-item.00000000-0000-0000-0000-000000000000","planningItemLevel":"MARKETING_GOAL","planningItemType":"DSP_PRIME_VIDEO","state":"NEW","stateDetails":{"errors":[]}}}},"schema":{"$ref":"#/components/schemas/ReadPlanningItemV1ResponseContent"}}},"description":"ReadPlanningItemV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Planning Items V1"]}},"/mediaPlan/v1/targets":{"post":{"description":"Create targets.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"CreateTargetsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"CreateTargetsV1_example1":{"summary":"Create a target","value":{"targets":[{"marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","negative":false,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}]}}},"schema":{"$ref":"#/components/schemas/CreateTargetsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"CreateTargetsV1_example1":{"summary":"Create a target","value":{"error":[],"success":[{"index":0,"target":{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","negative":false,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}}]}}},"schema":{"$ref":"#/components/schemas/CreateTargetsV1ResponseContent"}}},"description":"CreateTargetsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Targets V1"]},"put":{"description":"Update targets.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"UpdateTargetsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateTargetsV1_example1":{"summary":"Update a target","value":{"targets":[{"mediaPlanVersionId":"1","negative":true,"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000"}]}}},"schema":{"$ref":"#/components/schemas/UpdateTargetsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"UpdateTargetsV1_example1":{"summary":"Update a target","value":{"error":[],"success":[{"index":0,"target":{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","negative":true,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}}]}}},"schema":{"$ref":"#/components/schemas/UpdateTargetsV1ResponseContent"}}},"description":"UpdateTargetsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Targets V1"]}},"/mediaPlan/v1/targets/delete":{"post":{"description":"Delete targets.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"advertiser_campaign_edit\",\"ads_planner_edit\",\"ads_planner_internal_edit\"]","operationId":"DeleteTargetsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"DeleteTargetsV1_example1":{"summary":"Delete a target","value":{"targets":[{"mediaPlanVersionId":"1","targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000"}]}}},"schema":{"$ref":"#/components/schemas/DeleteTargetsV1RequestContent"}}},"required":true},"responses":{"207":{"content":{"application/json":{"examples":{"DeleteTargetsV1_example1":{"summary":"Delete a target","value":{"error":[],"success":[{"index":0,"target":{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"2","negative":true,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}}]}}},"schema":{"$ref":"#/components/schemas/DeleteTargetsV1ResponseContent"}}},"description":"DeleteTargetsV1 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Targets V1"]}},"/mediaPlan/v1/targets/list":{"post":{"description":"This API is for listing targets for a given manager account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListTargetsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListTargetsV1_example1":{"summary":"List all targets","value":{"maxResults":1}},"ListTargetsV1_example2":{"summary":"Filter targets by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"$ref":"#/components/schemas/ListTargetsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListTargetsV1_example1":{"summary":"List all targets","value":{"nextToken":"abc123","targets":[{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","negative":false,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}],"totalResults":2}},"ListTargetsV1_example2":{"summary":"Filter targets by media plan ID","value":{"targets":[{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","negative":false,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}],"totalResults":1}}},"schema":{"$ref":"#/components/schemas/ListTargetsV1ResponseContent"}}},"description":"ListTargetsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Targets V1"]}},"/mediaPlan/v1/targets/{targetId}":{"get":{"description":"This API is for reading a target.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadTargetV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadTargetV1_example1":{"summary":"Read a target","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"targetId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.target\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadTargetV1_example1":{"summary":"Read a target","value":{"creationDateTime":"2024-01-01T00:00:00.000Z","marketingGoalId":"amzn1.ads-planner.marketing-goal.00000000-0000-0000-0000-000000000000","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"negative":false,"targetDetails":{"productTarget":{"asin":"abc123","matchType":"PRODUCT_EXACT"}},"targetId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.target.00000000-0000-0000-0000-000000000000","targetLevel":"MARKETING_GOAL","targetType":"PRODUCT"}}},"schema":{"$ref":"#/components/schemas/ReadTargetV1ResponseContent"}}},"description":"ReadTargetV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Targets V1"]}},"/mediaPlan/v1/trafficInsights/list":{"post":{"description":"This API is for listing traffic insights for a given account.\n\nThe returned list can be filtered using the `filters` field in the request.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ListTrafficInsightsV1","parameters":[{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ListTrafficInsightsV1_example1":{"summary":"List all traffic insights","value":{"maxResults":1}},"ListTrafficInsightsV1_example2":{"summary":"Filter traffic insights by media plan ID","value":{"filters":[{"field":"mediaPlanId","operator":"EQUALS","values":["amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000"]}]}},"ListTrafficInsightsV1_example3":{"summary":"Filter traffic insights by type","value":{"filters":[{"field":"trafficInsightType","operator":"EQUALS","values":["SHOPPER_TRAFFIC_FORECAST"]}]}}},"schema":{"$ref":"#/components/schemas/ListTrafficInsightsV1RequestContent"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"ListTrafficInsightsV1_example1":{"summary":"List all traffic insights","value":{"nextToken":"abc123","totalResults":2,"trafficInsights":[{"creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]},"timeUnit":"MONTH","trafficInsightDetails":{"shopperTrafficForecastDetails":{"dataPoints":[{"endDate":"2024-02-01","percent":5,"startDate":"2024-01-01"}]}},"trafficInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.traffic-insight.00000000-0000-0000-0000-000000000000","trafficInsightLevel":"MEDIA_PLAN","trafficInsightTargetingType":"RETAIL_PRODUCT_CATEGORIES","trafficInsightType":"SHOPPER_TRAFFIC_FORECAST"}]}},"ListTrafficInsightsV1_example2":{"summary":"Filter traffic insights by media plan ID","value":{"totalResults":1,"trafficInsights":[{"creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]},"timeUnit":"MONTH","trafficInsightDetails":{"shopperTrafficForecastDetails":{"dataPoints":[{"endDate":"2024-02-01","percent":5,"startDate":"2024-01-01"}]}},"trafficInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.traffic-insight.00000000-0000-0000-0000-000000000000","trafficInsightLevel":"MEDIA_PLAN","trafficInsightTargetingType":"RETAIL_PRODUCT_CATEGORIES","trafficInsightType":"SHOPPER_TRAFFIC_FORECAST"}]}},"ListTrafficInsightsV1_example3":{"summary":"Filter traffic insights by type","value":{"totalResults":1,"trafficInsights":[{"creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":"1","state":"SUCCESS","stateDetails":{"errors":[]},"timeUnit":"MONTH","trafficInsightDetails":{"shopperTrafficForecastDetails":{"dataPoints":[{"endDate":"2024-02-01","percent":5,"startDate":"2024-01-01"}]}},"trafficInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.traffic-insight.00000000-0000-0000-0000-000000000000","trafficInsightLevel":"MEDIA_PLAN","trafficInsightTargetingType":"RETAIL_PRODUCT_CATEGORIES","trafficInsightType":"SHOPPER_TRAFFIC_FORECAST"}]}}},"schema":{"$ref":"#/components/schemas/ListTrafficInsightsV1ResponseContent"}}},"description":"ListTrafficInsightsV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Traffic Insights V1"]}},"/mediaPlan/v1/trafficInsights/{trafficInsightId}":{"get":{"description":"This API is for reading a traffic insight.\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"advertiser_campaign_edit\",\"ads_planner_view\",\"ads_planner_edit\",\"ads_planner_internal_view\",\"ads_planner_internal_edit\",\"advertiser_campaign_view\"]","operationId":"ReadTrafficInsightV1","parameters":[{"description":"The ID of the resource.","examples":{"ReadTrafficInsightV1_example1":{"summary":"Read a traffic insight","value":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.traffic-insight.00000000-0000-0000-0000-000000000000"}},"in":"path","name":"trafficInsightId","required":true,"schema":{"description":"The ID of the resource.","pattern":"^[a-zA-Z0-9\\.\\-]+\\.traffic-insight\\.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"}},{"description":"The identifier of a dsp account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The identifier of a dsp account.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","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.","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"}},{"description":"The edit token of the plan.","in":"header","name":"editToken","schema":{"description":"The edit token of the plan.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ReadTrafficInsightV1_example1":{"summary":"Read a traffic insight","value":{"creationDateTime":"2024-01-01T00:00:00.000Z","mediaPlanId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000","mediaPlanVersionId":1,"state":"SUCCESS","stateDetails":{"errors":[]},"timeUnit":"MONTH","trafficInsightDetails":{"shopperTrafficForecastDetails":{"dataPoints":[{"endDate":"2024-02-01","percent":5,"startDate":"2024-01-01"}]}},"trafficInsightId":"amzn1.ads-planner.media-plan.00000000-0000-0000-0000-000000000000.traffic-insight.00000000-0000-0000-0000-000000000000","trafficInsightLevel":"MEDIA_PLAN","trafficInsightTargetingType":"RETAIL_PRODUCT_CATEGORIES","trafficInsightType":"SHOPPER_TRAFFIC_FORECAST"}}},"schema":{"$ref":"#/components/schemas/ReadTrafficInsightV1ResponseContent"}}},"description":"ReadTrafficInsightV1 200 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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponseContent"}}},"description":"Conflict 409 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"}},"tags":["Traffic Insights V1"]}}}}