Class HistoricalBasisVolumeSettings.Builder (0.62.0)

public static final class HistoricalBasisVolumeSettings.Builder extends GeneratedMessage.Builder<HistoricalBasisVolumeSettings.Builder> implements HistoricalBasisVolumeSettingsOrBuilder

Settings to specify the volume of ad opportunities per day over the ForecastAdjustment date range based on the traffic volume of a historical reference period. The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment. The number of days included in the historical date range does not need to be the same as the number of days included in the adjustment date range.

Protobuf type google.ads.admanager.v1.HistoricalBasisVolumeSettings

Static Methods

getDescriptor()

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

Methods

build()

public HistoricalBasisVolumeSettings build()
Returns
Type Description
HistoricalBasisVolumeSettings

buildPartial()

public HistoricalBasisVolumeSettings buildPartial()
Returns
Type Description
HistoricalBasisVolumeSettings

clear()

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

clearHistoricalDateRange()

public HistoricalBasisVolumeSettings.Builder clearHistoricalDateRange()

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

clearMultiplierMilliPercent()

public HistoricalBasisVolumeSettings.Builder clearMultiplierMilliPercent()

Required. The multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000.

optional int64 multiplier_milli_percent = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

This builder for chaining.

clearTargeting()

public HistoricalBasisVolumeSettings.Builder clearTargeting()

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

clearUseParentTrafficForecastSegmentTargeting()

public HistoricalBasisVolumeSettings.Builder clearUseParentTrafficForecastSegmentTargeting()

Whether the parent traffic forecast segment targeting's or the targeting's historical volume data should be used.

optional bool use_parent_traffic_forecast_segment_targeting = 1;

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

This builder for chaining.

getDefaultInstanceForType()

public HistoricalBasisVolumeSettings getDefaultInstanceForType()
Returns
Type Description
HistoricalBasisVolumeSettings

getDescriptorForType()

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

getHistoricalDateRange()

public DateRange getHistoricalDateRange()

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DateRange

The historicalDateRange.

getHistoricalDateRangeBuilder()

public DateRange.Builder getHistoricalDateRangeBuilder()

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DateRange.Builder

getHistoricalDateRangeOrBuilder()

public DateRangeOrBuilder getHistoricalDateRangeOrBuilder()

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DateRangeOrBuilder

getMultiplierMilliPercent()

public long getMultiplierMilliPercent()

Required. The multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000.

optional int64 multiplier_milli_percent = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The multiplierMilliPercent.

getTargeting()

public Targeting getTargeting()

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Targeting

The targeting.

getTargetingBuilder()

public Targeting.Builder getTargetingBuilder()

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Targeting.Builder

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TargetingOrBuilder

getUseParentTrafficForecastSegmentTargeting()

public boolean getUseParentTrafficForecastSegmentTargeting()

Whether the parent traffic forecast segment targeting's or the targeting's historical volume data should be used.

optional bool use_parent_traffic_forecast_segment_targeting = 1;

Returns
Type Description
boolean

The useParentTrafficForecastSegmentTargeting.

hasHistoricalDateRange()

public boolean hasHistoricalDateRange()

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the historicalDateRange field is set.

hasMultiplierMilliPercent()

public boolean hasMultiplierMilliPercent()

Required. The multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000.

optional int64 multiplier_milli_percent = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the multiplierMilliPercent field is set.

hasTargeting()

public boolean hasTargeting()

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the targeting field is set.

hasUseParentTrafficForecastSegmentTargeting()

public boolean hasUseParentTrafficForecastSegmentTargeting()

Whether the parent traffic forecast segment targeting's or the targeting's historical volume data should be used.

optional bool use_parent_traffic_forecast_segment_targeting = 1;

Returns
Type Description
boolean

Whether the useParentTrafficForecastSegmentTargeting field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HistoricalBasisVolumeSettings other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHistoricalDateRange(DateRange value)

public HistoricalBasisVolumeSettings.Builder mergeHistoricalDateRange(DateRange value)

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DateRange
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

mergeTargeting(Targeting value)

public HistoricalBasisVolumeSettings.Builder mergeTargeting(Targeting value)

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Targeting
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

setHistoricalDateRange(DateRange value)

public HistoricalBasisVolumeSettings.Builder setHistoricalDateRange(DateRange value)

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DateRange
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

setHistoricalDateRange(DateRange.Builder builderForValue)

public HistoricalBasisVolumeSettings.Builder setHistoricalDateRange(DateRange.Builder builderForValue)

Required. The date range to use for the historical ad opportunity volume.

.google.ads.admanager.v1.DateRange historical_date_range = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue DateRange.Builder
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

setMultiplierMilliPercent(long value)

public HistoricalBasisVolumeSettings.Builder setMultiplierMilliPercent(long value)

Required. The multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000.

optional int64 multiplier_milli_percent = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value long

The multiplierMilliPercent to set.

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

This builder for chaining.

setTargeting(Targeting value)

public HistoricalBasisVolumeSettings.Builder setTargeting(Targeting value)

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Targeting
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

setTargeting(Targeting.Builder builderForValue)

public HistoricalBasisVolumeSettings.Builder setTargeting(Targeting.Builder builderForValue)

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.

.google.ads.admanager.v1.Targeting targeting = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Targeting.Builder
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

setUseParentTrafficForecastSegmentTargeting(boolean value)

public HistoricalBasisVolumeSettings.Builder setUseParentTrafficForecastSegmentTargeting(boolean value)

Whether the parent traffic forecast segment targeting's or the targeting's historical volume data should be used.

optional bool use_parent_traffic_forecast_segment_targeting = 1;

Parameter
Name Description
value boolean

The useParentTrafficForecastSegmentTargeting to set.

Returns
Type Description
HistoricalBasisVolumeSettings.Builder

This builder for chaining.