Google Ads Ad Manager V1 Client - Class LineItemDeliveryForecast (0.15.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class LineItemDeliveryForecast.

The forecasted delivery of a ProposalLineItem or LineItem.

Generated from protobuf message google.ads.admanager.v1.LineItemDeliveryForecast

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ line_item`	`string` Uniquely identifies this line item delivery forecast. This value is read-only and will be either the resource name of the LineItem resource it represents, or unset if the forecast represents a prospective line item. Format: `networks/{network_code}/lineItems/{line_item_id}`
`↳ order`	`string` The resource name of the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.order set. Format: `networks/{network_code}/orders/{order_id}`
`↳ unit_type`	`int` 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.
`↳ predicted_delivery_units`	`int\|string` 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.
`↳ delivered_units`	`int\|string` The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
`↳ matched_units`	`int\|string` The number of units, defined by Goal.unitType, that match the specified LineItem#targeting and delivery settings.

getLineItem

Uniquely identifies this line item delivery forecast. This value is read-only and will be either the resource name of the LineItem resource it represents, or unset if the forecast represents a prospective line item. Format: networks/{network_code}/lineItems/{line_item_id}

Returns
Type	Description
`string`

hasLineItem

clearLineItem

setLineItem

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrder

The resource name of the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.order set.

Format: networks/{network_code}/orders/{order_id}

Returns
Type	Description
`string`

hasOrder

clearOrder

setOrder

The resource name of the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.order set.

Format: networks/{network_code}/orders/{order_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUnitType

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.

Returns
Type	Description
`int`

hasUnitType

clearUnitType

setUnitType

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.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPredictedDeliveryUnits

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.

Returns
Type	Description
`int\|string`

hasPredictedDeliveryUnits

clearPredictedDeliveryUnits

setPredictedDeliveryUnits