Class ForecastAdjustment.Builder (0.62.0)

public static final class ForecastAdjustment.Builder extends GeneratedMessage.Builder<ForecastAdjustment.Builder> 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 Methods

getDescriptor()

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

Methods

addAllCalculatedDailyAdOpportunityCounts(Iterable<? extends Long> values)

public ForecastAdjustment.Builder addAllCalculatedDailyAdOpportunityCounts(Iterable<? extends Long> values)

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
values Iterable<? extends java.lang.Long>

The calculatedDailyAdOpportunityCounts to add.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

addCalculatedDailyAdOpportunityCounts(long value)

public ForecastAdjustment.Builder addCalculatedDailyAdOpportunityCounts(long value)

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
value long

The calculatedDailyAdOpportunityCounts to add.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

build()

public ForecastAdjustment build()
Returns
Type Description
ForecastAdjustment

buildPartial()

public ForecastAdjustment buildPartial()
Returns
Type Description
ForecastAdjustment

clear()

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

clearAllowAdjustingForecastAboveRecommendedLimit()

public ForecastAdjustment.Builder clearAllowAdjustingForecastAboveRecommendedLimit()

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
ForecastAdjustment.Builder

This builder for chaining.

clearCalculatedDailyAdOpportunityCounts()

public ForecastAdjustment.Builder clearCalculatedDailyAdOpportunityCounts()

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
ForecastAdjustment.Builder

This builder for chaining.

clearDailyVolumeSettings()

public ForecastAdjustment.Builder clearDailyVolumeSettings()

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
ForecastAdjustment.Builder

clearDateRange()

public ForecastAdjustment.Builder clearDateRange()

Required. The date range of the adjustment.

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

Returns
Type Description
ForecastAdjustment.Builder

clearDisplayName()

public ForecastAdjustment.Builder clearDisplayName()

Required. Display name of the ForecastAdjustment.

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

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

clearHistoricalBasisVolumeSettings()

public ForecastAdjustment.Builder clearHistoricalBasisVolumeSettings()

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
ForecastAdjustment.Builder

clearName()

public ForecastAdjustment.Builder clearName()

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

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

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

clearStatus()

public ForecastAdjustment.Builder clearStatus()

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
ForecastAdjustment.Builder

This builder for chaining.

clearTotalVolumeSettings()

public ForecastAdjustment.Builder clearTotalVolumeSettings()

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
ForecastAdjustment.Builder

clearTrafficForecastSegment()

public ForecastAdjustment.Builder clearTrafficForecastSegment()

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
ForecastAdjustment.Builder

This builder for chaining.

clearVolumeSettings()

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

clearVolumeType()

public ForecastAdjustment.Builder clearVolumeType()

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
ForecastAdjustment.Builder

This builder for chaining.

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.

getDailyVolumeSettingsBuilder()

public DailyVolumeSettings.Builder getDailyVolumeSettingsBuilder()

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.Builder

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.

getDateRangeBuilder()

public DateRange.Builder getDateRangeBuilder()

Required. The date range of the adjustment.

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

Returns
Type Description
DateRange.Builder

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

getDescriptorForType()

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

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.

getHistoricalBasisVolumeSettingsBuilder()

public HistoricalBasisVolumeSettings.Builder getHistoricalBasisVolumeSettingsBuilder()

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.Builder

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.

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.

getTotalVolumeSettingsBuilder()

public TotalVolumeSettings.Builder getTotalVolumeSettingsBuilder()

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.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDailyVolumeSettings(DailyVolumeSettings value)

public ForecastAdjustment.Builder mergeDailyVolumeSettings(DailyVolumeSettings value)

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];

Parameter
Name Description
value DailyVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

mergeDateRange(DateRange value)

public ForecastAdjustment.Builder mergeDateRange(DateRange value)

Required. The date range of the adjustment.

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

Parameter
Name Description
value DateRange
Returns
Type Description
ForecastAdjustment.Builder

mergeFrom(ForecastAdjustment other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings value)

public ForecastAdjustment.Builder mergeHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings value)

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];

Parameter
Name Description
value HistoricalBasisVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

mergeTotalVolumeSettings(TotalVolumeSettings value)

public ForecastAdjustment.Builder mergeTotalVolumeSettings(TotalVolumeSettings value)

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];

Parameter
Name Description
value TotalVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

setAllowAdjustingForecastAboveRecommendedLimit(boolean value)

public ForecastAdjustment.Builder setAllowAdjustingForecastAboveRecommendedLimit(boolean value)

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];

Parameter
Name Description
value boolean

The allowAdjustingForecastAboveRecommendedLimit to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setCalculatedDailyAdOpportunityCounts(int index, long value)

public ForecastAdjustment.Builder setCalculatedDailyAdOpportunityCounts(int index, long value)

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];

Parameters
Name Description
index int

The index to set the value at.

value long

The calculatedDailyAdOpportunityCounts to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setDailyVolumeSettings(DailyVolumeSettings value)

public ForecastAdjustment.Builder setDailyVolumeSettings(DailyVolumeSettings value)

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];

Parameter
Name Description
value DailyVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

setDailyVolumeSettings(DailyVolumeSettings.Builder builderForValue)

public ForecastAdjustment.Builder setDailyVolumeSettings(DailyVolumeSettings.Builder builderForValue)

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];

Parameter
Name Description
builderForValue DailyVolumeSettings.Builder
Returns
Type Description
ForecastAdjustment.Builder

setDateRange(DateRange value)

public ForecastAdjustment.Builder setDateRange(DateRange value)

Required. The date range of the adjustment.

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

Parameter
Name Description
value DateRange
Returns
Type Description
ForecastAdjustment.Builder

setDateRange(DateRange.Builder builderForValue)

public ForecastAdjustment.Builder setDateRange(DateRange.Builder builderForValue)

Required. The date range of the adjustment.

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

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

setDisplayName(String value)

public ForecastAdjustment.Builder setDisplayName(String value)

Required. Display name of the ForecastAdjustment.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ForecastAdjustment.Builder setDisplayNameBytes(ByteString value)

Required. Display name of the ForecastAdjustment.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings value)

public ForecastAdjustment.Builder setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings value)

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];

Parameter
Name Description
value HistoricalBasisVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings.Builder builderForValue)

public ForecastAdjustment.Builder setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings.Builder builderForValue)

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];

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

setName(String value)

public ForecastAdjustment.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ForecastAdjustment.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setStatus(ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus value)

public ForecastAdjustment.Builder setStatus(ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus value)

Output only. The status of the adjustment.

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

Parameter
Name Description
value ForecastAdjustmentStatusEnum.ForecastAdjustmentStatus

The status to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setStatusValue(int value)

public ForecastAdjustment.Builder setStatusValue(int value)

Output only. The status of the adjustment.

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

Parameter
Name Description
value int

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

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setTotalVolumeSettings(TotalVolumeSettings value)

public ForecastAdjustment.Builder setTotalVolumeSettings(TotalVolumeSettings value)

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];

Parameter
Name Description
value TotalVolumeSettings
Returns
Type Description
ForecastAdjustment.Builder

setTotalVolumeSettings(TotalVolumeSettings.Builder builderForValue)

public ForecastAdjustment.Builder setTotalVolumeSettings(TotalVolumeSettings.Builder builderForValue)

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];

Parameter
Name Description
builderForValue TotalVolumeSettings.Builder
Returns
Type Description
ForecastAdjustment.Builder

setTrafficForecastSegment(String value)

public ForecastAdjustment.Builder setTrafficForecastSegment(String value)

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) = { ... }

Parameter
Name Description
value String

The trafficForecastSegment to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setTrafficForecastSegmentBytes(ByteString value)

public ForecastAdjustment.Builder setTrafficForecastSegmentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for trafficForecastSegment to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setVolumeType(ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType value)

public ForecastAdjustment.Builder setVolumeType(ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType value)

Required. The volume type of the adjustment.

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

Parameter
Name Description
value ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType

The volumeType to set.

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.

setVolumeTypeValue(int value)

public ForecastAdjustment.Builder setVolumeTypeValue(int value)

Required. The volume type of the adjustment.

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

Parameter
Name Description
value int

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

Returns
Type Description
ForecastAdjustment.Builder

This builder for chaining.