type LineItemDeliveryForecast (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
The forecasted delivery of a ProspectiveLineItem.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
-
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.
|
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."],[[["\u003cp\u003e\u003ccode\u003eLineItemDeliveryForecast\u003c/code\u003e objects provide insight into the forecasted and actual delivery performance of line items, including prospective ones.\u003c/p\u003e\n"],["\u003cp\u003eThe forecast details include essential metrics like predicted delivery units, delivered units, and matched units, all based on the line item's goal and unit type.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eLineItemDeliveryForecast\u003c/code\u003e leverages key identifiers like \u003ccode\u003elineItemId\u003c/code\u003e, \u003ccode\u003eorderId\u003c/code\u003e, and \u003ccode\u003eunitType\u003c/code\u003e for precise association with corresponding line items and orders.\u003c/p\u003e\n"],["\u003cp\u003eIt provides critical information about the delivery progress towards the line item's target, helping publishers assess the effectiveness and potential of their campaigns.\u003c/p\u003e\n"]]],["The `ForecastService` uses `LineItemDeliveryForecast` to predict the delivery of a `ProspectiveLineItem`. Key data includes `lineItemId`, `orderId`, and `unitType`. `UnitType` can represent impressions, clicks, or CPA conversions. The forecast also indicates `predictedDeliveryUnits`, `deliveredUnits`, and `matchedUnits`, all based on the defined `UnitType`. This information helps gauge potential delivery success, the number of units already served, and units that match the specified settings.\n"],null,[]]
