Ads API .NET library
|
Describes predicted inventory availability for a ProspectiveLineItem. More...
Properties | |
long | lineItemId [get, set] |
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 ID of the LineItem object it represents, or More... | |
bool | lineItemIdSpecified [get, set] |
long | orderId [get, set] |
The unique ID for the Order object that this line item belongs to, or More... | |
bool | orderIdSpecified [get, set] |
UnitType | unitType [get, set] |
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. More... | |
bool | unitTypeSpecified [get, set] |
long | availableUnits [get, set] |
The number of units, defined by Goal::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. More... | |
bool | availableUnitsSpecified [get, set] |
long | deliveredUnits [get, set] |
The number of units, defined by Goal::unitType, that have already been served if the reservation is already running. More... | |
bool | deliveredUnitsSpecified [get, set] |
long | matchedUnits [get, set] |
The number of units, defined by Goal::unitType, that match the specified targeting and delivery settings. More... | |
bool | matchedUnitsSpecified [get, set] |
long | possibleUnits [get, set] |
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. More... | |
bool | possibleUnitsSpecified [get, set] |
long | reservedUnits [get, set] |
The number of reserved units, defined by Goal::unitType, requested. This can be an absolute or percentage value. More... | |
bool | reservedUnitsSpecified [get, set] |
ForecastBreakdown[] | breakdowns [get, set] |
The breakdowns for each time window defined in ForecastBreakdownOptions::timeWindows. More... | |
TargetingCriteriaBreakdown[] | targetingCriteriaBreakdowns [get, set] |
The forecast result broken down by the targeting of the forecasted line item. More... | |
ContendingLineItem[] | contendingLineItems [get, set] |
List of contending line items for this forecast. More... | |
AlternativeUnitTypeForecast[] | alternativeUnitTypeForecasts [get, set] |
Views of this forecast, with alternative unit types. More... | |
Describes predicted inventory availability for a ProspectiveLineItem.
Inventory has three threshold values along a line of possible inventory. From least to most, these are:
Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.
|
getset |
Views of this forecast, with alternative unit types.
|
getset |
The number of units, defined by Goal::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.
Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecast.Run(), and Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecastById.Run().
|
getset |
true
, if a value is specified for availableUnits, false
otherwise.
|
getset |
The breakdowns for each time window defined in ForecastBreakdownOptions::timeWindows.
If no breakdown was requested through AvailabilityForecastOptions::breakdown, this field will be empty. If targeting breakdown was requested by ForecastBreakdownOptions::targets with no time breakdown, this list will contain a single ForecastBreakdown corresponding to the time window of the forecasted LineItem. Otherwise, each time window defined by ForecastBreakdownOptions::timeWindows will correspond to one ForecastBreakdown in the same order. Targeting breakdowns for every time window are returned in ForecastBreakdown::breakdownEntries. Some examples: For a targeting breakdown in the form of {IU=B, creative=1x1
]}}, the #breakdowns field may look like: [ForecastBreakdown{breakdownEntries=[availableUnits=10, availableUnits=20]
]} where the entries correspond to } and
{IU=B, creative=1x1
} respectively. For a time breakdown in the form of 2am, 3am]
}, the field may look like:
[ ForecastBreakdown{startTime=1am, endTime=2am,
breakdownEntries=[availableUnits=10]
, ForecastBreakdown{startTime=2am,
endTime=3am, breakdownEntries=[availableUnits=20]} ] }
where the two #ForecastBreakdown correspond to the [1am, 2am) and [2am, 3am) time windows respecively. For a two-dimensional breakdown in the form of 2am, 3am], targets=[IU=A, IU=B]
, the breakdowns
field may look like:
[
ForecastBreakdown{startTime=1am, endTime=2am,
breakdownEntries=[availableUnits=10, availableUnits=100]
,
ForecastBreakdown{startTime=2am, endTime=3am,
breakdownEntries=[availableUnits=20, availableUnits=200]} ] }
where the first ForecastBreakdown respresents the [1am, 2am) time window with two entries for the IU A and IU B respectively; and the second ForecastBreakdown represents the [2am, 3am) time window also with two entries corresponding to the two IUs.
Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecast.Run().
|
getset |
List of contending line items for this forecast.
Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecastById.Run().
|
getset |
The number of units, defined by Goal::unitType, that have already been served if the reservation is already running.
|
getset |
true
, if a value is specified for deliveredUnits, false
otherwise.
|
getset |
|
getset |
true
, if a value is specified for lineItemId, false
otherwise.
|
getset |
The number of units, defined by Goal::unitType, that match the specified targeting and delivery settings.
|
getset |
true
, if a value is specified for matchedUnits, false
otherwise.
|
getset |
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.
|
getset |
true
, if a value is specified for orderId, false
otherwise.
|
getset |
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.
Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.
Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecast.Run(), and Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecastById.Run().
|
getset |
true
, if a value is specified for possibleUnits, false
otherwise.
Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecast.Run(), and Google.Api.Ads.AdManager.Examples.CSharp.v202405.GetAvailabilityForecastById.Run().
|
getset |
The number of reserved units, defined by Goal::unitType, requested. This can be an absolute or percentage value.
|
getset |
true
, if a value is specified for reservedUnits, false
otherwise.
|
getset |
The forecast result broken down by the targeting of the forecasted line item.
|
getset |
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.
|
getset |
true
, if a value is specified for unitType, false
otherwise.