Package com.google.ads.googleads.v10.services

Class 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.v10.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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • 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 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 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.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      long getViewableImpressions()
      Number of times the ad's impressions were considered viewable.
      int hashCode()  
      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 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, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, 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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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.

      • getEffectiveFrequencyBreakdownsList

        public java.util.List<EffectiveFrequencyBreakdown> getEffectiveFrequencyBreakdownsList()
         A list of effective frequency forecasts. The list is ordered starting with
 1+ and ending with the value set in
 GenerateReachForecastRequest.effective_frequency_limit. If no
 effective_frequency_limit was set, this list will be empty.
        repeated .google.ads.googleads.v10.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
        Specified by:
        getEffectiveFrequencyBreakdownsList in interface ForecastOrBuilder

      • getEffectiveFrequencyBreakdownsOrBuilderList

        public java.util.List<? extends EffectiveFrequencyBreakdownOrBuilder> getEffectiveFrequencyBreakdownsOrBuilderList()
         A list of effective frequency forecasts. The list is ordered starting with
 1+ and ending with the value set in
 GenerateReachForecastRequest.effective_frequency_limit. If no
 effective_frequency_limit was set, this list will be empty.
        repeated .google.ads.googleads.v10.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
        Specified by:
        getEffectiveFrequencyBreakdownsOrBuilderList in interface ForecastOrBuilder

      • getEffectiveFrequencyBreakdownsCount

        public int getEffectiveFrequencyBreakdownsCount()
         A list of effective frequency forecasts. The list is ordered starting with
 1+ and ending with the value set in
 GenerateReachForecastRequest.effective_frequency_limit. If no
 effective_frequency_limit was set, this list will be empty.
        repeated .google.ads.googleads.v10.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
        Specified by:
        getEffectiveFrequencyBreakdownsCount in interface ForecastOrBuilder

      • getEffectiveFrequencyBreakdowns

        public EffectiveFrequencyBreakdown getEffectiveFrequencyBreakdowns​(int index)
         A list of effective frequency forecasts. The list is ordered starting with
 1+ and ending with the value set in
 GenerateReachForecastRequest.effective_frequency_limit. If no
 effective_frequency_limit was set, this list will be empty.
        repeated .google.ads.googleads.v10.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
        Specified by:
        getEffectiveFrequencyBreakdowns in interface ForecastOrBuilder

      • getEffectiveFrequencyBreakdownsOrBuilder

        public EffectiveFrequencyBreakdownOrBuilder getEffectiveFrequencyBreakdownsOrBuilder​(int index)
         A list of effective frequency forecasts. The list is ordered starting with
 1+ and ending with the value set in
 GenerateReachForecastRequest.effective_frequency_limit. If no
 effective_frequency_limit was set, this list will be empty.
        repeated .google.ads.googleads.v10.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
        Specified by:
        getEffectiveFrequencyBreakdownsOrBuilder in interface ForecastOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Forecast parseFrom​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(java.nio.ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Forecast parseFrom​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Forecast parseFrom​(java.io.InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Forecast parseDelimitedFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Forecast parseDelimitedFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Forecast parseFrom​(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Forecast parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Forecast.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Forecast.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Forecast.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Forecast getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Forecast> parser()

      • getParserForType

        public com.google.protobuf.Parser<Forecast> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Forecast getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder