type ProspectiveLineItem (v202502)
Stay organized with collections
Save and categorize content based on your preferences.
Represents a prospective line item to be forecasted.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202502
Field
|
lineItem
|
LineItem
The target of the forecast. If LineItem.id is null or no line item exists with that ID,
then a forecast is computed for the subject, predicting what would happen if it were added to
the network. If a line item already exists with LineItem.id, the forecast is computed
for the subject, predicting what would happen if the existing line item's settings were
modified to match the subject.
|
proposalLineItem
|
ProposalLineItem
The target of the forecast if this prospective line item is a
proposal line item.
If ProposalLineItem.id is null or no proposal line item exists with
that ID, then a forecast is computed for the subject, predicting
what would happen if it were added to the network. If a proposal
line item already exists with ProposalLineItem.id, the forecast is
computed for the subject, predicting what would happen if the
existing proposal line item's settings were modified to match the
subject.
A proposal line item can optionally correspond to an order
LineItem, in
which case, by forecasting a proposal line item, the corresponding
line item is implicitly ignored in the forecasting.
Either lineItem or proposalLineItem should be specified but not both.
|
advertiserId
|
xsd:long
When set, the line item is assumed to be from this advertiser, and unified blocking rules will
apply accordingly. If absent, line items without an existing order won't be subject to unified
blocking rules.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[],["The `ForecastService` offers `getAvailabilityForecast()` and `getDeliveryForecast()` to analyze prospective line items. `ProspectiveLineItem` represents a line item to be forecasted and can be tied to either a `LineItem` or a `ProposalLineItem`. If an ID is provided and already exists, the forecast predicts changes if existing item's settings match the subject. If ID is null, the forecast predicts adding the item. `advertiserId` can be provided for applying unified blocking rules.\n"],null,["# type ProspectiveLineItem (v202502)\n\n**Service** \n**ForecastService** **Dependencies** \n[getAvailabilityForecast()](/ad-manager/api/reference/v202502/ForecastService#getAvailabilityForecast) [getDeliveryForecast()](/ad-manager/api/reference/v202502/ForecastService#getDeliveryForecast) \n▼\n**ProspectiveLineItem**\n\nRepresents a prospective line item to be forecasted.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202502`\n\n| Field ----- ||\n|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `lineItem` | ` `[LineItem](/ad-manager/api/reference/v202502/ForecastService.LineItem)` ` The target of the forecast. If [LineItem.id](/ad-manager/api/reference/v202502/ForecastService.LineItem#id) is null or no line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a line item already exists with [LineItem.id](/ad-manager/api/reference/v202502/ForecastService.LineItem#id), the forecast is computed for the subject, predicting what would happen if the existing line item's settings were modified to match the subject. |\n| ### `proposalLineItem` | ` `[ProposalLineItem](/ad-manager/api/reference/v202502/ForecastService.ProposalLineItem)` ` The target of the forecast if this prospective line item is a proposal line item. If [ProposalLineItem.id](/ad-manager/api/reference/v202502/ForecastService.ProposalLineItem#id) is null or no proposal line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a proposal line item already exists with [ProposalLineItem.id](/ad-manager/api/reference/v202502/ForecastService.ProposalLineItem#id), the forecast is computed for the subject, predicting what would happen if the existing proposal line item's settings were modified to match the subject. A proposal line item can optionally correspond to an order [LineItem](/ad-manager/api/reference/v202502/ForecastService.LineItem), in which case, by forecasting a proposal line item, the corresponding line item is implicitly ignored in the forecasting. Either [lineItem](#lineItem) or [proposalLineItem](#proposalLineItem) should be specified but not both. \u003cbr /\u003e |\n| ### `advertiserId` | ` `xsd:`long` When set, the line item is assumed to be from this advertiser, and unified blocking rules will apply accordingly. If absent, line items without an existing order won't be subject to unified blocking rules. |"]]
