type AlternativeUnitTypeForecast (v202505)

  • AlternativeUnitTypeForecast provides a view of the forecast in terms of an alternative unit type, such as viewable impressions for an impressions goal.

  • The unitType field specifies the alternative unit type being presented, which can be impressions, clicks, various CPA conversions, viewable impressions, or in-target impressions.

  • matchedUnits indicates the number of units that match the specified targeting and delivery settings for the alternative unit type.

  • availableUnits shows the number of units that can be booked without affecting reserved line items.

  • possibleUnits represents the maximum number of units that could be booked by taking inventory from lower-priority line items.
Service
ForecastService
Dependencies
AvailabilityForecast
▼
AlternativeUnitTypeForecast

A view of the forecast in terms of an alternative unit type.

For example, a forecast for an impressions goal may include this to express the matched, available, and possible viewable impressions.

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

Field

unitType

UnitType

The alternative unit type being presented.

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.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

matchedUnits

xsd:long

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

availableUnits

xsd:long

The number of units, defined by unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.

possibleUnits

xsd:long

The maximum number of units, defined by unitType, that could be booked by taking inventory away from lower-priority line items.