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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ALLOW_ADJUSTING_FORECAST_ABOVE_RECOMMENDED_LIMIT_FIELD_NUMBER
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ForecastAdjustment.Builder newBuilder()
newBuilder(ForecastAdjustment prototype)
public static ForecastAdjustment.Builder newBuilder(ForecastAdjustment prototype)
public static ForecastAdjustment parseDelimitedFrom(InputStream input)
public static ForecastAdjustment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ForecastAdjustment parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ForecastAdjustment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ForecastAdjustment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ForecastAdjustment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ForecastAdjustment parseFrom(CodedInputStream input)
public static ForecastAdjustment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ForecastAdjustment parseFrom(InputStream input)
public static ForecastAdjustment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ForecastAdjustment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ForecastAdjustment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ForecastAdjustment> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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];
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];
getDefaultInstanceForType()
public ForecastAdjustment getDefaultInstanceForType()
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];
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];
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()
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];
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];
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];
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()
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];
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ForecastAdjustment.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected ForecastAdjustment.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public ForecastAdjustment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides