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

Interface PlannedProductForecastOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PlannedProductForecast, PlannedProductForecast.Builder
public interface PlannedProductForecastOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAverageFrequency()
    The number of times per selected time unit a user will see an ad, averaged over the number of time units in the forecast length.
    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 that exactly matches the Targeting.
    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()
    Number of unique people reached.
    long
    getViewableImpressions()
    Number of times the ad's impressions were considered viewable.
    long
    getViews()
    Number of ad views forecasted for the specified product and targeting.
    boolean
    hasAverageFrequency()
    The number of times per selected time unit a user will see an ad, averaged over the number of time units in the forecast length.
    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
    hasTotalCoviewImpressions()
    Total number of ad impressions including co-viewers.
    boolean
    hasTotalCoviewReach()
    Number of unique people reached including co-viewers.
    boolean
    hasViewableImpressions()
    Number of times the ad's impressions were considered viewable.
    boolean
    hasViews()
    Number of ad views forecasted for the specified product and targeting.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getOnTargetReach

      long getOnTargetReach()
       Number of unique people reached 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.
      int64 on_target_reach = 1;
      Returns:
      The onTargetReach.

    • getTotalReach

      long getTotalReach()
       Number of unique people reached. 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.
      int64 total_reach = 2;
      Returns:
      The totalReach.

    • getOnTargetImpressions

      long getOnTargetImpressions()
       Number of ad impressions that exactly matches the Targeting.
      int64 on_target_impressions = 3;
      Returns:
      The onTargetImpressions.

    • getTotalImpressions

      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.
      int64 total_impressions = 4;
      Returns:
      The totalImpressions.

    • hasViewableImpressions

      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 = 5;
      Returns:
      Whether the viewableImpressions field is set.

    • getViewableImpressions

      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 = 5;
      Returns:
      The viewableImpressions.

    • hasOnTargetCoviewReach

      boolean hasOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Returns:
      Whether the onTargetCoviewReach field is set.

    • getOnTargetCoviewReach

      long getOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Returns:
      The onTargetCoviewReach.

    • hasTotalCoviewReach

      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 = 7;
      Returns:
      Whether the totalCoviewReach field is set.

    • getTotalCoviewReach

      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 = 7;
      Returns:
      The totalCoviewReach.

    • hasOnTargetCoviewImpressions

      boolean hasOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Returns:
      Whether the onTargetCoviewImpressions field is set.

    • getOnTargetCoviewImpressions

      long getOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Returns:
      The onTargetCoviewImpressions.

    • hasTotalCoviewImpressions

      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 = 9;
      Returns:
      Whether the totalCoviewImpressions field is set.

    • getTotalCoviewImpressions

      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 = 9;
      Returns:
      The totalCoviewImpressions.

    • hasAverageFrequency

      boolean hasAverageFrequency()
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Returns:
      Whether the averageFrequency field is set.

    • getAverageFrequency

      double getAverageFrequency()
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Returns:
      The averageFrequency.

    • hasViews

      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 = 11;
      Returns:
      Whether the views field is set.

    • getViews

      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 = 11;
      Returns:
      The views.