Class ForecastAdjustment (0.62.0)

public final class ForecastAdjustment extends GeneratedMessage implements ForecastAdjustmentOrBuilder

Provides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.

Protobuf type google.ads.admanager.v1.ForecastAdjustment

Static Fields

public static final int ALLOW_ADJUSTING_FORECAST_ABOVE_RECOMMENDED_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

CALCULATED_DAILY_AD_OPPORTUNITY_COUNTS_FIELD_NUMBER

public static final int CALCULATED_DAILY_AD_OPPORTUNITY_COUNTS_FIELD_NUMBER
Field Value
Type Description
int

DAILY_VOLUME_SETTINGS_FIELD_NUMBER

public static final int DAILY_VOLUME_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DATE_RANGE_FIELD_NUMBER

public static final int DATE_RANGE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HISTORICAL_BASIS_VOLUME_SETTINGS_FIELD_NUMBER

public static final int HISTORICAL_BASIS_VOLUME_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_VOLUME_SETTINGS_FIELD_NUMBER

public static final int TOTAL_VOLUME_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_FORECAST_SEGMENT_FIELD_NUMBER

public static final int TRAFFIC_FORECAST_SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_TYPE_FIELD_NUMBER

public static final int VOLUME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ForecastAdjustment getDefaultInstance()
Returns
Type Description
ForecastAdjustment

getDescriptor()

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

newBuilder()

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

newBuilder(ForecastAdjustment prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowAdjustingForecastAboveRecommendedLimit()

public boolean getAllowAdjustingForecastAboveRecommendedLimit()

Input only. Whether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast. Note that this field will not persist on the adjustment itself, and will only affect the current request.

optional bool allow_adjusting_forecast_above_recommended_limit = 8 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The allowAdjustingForecastAboveRecommendedLimit.

getCalculatedDailyAdOpportunityCounts(int index)

public long getCalculatedDailyAdOpportunityCounts(int index)

Output only. The daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a dateRange of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17. This field is read-only and is populated by Google after forecast adjustment creation or update.

repeated int64 calculated_daily_ad_opportunity_counts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The calculatedDailyAdOpportunityCounts at the given index.

getCalculatedDailyAdOpportunityCountsCount()

public int getCalculatedDailyAdOpportunityCountsCount()

Output only. The daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a dateRange of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17. This field is read-only and is populated by Google after forecast adjustment creation or update.

repeated int64 calculated_daily_ad_opportunity_counts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of calculatedDailyAdOpportunityCounts.

getCalculatedDailyAdOpportunityCountsList()

public List<Long> getCalculatedDailyAdOpportunityCountsList()

Output only. The daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a dateRange of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17. This field is read-only and is populated by Google after forecast adjustment creation or update.

repeated int64 calculated_daily_ad_opportunity_counts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Long>

A list containing the calculatedDailyAdOpportunityCounts.

getDailyVolumeSettings()

public DailyVolumeSettings getDailyVolumeSettings()

Optional. The daily number of ad opportunities for each day in the adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.DAILY_VOLUME and ignored otherwise.

.google.ads.admanager.v1.DailyVolumeSettings daily_volume_settings = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DailyVolumeSettings

The dailyVolumeSettings.

getDailyVolumeSettingsOrBuilder()

public DailyVolumeSettingsOrBuilder getDailyVolumeSettingsOrBuilder()

Optional. The daily number of ad opportunities for each day in the adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.DAILY_VOLUME and ignored otherwise.

.google.ads.admanager.v1.DailyVolumeSettings daily_volume_settings = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DailyVolumeSettingsOrBuilder

getDateRange()

public DateRange getDateRange()

Required. The date range of the adjustment.

.google.ads.admanager.v1.DateRange date_range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DateRange

The dateRange.

getDateRangeOrBuilder()

public DateRangeOrBuilder getDateRangeOrBuilder()

Required. The date range of the adjustment.

.google.ads.admanager.v1.DateRange date_range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DateRangeOrBuilder

getDefaultInstanceForType()

public ForecastAdjustment getDefaultInstanceForType()
Returns
Type Description
ForecastAdjustment

getDisplayName()

public String getDisplayName()

Required. Display name of the ForecastAdjustment.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the ForecastAdjustment.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getHistoricalBasisVolumeSettings()

public HistoricalBasisVolumeSettings getHistoricalBasisVolumeSettings()

Optional. The daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if volumeType is ForecastAdjustmentVolumeType.HISTORICAL_BASIS_VOLUME and ignored otherwise.

.google.ads.admanager.v1.HistoricalBasisVolumeSettings historical_basis_volume_settings = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HistoricalBasisVolumeSettings

The historicalBasisVolumeSettings.

getHistoricalBasisVolumeSettingsOrBuilder()

public HistoricalBasisVolumeSettingsOrBuilder getHistoricalBasisVolumeSettingsOrBuilder()

Optional. The daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if volumeType is ForecastAdjustmentVolumeType.HISTORICAL_BASIS_VOLUME and ignored otherwise.

.google.ads.admanager.v1.HistoricalBasisVolumeSettings historical_basis_volume_settings = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HistoricalBasisVolumeSettingsOrBuilder

getName()

public String getName()

Identifier. The resource name of the ForecastAdjustment. Format: networks/{network_code}/forecastAdjustments/{forecastAdjustmentId}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the ForecastAdjustment. Format: networks/{network_code}/forecastAdjustments/{forecastAdjustmentId}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus getStatus()

Output only. The status of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTotalVolumeSettings()

public TotalVolumeSettings getTotalVolumeSettings()

Optional. The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.TOTAL_VOLUME and ignored otherwise.

.google.ads.admanager.v1.TotalVolumeSettings total_volume_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TotalVolumeSettings

The totalVolumeSettings.

getTotalVolumeSettingsOrBuilder()

public TotalVolumeSettingsOrBuilder getTotalVolumeSettingsOrBuilder()

Optional. The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.TOTAL_VOLUME and ignored otherwise.

.google.ads.admanager.v1.TotalVolumeSettings total_volume_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TotalVolumeSettingsOrBuilder

getTrafficForecastSegment()

public String getTrafficForecastSegment()

Required. Immutable. The resource name of the TrafficForecastSegment that this adjustment is associated with. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

optional string traffic_forecast_segment = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The trafficForecastSegment.

getTrafficForecastSegmentBytes()

public ByteString getTrafficForecastSegmentBytes()

Required. Immutable. The resource name of the TrafficForecastSegment that this adjustment is associated with. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

optional string traffic_forecast_segment = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for trafficForecastSegment.

getVolumeSettingsCase()

public ForecastAdjustment.VolumeSettingsCase getVolumeSettingsCase()
Returns
Type Description
ForecastAdjustment.VolumeSettingsCase

getVolumeType()

public ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType getVolumeType()

Required. The volume type of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType volume_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType

The volumeType.

getVolumeTypeValue()

public int getVolumeTypeValue()

Required. The volume type of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType volume_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for volumeType.

hasAllowAdjustingForecastAboveRecommendedLimit()

public boolean hasAllowAdjustingForecastAboveRecommendedLimit()

Input only. Whether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast. Note that this field will not persist on the adjustment itself, and will only affect the current request.

optional bool allow_adjusting_forecast_above_recommended_limit = 8 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the allowAdjustingForecastAboveRecommendedLimit field is set.

hasDailyVolumeSettings()

public boolean hasDailyVolumeSettings()

Optional. The daily number of ad opportunities for each day in the adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.DAILY_VOLUME and ignored otherwise.

.google.ads.admanager.v1.DailyVolumeSettings daily_volume_settings = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dailyVolumeSettings field is set.

hasDateRange()

public boolean hasDateRange()

Required. The date range of the adjustment.

.google.ads.admanager.v1.DateRange date_range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the dateRange field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Display name of the ForecastAdjustment.

optional string display_name = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasHistoricalBasisVolumeSettings()

public boolean hasHistoricalBasisVolumeSettings()

Optional. The daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if volumeType is ForecastAdjustmentVolumeType.HISTORICAL_BASIS_VOLUME and ignored otherwise.

.google.ads.admanager.v1.HistoricalBasisVolumeSettings historical_basis_volume_settings = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the historicalBasisVolumeSettings field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasTotalVolumeSettings()

public boolean hasTotalVolumeSettings()

Optional. The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.TOTAL_VOLUME and ignored otherwise.

.google.ads.admanager.v1.TotalVolumeSettings total_volume_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the totalVolumeSettings field is set.

hasTrafficForecastSegment()

public boolean hasTrafficForecastSegment()

Required. Immutable. The resource name of the TrafficForecastSegment that this adjustment is associated with. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

optional string traffic_forecast_segment = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the trafficForecastSegment field is set.

hasVolumeType()

public boolean hasVolumeType()

Required. The volume type of the adjustment.

optional .google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType volume_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the volumeType 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 ForecastAdjustment.Builder newBuilderForType()
Returns
Type Description
ForecastAdjustment.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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