type LineItemDeliveryForecast (v202508)

  • LineItemDeliveryForecast represents the forecasted delivery of a ProspectiveLineItem within the ForecastService.

  • Each line item delivery forecast is uniquely identified by lineItemId and associated with an order by orderId.

  • The forecast includes the unitType which defines the goal or cap of the LineItem, such as IMPRESSIONS, CLICKS, or various conversion types.

  • Key delivery metrics provided are predictedDeliveryUnits, the expected units to be delivered, and deliveredUnits, units already served for running reservations.

  • matchedUnits indicates the number of units that align with the specified line item targeting and delivery settings.
Service
ForecastService
Dependencies
DeliveryForecast
▼
LineItemDeliveryForecast

The forecasted delivery of a ProspectiveLineItem.

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

Field

lineItemId

xsd:long

Uniquely identifies this line item delivery forecast. This value is read-only and will be either the ID of the LineItem object it represents, or null if the forecast represents a prospective line item.

orderId

xsd:long

The unique ID for the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.orderId set.

unitType

UnitType

The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.

Enumerations
IMPRESSIONS
The number of impressions served by creatives associated with the line item. Line items of all LineItemType support this UnitType.
CLICKS
The number of clicks reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD, LineItemType.BULK or LineItemType.PRICE_PRIORITY.
CLICK_THROUGH_CPA_CONVERSIONS
The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
VIEW_THROUGH_CPA_CONVERSIONS
The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
TOTAL_CPA_CONVERSIONS
The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.costType must be CostType.CPA.
VIEWABLE_IMPRESSIONS
The number of viewable impressions reported by creatives associated with the line item. The LineItem.lineItemType must be LineItemType.STANDARD.
IN_TARGET_IMPRESSIONS
The number of in-target impressions reported by third party measurements. The LineItem.lineItemType must be LineItemType.STANDARD.
COMPLETED_VIEWS
The number of completed views reported by creatives associated with the line item. A completed view is defined as having watched the entirety of the in-stream video ad and is only supported for standard reservation video line items. The LineItem.lineItemType must be LineItemType.STANDARD.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

predictedDeliveryUnits

xsd:long

The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.

deliveredUnits

xsd:long

The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.

matchedUnits

xsd:long

The number of units, defined by Goal.unitType, that match the specified LineItem.targeting and delivery settings.