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.

Inheritance

object

AvailabilityForecast

Implements

IMessage<AvailabilityForecast>

IEquatable<AvailabilityForecast>

IDeepCloneable<AvailabilityForecast>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class AvailabilityForecast : IMessage<AvailabilityForecast>, IEquatable<AvailabilityForecast>, IDeepCloneable<AvailabilityForecast>, IBufferMessage, IMessage

Constructors

AvailabilityForecast()

Declaration

public AvailabilityForecast()

AvailabilityForecast(AvailabilityForecast)

Declaration

public AvailabilityForecast(AvailabilityForecast other)

Parameters

Type	Name	Description
AvailabilityForecast	other

Properties

AlternativeUnitTypeForecasts

Views of this forecast, with alternative unit types.

Declaration

public RepeatedField<AlternativeUnitTypeForecast> AlternativeUnitTypeForecasts { get; }

Property Value

Type	Description
RepeatedField<AlternativeUnitTypeForecast>

AvailableUnits

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.

Declaration

public long AvailableUnits { get; set; }

Property Value

Type	Description
long

Breakdowns

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

If no breakdown was requested through [AvailabilityForecastOptions.breakdown][google.ads.admanager.v1.AvailabilityForecastOptions.breakdown], this field will be empty.

Declaration

public RepeatedField<ForecastBreakdown> Breakdowns { get; }

Property Value

Type	Description
RepeatedField<ForecastBreakdown>

ContendingLineItems

List of ContendingLineItem contending line items for this forecast.

Declaration

public RepeatedField<ContendingLineItem> ContendingLineItems { get; }

Property Value

Type	Description
RepeatedField<ContendingLineItem>

DeliveredUnits

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

Declaration

public long DeliveredUnits { get; set; }

Property Value

Type	Description
long

DemographicBreakdowns

The forecast result broken down by demographics.

Declaration

public RepeatedField<GrpDemographicBreakdown> DemographicBreakdowns { get; }

Property Value

Type	Description
RepeatedField<GrpDemographicBreakdown>

HasAvailableUnits

Gets whether the "available_units" field is set

Declaration

public bool HasAvailableUnits { get; }

Property Value

Type	Description
bool

HasDeliveredUnits

Gets whether the "delivered_units" field is set

Declaration

public bool HasDeliveredUnits { get; }

Property Value

Type	Description
bool

HasLineItem

Gets whether the "line_item" field is set

Declaration

public bool HasLineItem { get; }

Property Value

Type	Description
bool

HasMatchedUnits

Gets whether the "matched_units" field is set

Declaration

public bool HasMatchedUnits { get; }

Property Value

Type	Description
bool

HasOrder

Gets whether the "order" field is set

Declaration

public bool HasOrder { get; }

Property Value

Type	Description
bool

HasPossibleUnits

Gets whether the "possible_units" field is set

Declaration

public bool HasPossibleUnits { get; }

Property Value

Type	Description
bool

HasReservedUnits

Gets whether the "reserved_units" field is set

Declaration

public bool HasReservedUnits { get; }

Property Value

Type	Description
bool

HasUnitType

Gets whether the "unit_type" field is set

Declaration

public bool HasUnitType { get; }

Property Value

Type	Description
bool

LineItem

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][google.ads.admanager.v1.LineItem] object it represents, or null if the forecast represents a prospective line item. Format: networks/{network_code}/lineItems/{line_item_id}

Declaration

public string LineItem { get; set; }

Property Value

Type	Description
string

LineItemAsLineItemName

LineItemName-typed view over the LineItem resource name property.

Declaration

public LineItemName LineItemAsLineItemName { get; set; }

Property Value

Type	Description
LineItemName

MatchedUnits

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

Declaration

public long MatchedUnits { get; set; }

Property Value

Type	Description
long

Order

The resource name for the [Order][google.ads.admanager.v1.Order] object that this line item belongs to, or null if the forecast represents a prospective line item without an [LineItem.order][google.ads.admanager.v1.LineItem.order] set. Format: networks/{network_code}/orders/{order_id}

Declaration

public string Order { get; set; }

Property Value

Type	Description
string

OrderAsOrderName

OrderName-typed view over the Order resource name property.

Declaration

public OrderName OrderAsOrderName { get; set; }

Property Value

Type	Description
OrderName

PossibleUnits

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.

Declaration

public long PossibleUnits { get; set; }

Property Value

Type	Description
long

ReservedUnits

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

Declaration

public long ReservedUnits { get; set; }

Property Value

Type	Description
long

TargetingCriteriaBreakdowns

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

Declaration

public RepeatedField<TargetingCriteriaBreakdown> TargetingCriteriaBreakdowns { get; }

Property Value

Type	Description
RepeatedField<TargetingCriteriaBreakdown>

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.

Declaration

public UnitTypeEnum.Types.UnitType UnitType { get; set; }

Property Value

Type	Description
UnitTypeEnum.Types.UnitType