Class HistoricalBasisVolumeSettings (0.62.0)

public final class HistoricalBasisVolumeSettings extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > HistoricalBasisVolumeSettings

Static Fields

HISTORICAL_DATE_RANGE_FIELD_NUMBER

public static final int HISTORICAL_DATE_RANGE_FIELD_NUMBER
Field Value
Type Description
int

MULTIPLIER_MILLI_PERCENT_FIELD_NUMBER

public static final int MULTIPLIER_MILLI_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

TARGETING_FIELD_NUMBER

public static final int TARGETING_FIELD_NUMBER
Field Value
Type Description
int

USE_PARENT_TRAFFIC_FORECAST_SEGMENT_TARGETING_FIELD_NUMBER

public static final int USE_PARENT_TRAFFIC_FORECAST_SEGMENT_TARGETING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HistoricalBasisVolumeSettings getDefaultInstance()
Returns
Type Description
HistoricalBasisVolumeSettings

getDescriptor()

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

newBuilder()

public static HistoricalBasisVolumeSettings.Builder newBuilder()
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

newBuilder(HistoricalBasisVolumeSettings prototype)

public static HistoricalBasisVolumeSettings.Builder newBuilder(HistoricalBasisVolumeSettings prototype)
Parameter
Name Description
prototype HistoricalBasisVolumeSettings
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

parseDelimitedFrom(InputStream input)

public static HistoricalBasisVolumeSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HistoricalBasisVolumeSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HistoricalBasisVolumeSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HistoricalBasisVolumeSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HistoricalBasisVolumeSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HistoricalBasisVolumeSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HistoricalBasisVolumeSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HistoricalBasisVolumeSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HistoricalBasisVolumeSettings> parser()
Returns
Type Description
Parser<HistoricalBasisVolumeSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HistoricalBasisVolumeSettings getDefaultInstanceForType()
Returns
Type Description
HistoricalBasisVolumeSettings

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.

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.

getParserForType()

public Parser<HistoricalBasisVolumeSettings> getParserForType()
Returns
Type Description
Parser<HistoricalBasisVolumeSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HistoricalBasisVolumeSettings.Builder newBuilderForType()
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected HistoricalBasisVolumeSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HistoricalBasisVolumeSettings.Builder
Overrides

toBuilder()

public HistoricalBasisVolumeSettings.Builder toBuilder()
Returns
Type Description
HistoricalBasisVolumeSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException