java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.ads.googleads.v13.services.Forecast

All Implemented Interfaces:

ForecastOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
```
public final class Forecast
extends com.google.protobuf.GeneratedMessageV3
implements ForecastOrBuilder
```
```
 Forecasted traffic metrics for the planned products and targeting.
 
```
Protobuf type google.ads.googleads.v13.services.Forecast
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Forecast.Builder
Forecasted traffic metrics for the planned products and targeting.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`EFFECTIVE_FREQUENCY_BREAKDOWNS_FIELD_NUMBER`
`static int`	`ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER`
`static int`	`ON_TARGET_COVIEW_REACH_FIELD_NUMBER`
`static int`	`ON_TARGET_IMPRESSIONS_FIELD_NUMBER`
`static int`	`ON_TARGET_REACH_FIELD_NUMBER`
`static int`	`TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER`
`static int`	`TOTAL_COVIEW_REACH_FIELD_NUMBER`
`static int`	`TOTAL_IMPRESSIONS_FIELD_NUMBER`
`static int`	`TOTAL_REACH_FIELD_NUMBER`
`static int`	`VIEWABLE_IMPRESSIONS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`static Forecast`	`getDefaultInstance()`
`Forecast`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`EffectiveFrequencyBreakdown`	`getEffectiveFrequencyBreakdowns(int index)`	A list of effective frequency forecasts.
`int`	`getEffectiveFrequencyBreakdownsCount()`	A list of effective frequency forecasts.
`java.util.List<EffectiveFrequencyBreakdown>`	`getEffectiveFrequencyBreakdownsList()`	A list of effective frequency forecasts.
`EffectiveFrequencyBreakdownOrBuilder`	`getEffectiveFrequencyBreakdownsOrBuilder(int index)`	A list of effective frequency forecasts.
`java.util.List<? extends EffectiveFrequencyBreakdownOrBuilder>`	`getEffectiveFrequencyBreakdownsOrBuilderList()`	A list of effective frequency forecasts.
`long`	`getOnTargetCoviewImpressions()`	Number of ad impressions that exactly matches the Targeting including co-viewers.
`long`	`getOnTargetCoviewReach()`	Number of unique people reached that exactly matches the Targeting including co-viewers.
`long`	`getOnTargetImpressions()`	Number of ad impressions that exactly matches the Targeting.
`long`	`getOnTargetReach()`	Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times that exactly matches the Targeting.
`com.google.protobuf.Parser<Forecast>`	`getParserForType()`
`int`	`getSerializedSize()`
`long`	`getTotalCoviewImpressions()`	Total number of ad impressions including co-viewers.
`long`	`getTotalCoviewReach()`	Number of unique people reached including co-viewers.
`long`	`getTotalImpressions()`	Total number of ad impressions.
`long`	`getTotalReach()`	Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times.
`long`	`getViewableImpressions()`	Number of times the ad's impressions were considered viewable.
`int`	`hashCode()`
`boolean`	`hasOnTargetCoviewImpressions()`	Number of ad impressions that exactly matches the Targeting including co-viewers.
`boolean`	`hasOnTargetCoviewReach()`	Number of unique people reached that exactly matches the Targeting including co-viewers.
`boolean`	`hasOnTargetImpressions()`	Number of ad impressions that exactly matches the Targeting.
`boolean`	`hasOnTargetReach()`	Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times that exactly matches the Targeting.
`boolean`	`hasTotalCoviewImpressions()`	Total number of ad impressions including co-viewers.
`boolean`	`hasTotalCoviewReach()`	Number of unique people reached including co-viewers.
`boolean`	`hasTotalImpressions()`	Total number of ad impressions.
`boolean`	`hasTotalReach()`	Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times.
`boolean`	`hasViewableImpressions()`	Number of times the ad's impressions were considered viewable.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Forecast.Builder`	`newBuilder()`
`static Forecast.Builder`	`newBuilder(Forecast prototype)`
`Forecast.Builder`	`newBuilderForType()`
`protected Forecast.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Forecast`	`parseDelimitedFrom(java.io.InputStream input)`
`static Forecast`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Forecast`	`parseFrom(byte[] data)`
`static Forecast`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Forecast`	`parseFrom(com.google.protobuf.ByteString data)`
`static Forecast`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Forecast`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Forecast`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Forecast`	`parseFrom(java.io.InputStream input)`
`static Forecast`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Forecast`	`parseFrom(java.nio.ByteBuffer data)`
`static Forecast`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Forecast>`	`parser()`
`Forecast.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail
- ON_TARGET_REACH_FIELD_NUMBER
```
public static final int ON_TARGET_REACH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOTAL_REACH_FIELD_NUMBER
```
public static final int TOTAL_REACH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ON_TARGET_IMPRESSIONS_FIELD_NUMBER
```
public static final int ON_TARGET_IMPRESSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOTAL_IMPRESSIONS_FIELD_NUMBER
```
public static final int TOTAL_IMPRESSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VIEWABLE_IMPRESSIONS_FIELD_NUMBER
```
public static final int VIEWABLE_IMPRESSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EFFECTIVE_FREQUENCY_BREAKDOWNS_FIELD_NUMBER
```
public static final int EFFECTIVE_FREQUENCY_BREAKDOWNS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ON_TARGET_COVIEW_REACH_FIELD_NUMBER
```
public static final int ON_TARGET_COVIEW_REACH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOTAL_COVIEW_REACH_FIELD_NUMBER
```
public static final int TOTAL_COVIEW_REACH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER
```
public static final int ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER
```
public static final int TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasOnTargetReach

public boolean hasOnTargetReach()

 Number of unique people reached at least
 GenerateReachForecastRequest.min_effective_frequency or
 GenerateReachForecastRequest.effective_frequency_limit times that exactly
 matches the Targeting.

 Note that a minimum number of unique people must be reached in order for
 data to be reported. If the minimum number is not met, the on_target_reach
 value will be rounded to 0.

optional int64 on_target_reach = 5;

Specified by:: hasOnTargetReach in interface ForecastOrBuilder
Returns:: Whether the onTargetReach field is set.

getOnTargetReach

public long getOnTargetReach()

 Number of unique people reached at least
 GenerateReachForecastRequest.min_effective_frequency or
 GenerateReachForecastRequest.effective_frequency_limit times that exactly
 matches the Targeting.

 Note that a minimum number of unique people must be reached in order for
 data to be reported. If the minimum number is not met, the on_target_reach
 value will be rounded to 0.

optional int64 on_target_reach = 5;

Specified by:: getOnTargetReach in interface ForecastOrBuilder
Returns:: The onTargetReach.

hasTotalReach

public boolean hasTotalReach()

 Total number of unique people reached at least
 GenerateReachForecastRequest.min_effective_frequency or
 GenerateReachForecastRequest.effective_frequency_limit times. This includes
 people that may fall outside the specified Targeting.

 Note that a minimum number of unique people must be reached in order for
 data to be reported. If the minimum number is not met, the total_reach
 value will be rounded to 0.

optional int64 total_reach = 6;

Specified by:: hasTotalReach in interface ForecastOrBuilder
Returns:: Whether the totalReach field is set.

getTotalReach

public long getTotalReach()

 Total number of unique people reached at least
 GenerateReachForecastRequest.min_effective_frequency or
 GenerateReachForecastRequest.effective_frequency_limit times. This includes
 people that may fall outside the specified Targeting.

 Note that a minimum number of unique people must be reached in order for
 data to be reported. If the minimum number is not met, the total_reach
 value will be rounded to 0.

optional int64 total_reach = 6;

Specified by:: getTotalReach in interface ForecastOrBuilder
Returns:: The totalReach.

hasOnTargetImpressions
```
public boolean hasOnTargetImpressions()
```
```
 Number of ad impressions that exactly matches the Targeting.
 
```
optional int64 on_target_impressions = 7;
Specified by:

hasOnTargetImpressions in interface ForecastOrBuilder

Returns:

Whether the onTargetImpressions field is set.

getOnTargetImpressions
```
public long getOnTargetImpressions()
```
```
 Number of ad impressions that exactly matches the Targeting.
 
```
optional int64 on_target_impressions = 7;
Specified by:

getOnTargetImpressions in interface ForecastOrBuilder

Returns:

The onTargetImpressions.

hasTotalImpressions

public boolean hasTotalImpressions()

 Total number of ad impressions. This includes impressions that may fall
 outside the specified Targeting, due to insufficient information on
 signed-in users.

optional int64 total_impressions = 8;

Specified by:: hasTotalImpressions in interface ForecastOrBuilder
Returns:: Whether the totalImpressions field is set.

getTotalImpressions

public long getTotalImpressions()

 Total number of ad impressions. This includes impressions that may fall
 outside the specified Targeting, due to insufficient information on
 signed-in users.

optional int64 total_impressions = 8;

Specified by:: getTotalImpressions in interface ForecastOrBuilder
Returns:: The totalImpressions.

hasViewableImpressions

public boolean hasViewableImpressions()

 Number of times the ad's impressions were considered viewable.
 See https://support.google.com/google-ads/answer/7029393 for
 more information about what makes an ad viewable and how
 viewability is measured.

optional int64 viewable_impressions = 9;

Specified by:: hasViewableImpressions in interface ForecastOrBuilder
Returns:: Whether the viewableImpressions field is set.

getViewableImpressions

public long getViewableImpressions()

 Number of times the ad's impressions were considered viewable.
 See https://support.google.com/google-ads/answer/7029393 for
 more information about what makes an ad viewable and how
 viewability is measured.

optional int64 viewable_impressions = 9;

Specified by:: getViewableImpressions in interface ForecastOrBuilder
Returns:: The viewableImpressions.