com.google.ads.googleads.v17.services.ForecastOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/reach_plan_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface ForecastOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.Forecast)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return Whether the onTargetReach field is set.
   */
  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;
   * @return The onTargetReach.
   */
  long getOnTargetReach();

  /**
   *    * 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;
   * @return Whether the totalReach field is set.
   */
  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;
   * @return The totalReach.
   */
  long getTotalReach();

  /**
   *    * Number of ad impressions that exactly matches the Targeting.
   * 
   *
   * optional int64 on_target_impressions = 7;
   * @return Whether the onTargetImpressions field is set.
   */
  boolean hasOnTargetImpressions();
  /**
   *    * Number of ad impressions that exactly matches the Targeting.
   * 
   *
   * optional int64 on_target_impressions = 7;
   * @return The onTargetImpressions.
   */
  long getOnTargetImpressions();

  /**
   *    * 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;
   * @return Whether the totalImpressions field is set.
   */
  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;
   * @return The totalImpressions.
   */
  long getTotalImpressions();

  /**
   *    * 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;
   * @return Whether the viewableImpressions field is set.
   */
  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;
   * @return The viewableImpressions.
   */
  long getViewableImpressions();

  /**
   *    * 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.v17.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
   */
  java.util.List 
      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.v17.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
   */
  com.google.ads.googleads.v17.services.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.v17.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
   */
  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.v17.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
   */
  java.util.List 
      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.v17.services.EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
   */
  com.google.ads.googleads.v17.services.EffectiveFrequencyBreakdownOrBuilder getEffectiveFrequencyBreakdownsOrBuilder(
      int index);

  /**
   *    * Number of unique people reached that exactly matches the Targeting
   * including co-viewers.
   * 
   *
   * optional int64 on_target_coview_reach = 11;
   * @return Whether the onTargetCoviewReach field is set.
   */
  boolean hasOnTargetCoviewReach();
  /**
   *    * Number of unique people reached that exactly matches the Targeting
   * including co-viewers.
   * 
   *
   * optional int64 on_target_coview_reach = 11;
   * @return The onTargetCoviewReach.
   */
  long getOnTargetCoviewReach();

  /**
   *    * Number of unique people reached including co-viewers. This includes
   * people that may fall outside the specified Targeting.
   * 
   *
   * optional int64 total_coview_reach = 12;
   * @return Whether the totalCoviewReach field is set.
   */
  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;
   * @return The totalCoviewReach.
   */
  long getTotalCoviewReach();

  /**
   *    * Number of ad impressions that exactly matches the Targeting including
   * co-viewers.
   * 
   *
   * optional int64 on_target_coview_impressions = 13;
   * @return Whether the onTargetCoviewImpressions field is set.
   */
  boolean hasOnTargetCoviewImpressions();
  /**
   *    * Number of ad impressions that exactly matches the Targeting including
   * co-viewers.
   * 
   *
   * optional int64 on_target_coview_impressions = 13;
   * @return The onTargetCoviewImpressions.
   */
  long getOnTargetCoviewImpressions();

  /**
   *    * 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;
   * @return Whether the totalCoviewImpressions field is set.
   */
  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;
   * @return The totalCoviewImpressions.
   */
  long getTotalCoviewImpressions();

  /**
   *    * 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;
   * @return Whether the views field is set.
   */
  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;
   * @return The views.
   */
  long getViews();
}