type LineItemDeliveryForecast (v202402)
The forecasted delivery of a ProspectiveLineItem.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202402
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 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["`LineItemDeliveryForecast` objects provide delivery predictions for prospective or existing line items."],["Forecasted delivery estimations (`predictedDeliveryUnits`) consider potential impacts on existing line items with similar or lower priorities."],["The forecast details include the unit type (`unitType`) used for the line item's goal or cap, such as impressions or clicks."],["It also shows the number of units already delivered (`deliveredUnits`) and the units matching the targeting criteria (`matchedUnits`)."],["Each forecast is uniquely identified by a `lineItemId` and is associated with an `orderId`, if available."]]],["The `LineItemDeliveryForecast` provides insights into the delivery of a `ProspectiveLineItem`. Key data includes: `lineItemId` (unique identifier), `orderId` (associated order ID), and `unitType` (measurement unit, like impressions or clicks). It defines types of `unitType` such as `IMPRESSIONS` and `CLICKS`. The forecast also shows `predictedDeliveryUnits` (estimated units to be delivered), `deliveredUnits` (already served units), and `matchedUnits` (units matching targeting and settings). These metrics help analyze line item performance.\n"]]
