Interface ForecastAdjustmentOrBuilder (0.62.0)

public interface ForecastAdjustmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowAdjustingForecastAboveRecommendedLimit()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ForecastAdjustment.VolumeSettingsCase getVolumeSettingsCase()
Returns
Type Description
ForecastAdjustment.VolumeSettingsCase

getVolumeType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.