public interface AvailabilityForecastOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAlternativeUnitTypeForecasts(int index)
public abstract 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 |
|
getAlternativeUnitTypeForecastsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getBreakdownsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getContendingLineItemsCount()
public abstract 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 abstract 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 abstract 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 abstract 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> |
|
getDeliveredUnits()
public abstract 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 abstract 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 |
|
getDemographicBreakdownsCount()
public abstract int getDemographicBreakdownsCount()The forecast result broken down by demographics.
repeated .google.ads.admanager.v1.GrpDemographicBreakdown demographic_breakdowns = 14;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDemographicBreakdownsList()
public abstract 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 abstract 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 abstract 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> |
|
getLineItem()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getTargetingCriteriaBreakdownsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |