Class AvailabilityForecast.Builder (0.62.0)

public static final class AvailabilityForecast.Builder extends GeneratedMessage.Builder<AvailabilityForecast.Builder> implements AvailabilityForecastOrBuilder

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.

Protobuf type google.ads.admanager.v1.AvailabilityForecast

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAlternativeUnitTypeForecasts(Iterable<? extends AlternativeUnitTypeForecast> values)

public AvailabilityForecast.Builder addAllAlternativeUnitTypeForecasts(Iterable<? extends AlternativeUnitTypeForecast> values)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AlternativeUnitTypeForecast>
Returns
Type Description
AvailabilityForecast.Builder

addAllBreakdowns(Iterable<? extends ForecastBreakdown> values)

public AvailabilityForecast.Builder addAllBreakdowns(Iterable<? extends ForecastBreakdown> values)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ForecastBreakdown>
Returns
Type Description
AvailabilityForecast.Builder

addAllContendingLineItems(Iterable<? extends ContendingLineItem> values)

public AvailabilityForecast.Builder addAllContendingLineItems(Iterable<? extends ContendingLineItem> values)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ContendingLineItem>
Returns
Type Description
AvailabilityForecast.Builder

addAllDemographicBreakdowns(Iterable<? extends GrpDemographicBreakdown> values)

public AvailabilityForecast.Builder addAllDemographicBreakdowns(Iterable<? extends GrpDemographicBreakdown> values)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.GrpDemographicBreakdown>
Returns
Type Description
AvailabilityForecast.Builder

addAllTargetingCriteriaBreakdowns(Iterable<? extends TargetingCriteriaBreakdown> values)

public AvailabilityForecast.Builder addAllTargetingCriteriaBreakdowns(Iterable<? extends TargetingCriteriaBreakdown> values)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.TargetingCriteriaBreakdown>
Returns
Type Description
AvailabilityForecast.Builder

addAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast value)

public AvailabilityForecast.Builder addAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast value)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
value AlternativeUnitTypeForecast
Returns
Type Description
AvailabilityForecast.Builder

addAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast.Builder builderForValue)

public AvailabilityForecast.Builder addAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast.Builder builderForValue)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
builderForValue AlternativeUnitTypeForecast.Builder
Returns
Type Description
AvailabilityForecast.Builder

addAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast value)

public AvailabilityForecast.Builder addAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast value)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameters
Name Description
index int
value AlternativeUnitTypeForecast
Returns
Type Description
AvailabilityForecast.Builder

addAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast.Builder builderForValue)

public AvailabilityForecast.Builder addAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast.Builder builderForValue)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameters
Name Description
index int
builderForValue AlternativeUnitTypeForecast.Builder
Returns
Type Description
AvailabilityForecast.Builder

addAlternativeUnitTypeForecastsBuilder()

public AlternativeUnitTypeForecast.Builder addAlternativeUnitTypeForecastsBuilder()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
AlternativeUnitTypeForecast.Builder

addAlternativeUnitTypeForecastsBuilder(int index)

public AlternativeUnitTypeForecast.Builder addAlternativeUnitTypeForecastsBuilder(int index)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
index int
Returns
Type Description
AlternativeUnitTypeForecast.Builder

addBreakdowns(ForecastBreakdown value)

public AvailabilityForecast.Builder addBreakdowns(ForecastBreakdown value)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
value ForecastBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addBreakdowns(ForecastBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addBreakdowns(ForecastBreakdown.Builder builderForValue)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
builderForValue ForecastBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addBreakdowns(int index, ForecastBreakdown value)

public AvailabilityForecast.Builder addBreakdowns(int index, ForecastBreakdown value)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameters
Name Description
index int
value ForecastBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addBreakdowns(int index, ForecastBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addBreakdowns(int index, ForecastBreakdown.Builder builderForValue)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameters
Name Description
index int
builderForValue ForecastBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addBreakdownsBuilder()

public ForecastBreakdown.Builder addBreakdownsBuilder()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
ForecastBreakdown.Builder

addBreakdownsBuilder(int index)

public ForecastBreakdown.Builder addBreakdownsBuilder(int index)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
index int
Returns
Type Description
ForecastBreakdown.Builder

addContendingLineItems(ContendingLineItem value)

public AvailabilityForecast.Builder addContendingLineItems(ContendingLineItem value)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
value ContendingLineItem
Returns
Type Description
AvailabilityForecast.Builder

addContendingLineItems(ContendingLineItem.Builder builderForValue)

public AvailabilityForecast.Builder addContendingLineItems(ContendingLineItem.Builder builderForValue)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
builderForValue ContendingLineItem.Builder
Returns
Type Description
AvailabilityForecast.Builder

addContendingLineItems(int index, ContendingLineItem value)

public AvailabilityForecast.Builder addContendingLineItems(int index, ContendingLineItem value)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameters
Name Description
index int
value ContendingLineItem
Returns
Type Description
AvailabilityForecast.Builder

addContendingLineItems(int index, ContendingLineItem.Builder builderForValue)

public AvailabilityForecast.Builder addContendingLineItems(int index, ContendingLineItem.Builder builderForValue)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameters
Name Description
index int
builderForValue ContendingLineItem.Builder
Returns
Type Description
AvailabilityForecast.Builder

addContendingLineItemsBuilder()

public ContendingLineItem.Builder addContendingLineItemsBuilder()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
ContendingLineItem.Builder

addContendingLineItemsBuilder(int index)

public ContendingLineItem.Builder addContendingLineItemsBuilder(int index)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
index int
Returns
Type Description
ContendingLineItem.Builder

addDemographicBreakdowns(GrpDemographicBreakdown value)

public AvailabilityForecast.Builder addDemographicBreakdowns(GrpDemographicBreakdown value)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
value GrpDemographicBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addDemographicBreakdowns(GrpDemographicBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addDemographicBreakdowns(GrpDemographicBreakdown.Builder builderForValue)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
builderForValue GrpDemographicBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addDemographicBreakdowns(int index, GrpDemographicBreakdown value)

public AvailabilityForecast.Builder addDemographicBreakdowns(int index, GrpDemographicBreakdown value)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameters
Name Description
index int
value GrpDemographicBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addDemographicBreakdowns(int index, GrpDemographicBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addDemographicBreakdowns(int index, GrpDemographicBreakdown.Builder builderForValue)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameters
Name Description
index int
builderForValue GrpDemographicBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addDemographicBreakdownsBuilder()

public GrpDemographicBreakdown.Builder addDemographicBreakdownsBuilder()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
GrpDemographicBreakdown.Builder

addDemographicBreakdownsBuilder(int index)

public GrpDemographicBreakdown.Builder addDemographicBreakdownsBuilder(int index)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
index int
Returns
Type Description
GrpDemographicBreakdown.Builder

addTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown value)

public AvailabilityForecast.Builder addTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown value)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
value TargetingCriteriaBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown.Builder builderForValue)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
builderForValue TargetingCriteriaBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown value)

public AvailabilityForecast.Builder addTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown value)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameters
Name Description
index int
value TargetingCriteriaBreakdown
Returns
Type Description
AvailabilityForecast.Builder

addTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder addTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown.Builder builderForValue)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameters
Name Description
index int
builderForValue TargetingCriteriaBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

addTargetingCriteriaBreakdownsBuilder()

public TargetingCriteriaBreakdown.Builder addTargetingCriteriaBreakdownsBuilder()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
TargetingCriteriaBreakdown.Builder

addTargetingCriteriaBreakdownsBuilder(int index)

public TargetingCriteriaBreakdown.Builder addTargetingCriteriaBreakdownsBuilder(int index)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
index int
Returns
Type Description
TargetingCriteriaBreakdown.Builder

build()

public AvailabilityForecast build()
Returns
Type Description
AvailabilityForecast

buildPartial()

public AvailabilityForecast buildPartial()
Returns
Type Description
AvailabilityForecast

clear()

public AvailabilityForecast.Builder clear()
Returns
Type Description
AvailabilityForecast.Builder
Overrides

clearAlternativeUnitTypeForecasts()

public AvailabilityForecast.Builder clearAlternativeUnitTypeForecasts()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
AvailabilityForecast.Builder

clearAvailableUnits()

public AvailabilityForecast.Builder clearAvailableUnits()

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.

optional int64 available_units = 4;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearBreakdowns()

public AvailabilityForecast.Builder clearBreakdowns()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
AvailabilityForecast.Builder

clearContendingLineItems()

public AvailabilityForecast.Builder clearContendingLineItems()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
AvailabilityForecast.Builder

clearDeliveredUnits()

public AvailabilityForecast.Builder clearDeliveredUnits()

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

optional int64 delivered_units = 5;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearDemographicBreakdowns()

public AvailabilityForecast.Builder clearDemographicBreakdowns()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
AvailabilityForecast.Builder

clearLineItem()

public AvailabilityForecast.Builder clearLineItem()

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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearMatchedUnits()

public AvailabilityForecast.Builder clearMatchedUnits()

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

optional int64 matched_units = 6;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearOrder()

public AvailabilityForecast.Builder clearOrder()

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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearPossibleUnits()

public AvailabilityForecast.Builder clearPossibleUnits()

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.

optional int64 possible_units = 7;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearReservedUnits()

public AvailabilityForecast.Builder clearReservedUnits()

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

optional int64 reserved_units = 8;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

clearTargetingCriteriaBreakdowns()

public AvailabilityForecast.Builder clearTargetingCriteriaBreakdowns()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
AvailabilityForecast.Builder

clearUnitType()

public AvailabilityForecast.Builder clearUnitType()

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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

getAlternativeUnitTypeForecasts(int index)

public AlternativeUnitTypeForecast getAlternativeUnitTypeForecasts(int index)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
index int
Returns
Type Description
AlternativeUnitTypeForecast

getAlternativeUnitTypeForecastsBuilder(int index)

public AlternativeUnitTypeForecast.Builder getAlternativeUnitTypeForecastsBuilder(int index)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
index int
Returns
Type Description
AlternativeUnitTypeForecast.Builder

getAlternativeUnitTypeForecastsBuilderList()

public List<AlternativeUnitTypeForecast.Builder> getAlternativeUnitTypeForecastsBuilderList()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
List<Builder>

getAlternativeUnitTypeForecastsCount()

public int getAlternativeUnitTypeForecastsCount()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
int

getAlternativeUnitTypeForecastsList()

public List<AlternativeUnitTypeForecast> getAlternativeUnitTypeForecastsList()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
List<AlternativeUnitTypeForecast>

getAlternativeUnitTypeForecastsOrBuilder(int index)

public AlternativeUnitTypeForecastOrBuilder getAlternativeUnitTypeForecastsOrBuilder(int index)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
index int
Returns
Type Description
AlternativeUnitTypeForecastOrBuilder

getAlternativeUnitTypeForecastsOrBuilderList()

public List<? extends AlternativeUnitTypeForecastOrBuilder> getAlternativeUnitTypeForecastsOrBuilderList()

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AlternativeUnitTypeForecastOrBuilder>

getAvailableUnits()

public long 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.

optional int64 available_units = 4;

Returns
Type Description
long

The availableUnits.

getBreakdowns(int index)

public ForecastBreakdown getBreakdowns(int index)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
index int
Returns
Type Description
ForecastBreakdown

getBreakdownsBuilder(int index)

public ForecastBreakdown.Builder getBreakdownsBuilder(int index)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
index int
Returns
Type Description
ForecastBreakdown.Builder

getBreakdownsBuilderList()

public List<ForecastBreakdown.Builder> getBreakdownsBuilderList()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
List<Builder>

getBreakdownsCount()

public int getBreakdownsCount()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
int

getBreakdownsList()

public List<ForecastBreakdown> getBreakdownsList()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
List<ForecastBreakdown>

getBreakdownsOrBuilder(int index)

public ForecastBreakdownOrBuilder getBreakdownsOrBuilder(int index)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
index int
Returns
Type Description
ForecastBreakdownOrBuilder

getBreakdownsOrBuilderList()

public List<? extends ForecastBreakdownOrBuilder> getBreakdownsOrBuilderList()

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ForecastBreakdownOrBuilder>

getContendingLineItems(int index)

public ContendingLineItem getContendingLineItems(int index)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
index int
Returns
Type Description
ContendingLineItem

getContendingLineItemsBuilder(int index)

public ContendingLineItem.Builder getContendingLineItemsBuilder(int index)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
index int
Returns
Type Description
ContendingLineItem.Builder

getContendingLineItemsBuilderList()

public List<ContendingLineItem.Builder> getContendingLineItemsBuilderList()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
List<Builder>

getContendingLineItemsCount()

public int getContendingLineItemsCount()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
int

getContendingLineItemsList()

public List<ContendingLineItem> getContendingLineItemsList()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
List<ContendingLineItem>

getContendingLineItemsOrBuilder(int index)

public ContendingLineItemOrBuilder getContendingLineItemsOrBuilder(int index)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
index int
Returns
Type Description
ContendingLineItemOrBuilder

getContendingLineItemsOrBuilderList()

public List<? extends ContendingLineItemOrBuilder> getContendingLineItemsOrBuilderList()

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ContendingLineItemOrBuilder>

getDefaultInstanceForType()

public AvailabilityForecast getDefaultInstanceForType()
Returns
Type Description
AvailabilityForecast

getDeliveredUnits()

public long getDeliveredUnits()

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

optional int64 delivered_units = 5;

Returns
Type Description
long

The deliveredUnits.

getDemographicBreakdowns(int index)

public GrpDemographicBreakdown getDemographicBreakdowns(int index)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
index int
Returns
Type Description
GrpDemographicBreakdown

getDemographicBreakdownsBuilder(int index)

public GrpDemographicBreakdown.Builder getDemographicBreakdownsBuilder(int index)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
index int
Returns
Type Description
GrpDemographicBreakdown.Builder

getDemographicBreakdownsBuilderList()

public List<GrpDemographicBreakdown.Builder> getDemographicBreakdownsBuilderList()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
List<Builder>

getDemographicBreakdownsCount()

public int getDemographicBreakdownsCount()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
int

getDemographicBreakdownsList()

public List<GrpDemographicBreakdown> getDemographicBreakdownsList()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
List<GrpDemographicBreakdown>

getDemographicBreakdownsOrBuilder(int index)

public GrpDemographicBreakdownOrBuilder getDemographicBreakdownsOrBuilder(int index)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
index int
Returns
Type Description
GrpDemographicBreakdownOrBuilder

getDemographicBreakdownsOrBuilderList()

public List<? extends GrpDemographicBreakdownOrBuilder> getDemographicBreakdownsOrBuilderList()

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.GrpDemographicBreakdownOrBuilder>

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLineItem()

public String 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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The lineItem.

getLineItemBytes()

public ByteString getLineItemBytes()

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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for lineItem.

getMatchedUnits()

public long getMatchedUnits()

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

optional int64 matched_units = 6;

Returns
Type Description
long

The matchedUnits.

getOrder()

public String 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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The order.

getOrderBytes()

public ByteString getOrderBytes()

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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for order.

getPossibleUnits()

public long 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.

optional int64 possible_units = 7;

Returns
Type Description
long

The possibleUnits.

getReservedUnits()

public long getReservedUnits()

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

optional int64 reserved_units = 8;

Returns
Type Description
long

The reservedUnits.

getTargetingCriteriaBreakdowns(int index)

public TargetingCriteriaBreakdown getTargetingCriteriaBreakdowns(int index)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
index int
Returns
Type Description
TargetingCriteriaBreakdown

getTargetingCriteriaBreakdownsBuilder(int index)

public TargetingCriteriaBreakdown.Builder getTargetingCriteriaBreakdownsBuilder(int index)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
index int
Returns
Type Description
TargetingCriteriaBreakdown.Builder

getTargetingCriteriaBreakdownsBuilderList()

public List<TargetingCriteriaBreakdown.Builder> getTargetingCriteriaBreakdownsBuilderList()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
List<Builder>

getTargetingCriteriaBreakdownsCount()

public int getTargetingCriteriaBreakdownsCount()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
int

getTargetingCriteriaBreakdownsList()

public List<TargetingCriteriaBreakdown> getTargetingCriteriaBreakdownsList()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
List<TargetingCriteriaBreakdown>

getTargetingCriteriaBreakdownsOrBuilder(int index)

public TargetingCriteriaBreakdownOrBuilder getTargetingCriteriaBreakdownsOrBuilder(int index)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
index int
Returns
Type Description
TargetingCriteriaBreakdownOrBuilder

getTargetingCriteriaBreakdownsOrBuilderList()

public List<? extends TargetingCriteriaBreakdownOrBuilder> getTargetingCriteriaBreakdownsOrBuilderList()

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.TargetingCriteriaBreakdownOrBuilder>

getUnitType()

public UnitTypeEnum.UnitType 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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Returns
Type Description
UnitTypeEnum.UnitType

The unitType.

getUnitTypeValue()

public int getUnitTypeValue()

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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for unitType.

hasAvailableUnits()

public boolean hasAvailableUnits()

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.

optional int64 available_units = 4;

Returns
Type Description
boolean

Whether the availableUnits field is set.

hasDeliveredUnits()

public boolean hasDeliveredUnits()

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

optional int64 delivered_units = 5;

Returns
Type Description
boolean

Whether the deliveredUnits field is set.

hasLineItem()

public boolean hasLineItem()

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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the lineItem field is set.

hasMatchedUnits()

public boolean hasMatchedUnits()

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

optional int64 matched_units = 6;

Returns
Type Description
boolean

Whether the matchedUnits field is set.

hasOrder()

public boolean hasOrder()

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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the order field is set.

hasPossibleUnits()

public boolean hasPossibleUnits()

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.

optional int64 possible_units = 7;

Returns
Type Description
boolean

Whether the possibleUnits field is set.

hasReservedUnits()

public boolean hasReservedUnits()

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

optional int64 reserved_units = 8;

Returns
Type Description
boolean

Whether the reservedUnits field is set.

hasUnitType()

public boolean hasUnitType()

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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Returns
Type Description
boolean

Whether the unitType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AvailabilityForecast other)

public AvailabilityForecast.Builder mergeFrom(AvailabilityForecast other)
Parameter
Name Description
other AvailabilityForecast
Returns
Type Description
AvailabilityForecast.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AvailabilityForecast.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvailabilityForecast.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AvailabilityForecast.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AvailabilityForecast.Builder
Overrides

removeAlternativeUnitTypeForecasts(int index)

public AvailabilityForecast.Builder removeAlternativeUnitTypeForecasts(int index)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameter
Name Description
index int
Returns
Type Description
AvailabilityForecast.Builder

removeBreakdowns(int index)

public AvailabilityForecast.Builder removeBreakdowns(int index)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameter
Name Description
index int
Returns
Type Description
AvailabilityForecast.Builder

removeContendingLineItems(int index)

public AvailabilityForecast.Builder removeContendingLineItems(int index)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameter
Name Description
index int
Returns
Type Description
AvailabilityForecast.Builder

removeDemographicBreakdowns(int index)

public AvailabilityForecast.Builder removeDemographicBreakdowns(int index)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameter
Name Description
index int
Returns
Type Description
AvailabilityForecast.Builder

removeTargetingCriteriaBreakdowns(int index)

public AvailabilityForecast.Builder removeTargetingCriteriaBreakdowns(int index)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameter
Name Description
index int
Returns
Type Description
AvailabilityForecast.Builder

setAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast value)

public AvailabilityForecast.Builder setAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast value)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameters
Name Description
index int
value AlternativeUnitTypeForecast
Returns
Type Description
AvailabilityForecast.Builder

setAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast.Builder builderForValue)

public AvailabilityForecast.Builder setAlternativeUnitTypeForecasts(int index, AlternativeUnitTypeForecast.Builder builderForValue)

Views of this forecast, with alternative unit types.

repeated .google.ads.admanager.v1.AlternativeUnitTypeForecast alternative_unit_type_forecasts = 12;

Parameters
Name Description
index int
builderForValue AlternativeUnitTypeForecast.Builder
Returns
Type Description
AvailabilityForecast.Builder

setAvailableUnits(long value)

public AvailabilityForecast.Builder setAvailableUnits(long value)

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.

optional int64 available_units = 4;

Parameter
Name Description
value long

The availableUnits to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setBreakdowns(int index, ForecastBreakdown value)

public AvailabilityForecast.Builder setBreakdowns(int index, ForecastBreakdown value)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameters
Name Description
index int
value ForecastBreakdown
Returns
Type Description
AvailabilityForecast.Builder

setBreakdowns(int index, ForecastBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder setBreakdowns(int index, ForecastBreakdown.Builder builderForValue)

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

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

repeated .google.ads.admanager.v1.ForecastBreakdown breakdowns = 9;

Parameters
Name Description
index int
builderForValue ForecastBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

setContendingLineItems(int index, ContendingLineItem value)

public AvailabilityForecast.Builder setContendingLineItems(int index, ContendingLineItem value)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameters
Name Description
index int
value ContendingLineItem
Returns
Type Description
AvailabilityForecast.Builder

setContendingLineItems(int index, ContendingLineItem.Builder builderForValue)

public AvailabilityForecast.Builder setContendingLineItems(int index, ContendingLineItem.Builder builderForValue)

List of ContendingLineItem contending line items for this forecast.

repeated .google.ads.admanager.v1.ContendingLineItem contending_line_items = 11;

Parameters
Name Description
index int
builderForValue ContendingLineItem.Builder
Returns
Type Description
AvailabilityForecast.Builder

setDeliveredUnits(long value)

public AvailabilityForecast.Builder setDeliveredUnits(long value)

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

optional int64 delivered_units = 5;

Parameter
Name Description
value long

The deliveredUnits to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setDemographicBreakdowns(int index, GrpDemographicBreakdown value)

public AvailabilityForecast.Builder setDemographicBreakdowns(int index, GrpDemographicBreakdown value)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameters
Name Description
index int
value GrpDemographicBreakdown
Returns
Type Description
AvailabilityForecast.Builder

setDemographicBreakdowns(int index, GrpDemographicBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder setDemographicBreakdowns(int index, GrpDemographicBreakdown.Builder builderForValue)

The forecast result broken down by demographics.

repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;

Parameters
Name Description
index int
builderForValue GrpDemographicBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

setLineItem(String value)

public AvailabilityForecast.Builder setLineItem(String value)

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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The lineItem to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setLineItemBytes(ByteString value)

public AvailabilityForecast.Builder setLineItemBytes(ByteString value)

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}

optional string line_item = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for lineItem to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setMatchedUnits(long value)

public AvailabilityForecast.Builder setMatchedUnits(long value)

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

optional int64 matched_units = 6;

Parameter
Name Description
value long

The matchedUnits to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setOrder(String value)

public AvailabilityForecast.Builder setOrder(String value)

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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The order to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setOrderBytes(ByteString value)

public AvailabilityForecast.Builder setOrderBytes(ByteString value)

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}

optional string order = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for order to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setPossibleUnits(long value)

public AvailabilityForecast.Builder setPossibleUnits(long value)

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.

optional int64 possible_units = 7;

Parameter
Name Description
value long

The possibleUnits to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setReservedUnits(long value)

public AvailabilityForecast.Builder setReservedUnits(long value)

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

optional int64 reserved_units = 8;

Parameter
Name Description
value long

The reservedUnits to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown value)

public AvailabilityForecast.Builder setTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown value)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameters
Name Description
index int
value TargetingCriteriaBreakdown
Returns
Type Description
AvailabilityForecast.Builder

setTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown.Builder builderForValue)

public AvailabilityForecast.Builder setTargetingCriteriaBreakdowns(int index, TargetingCriteriaBreakdown.Builder builderForValue)

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

repeated .google.ads.admanager.v1.TargetingCriteriaBreakdown targeting_criteria_breakdowns = 10;

Parameters
Name Description
index int
builderForValue TargetingCriteriaBreakdown.Builder
Returns
Type Description
AvailabilityForecast.Builder

setUnitType(UnitTypeEnum.UnitType value)

public AvailabilityForecast.Builder setUnitType(UnitTypeEnum.UnitType value)

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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Parameter
Name Description
value UnitTypeEnum.UnitType

The unitType to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.

setUnitTypeValue(int value)

public AvailabilityForecast.Builder setUnitTypeValue(int value)

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.

optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for unitType to set.

Returns
Type Description
AvailabilityForecast.Builder

This builder for chaining.