type ProspectiveLineItem (v202411)

  • A ProspectiveLineItem is used to represent a potential line item for forecasting purposes within the ForecastService.

  • Forecasting can be performed for either a standard LineItem or a ProposalLineItem by specifying the relevant field.

  • Forecasting with a null or non-existent ID for a line item predicts the impact of adding it to the network, while using an existing ID forecasts the effect of modifying its settings.

  • The advertiserId field can be set to apply unified blocking rules to the prospective line item during forecasting.
Service
ForecastService
Dependencies
getAvailabilityForecast() getDeliveryForecast()
▼
ProspectiveLineItem

Represents a prospective line item to be forecasted.

Namespace
https://www.google.com/apis/ads/publisher/v202411

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.