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

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

Describes predicted inventory availability for a ProspectiveLineItem.

Inventory has three threshold values along a line of possible inventory. From least to most, these are: Available units -- How many units can be booked without affecting any other line items. Booking more than this number can cause lower and same priority line items to underdeliver. Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can cause the line item to underdeliver. Matched (forecast) units -- How many units satisfy all specified criteria. Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory is able to be met without overbooking.

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

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 availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the resource name of the LineItem object it represents, or null if the forecast represents a prospective line item. Format: networks/{network_code}/lineItems/{line_item_id}
↳ order string

The resource name for 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.
↳ available_units int|string

The number of units, defined by Goal.unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value won't cause an overbook, but lower priority line items may not run.
↳ 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 targeting and delivery settings.
↳ possible_units int|string

The maximum number of units, defined by Goal.unitType, that could be booked by taking inventory away from lower priority line items and some same priority line items. Booking this number may cause lower priority line items and some same priority line items to underdeliver.
↳ reserved_units int|string

The number of reserved units, defined by Goal.unitType, requested. This can be an absolute or percentage value.
↳ breakdowns array<ForecastBreakdown>

The breakdowns for each time window defined in ForecastBreakdownOptions.timeWindows. If no breakdown was requested through AvailabilityForecastOptions.breakdown, this field will be empty.
↳ targeting_criteria_breakdowns array<TargetingCriteriaBreakdown>

The forecast result broken down by the targeting of the forecasted line item.
↳ contending_line_items array<ContendingLineItem>

List of ContendingLineItem contending line items for this forecast.
↳ alternative_unit_type_forecasts array<AlternativeUnitTypeForecast>

Views of this forecast, with alternative unit types.
↳ demographic_breakdowns array<GrpDemographicBreakdown>

The forecast result broken down by demographics.

getLineItem

Uniquely identifies this availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the resource name of the LineItem object it represents, or null if the forecast represents a prospective line item. Format: networks/{network_code}/lineItems/{line_item_id}

Returns
Type Description
string

hasLineItem

clearLineItem

setLineItem

Uniquely identifies this availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the resource name of the LineItem object it represents, or null if the forecast represents a prospective line item. Format: networks/{network_code}/lineItems/{line_item_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getOrder

The resource name for 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 for 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

getAvailableUnits

The number of units, defined by Goal.unitType, that can be booked without affecting the delivery of any reserved line items.

Exceeding this value won't cause an overbook, but lower priority line items may not run.

Returns
Type Description
int|string

hasAvailableUnits

clearAvailableUnits

setAvailableUnits

The number of units, defined by Goal.unitType, that can be booked without affecting the delivery of any reserved line items.

Exceeding this value won't cause an overbook, but lower priority line items may not run.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDeliveredUnits

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

Returns
Type Description
int|string

hasDeliveredUnits

clearDeliveredUnits

setDeliveredUnits

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getMatchedUnits

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

Returns
Type Description
int|string

hasMatchedUnits

clearMatchedUnits

setMatchedUnits

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPossibleUnits

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

Booking this number may cause lower priority line items and some same priority line items to underdeliver.

Returns
Type Description
int|string

hasPossibleUnits

clearPossibleUnits

setPossibleUnits

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

Booking this number may cause lower priority line items and some same priority line items to underdeliver.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getReservedUnits

The number of reserved units, defined by Goal.unitType, requested. This can be an absolute or percentage value.

Returns
Type Description
int|string

hasReservedUnits

clearReservedUnits

setReservedUnits

The number of reserved units, defined by Goal.unitType, requested. This can be an absolute or percentage value.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getBreakdowns

The breakdowns for each time window defined in ForecastBreakdownOptions.timeWindows.

If no breakdown was requested through AvailabilityForecastOptions.breakdown, this field will be empty.

Returns
Type Description
Google\Protobuf\RepeatedField<ForecastBreakdown>

setBreakdowns

The breakdowns for each time window defined in ForecastBreakdownOptions.timeWindows.

If no breakdown was requested through AvailabilityForecastOptions.breakdown, this field will be empty.

Parameter
Name Description
var array<ForecastBreakdown>
Returns
Type Description
$this

getTargetingCriteriaBreakdowns

The forecast result broken down by the targeting of the forecasted line item.

Returns
Type Description
Google\Protobuf\RepeatedField<TargetingCriteriaBreakdown>

setTargetingCriteriaBreakdowns

The forecast result broken down by the targeting of the forecasted line item.

Parameter
Name Description
var array<TargetingCriteriaBreakdown>
Returns
Type Description
$this

getContendingLineItems

List of ContendingLineItem contending line items for this forecast.

Returns
Type Description
Google\Protobuf\RepeatedField<ContendingLineItem>

setContendingLineItems

List of ContendingLineItem contending line items for this forecast.

Parameter
Name Description
var array<ContendingLineItem>
Returns
Type Description
$this

getAlternativeUnitTypeForecasts

Views of this forecast, with alternative unit types.

Returns
Type Description
Google\Protobuf\RepeatedField<AlternativeUnitTypeForecast>

setAlternativeUnitTypeForecasts

Views of this forecast, with alternative unit types.

Parameter
Name Description
var array<AlternativeUnitTypeForecast>
Returns
Type Description
$this

getDemographicBreakdowns

The forecast result broken down by demographics.

Returns
Type Description
Google\Protobuf\RepeatedField<GrpDemographicBreakdown>

setDemographicBreakdowns

The forecast result broken down by demographics.

Parameter
Name Description
var array<GrpDemographicBreakdown>
Returns
Type Description
$this