Package com.google.ads.googleads.v18.services

Class Forecast

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.Forecast
All Implemented Interfaces:
ForecastOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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.v18.services.Forecast
See Also:

  • Field Details

    • ON_TARGET_REACH_FIELD_NUMBER

      public static final int ON_TARGET_REACH_FIELD_NUMBER
      See Also:

    • TOTAL_REACH_FIELD_NUMBER

      public static final int TOTAL_REACH_FIELD_NUMBER
      See Also:

    • ON_TARGET_IMPRESSIONS_FIELD_NUMBER

      public static final int ON_TARGET_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • TOTAL_IMPRESSIONS_FIELD_NUMBER

      public static final int TOTAL_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • VIEWABLE_IMPRESSIONS_FIELD_NUMBER

      public static final int VIEWABLE_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • EFFECTIVE_FREQUENCY_BREAKDOWNS_FIELD_NUMBER

      public static final int EFFECTIVE_FREQUENCY_BREAKDOWNS_FIELD_NUMBER
      See Also:

    • ON_TARGET_COVIEW_REACH_FIELD_NUMBER

      public static final int ON_TARGET_COVIEW_REACH_FIELD_NUMBER
      See Also:

    • TOTAL_COVIEW_REACH_FIELD_NUMBER

      public static final int TOTAL_COVIEW_REACH_FIELD_NUMBER
      See Also:

    • ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER

      public static final int ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER

      public static final int TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • VIEWS_FIELD_NUMBER

      public static final int VIEWS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

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

    • getEffectiveFrequencyBreakdownsList

      public 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.v18.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
      Specified by:
      getEffectiveFrequencyBreakdownsList in interface ForecastOrBuilder

    • getEffectiveFrequencyBreakdownsOrBuilderList

      public 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.v18.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.v18.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.v18.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.v18.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
      Specified by:
      getEffectiveFrequencyBreakdownsOrBuilder in interface ForecastOrBuilder

    • hasOnTargetCoviewReach

      public boolean hasOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 11;
      Specified by:
      hasOnTargetCoviewReach in interface ForecastOrBuilder
      Returns:
      Whether the onTargetCoviewReach field is set.

    • getOnTargetCoviewReach

      public long getOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 11;
      Specified by:
      getOnTargetCoviewReach in interface ForecastOrBuilder
      Returns:
      The onTargetCoviewReach.

    • hasTotalCoviewReach

      public boolean hasTotalCoviewReach()
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 12;
      Specified by:
      hasTotalCoviewReach in interface ForecastOrBuilder
      Returns:
      Whether the totalCoviewReach field is set.

    • getTotalCoviewReach

      public long getTotalCoviewReach()
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 12;
      Specified by:
      getTotalCoviewReach in interface ForecastOrBuilder
      Returns:
      The totalCoviewReach.

    • hasOnTargetCoviewImpressions

      public boolean hasOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 13;
      Specified by:
      hasOnTargetCoviewImpressions in interface ForecastOrBuilder
      Returns:
      Whether the onTargetCoviewImpressions field is set.

    • getOnTargetCoviewImpressions

      public long getOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 13;
      Specified by:
      getOnTargetCoviewImpressions in interface ForecastOrBuilder
      Returns:
      The onTargetCoviewImpressions.

    • hasTotalCoviewImpressions

      public boolean hasTotalCoviewImpressions()
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 14;
      Specified by:
      hasTotalCoviewImpressions in interface ForecastOrBuilder
      Returns:
      Whether the totalCoviewImpressions field is set.

    • getTotalCoviewImpressions

      public long getTotalCoviewImpressions()
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 14;
      Specified by:
      getTotalCoviewImpressions in interface ForecastOrBuilder
      Returns:
      The totalCoviewImpressions.

    • hasViews

      public boolean hasViews()
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 15;
      Specified by:
      hasViews in interface ForecastOrBuilder
      Returns:
      Whether the views field is set.

    • getViews

      public long getViews()
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 15;
      Specified by:
      getViews in interface ForecastOrBuilder
      Returns:
      The views.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Forecast parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Forecast parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Forecast.Builder newBuilder()

    • newBuilder

      public static Forecast.Builder newBuilder(Forecast prototype)

    • 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