Package com.google.ads.googleads.v15.services

Interface ForecastOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Forecast, Forecast.Builder
    public interface ForecastOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasOnTargetReach

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

      • getOnTargetReach

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

      • hasTotalReach

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

      • getTotalReach

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

      • hasOnTargetImpressions

        boolean hasOnTargetImpressions()
         Number of ad impressions that exactly matches the Targeting.
        optional int64 on_target_impressions = 7;
        Returns:
        Whether the onTargetImpressions field is set.

      • getOnTargetImpressions

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

      • hasTotalImpressions

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

      • 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.
        optional int64 total_impressions = 8;
        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 = 9;
        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 = 9;
        Returns:
        The viewableImpressions.

      • getEffectiveFrequencyBreakdownsList

        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.v15.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;

      • getEffectiveFrequencyBreakdowns

        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.v15.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;

      • getEffectiveFrequencyBreakdownsCount

        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.v15.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;

      • getEffectiveFrequencyBreakdownsOrBuilderList

        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.v15.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;

      • getEffectiveFrequencyBreakdownsOrBuilder

        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.v15.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;

      • hasOnTargetCoviewReach

        boolean hasOnTargetCoviewReach()
         Number of unique people reached that exactly matches the Targeting
 including co-viewers.
        optional int64 on_target_coview_reach = 11;
        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 = 11;
        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 = 12;
        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 = 12;
        Returns:
        The totalCoviewReach.

      • hasOnTargetCoviewImpressions

        boolean hasOnTargetCoviewImpressions()
         Number of ad impressions that exactly matches the Targeting including
 co-viewers.
        optional int64 on_target_coview_impressions = 13;
        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 = 13;
        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 = 14;
        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 = 14;
        Returns:
        The totalCoviewImpressions.

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