com.google.ads.googleads.v10.common.HistoricalMetricsOptionsOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v10 Show documentation

Stubs for GAAPI version google-ads-stubs-v10

The newest version!

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v10/common/keyword_plan_common.proto

package com.google.ads.googleads.v10.common;

public interface HistoricalMetricsOptionsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.common.HistoricalMetricsOptions)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The year month range for historical metrics. If not specified the searches
   * will be returned for past 12 months.
   * Searches data is available for the past 4 years. If the search volume is
   * not available for the entire year_month_range provided, the subset of the
   * year month range for which search volume is available will be returned.
   * 
   *
   * optional .google.ads.googleads.v10.common.YearMonthRange year_month_range = 1;
   * @return Whether the yearMonthRange field is set.
   */
  boolean hasYearMonthRange();
  /**
   *    * The year month range for historical metrics. If not specified the searches
   * will be returned for past 12 months.
   * Searches data is available for the past 4 years. If the search volume is
   * not available for the entire year_month_range provided, the subset of the
   * year month range for which search volume is available will be returned.
   * 
   *
   * optional .google.ads.googleads.v10.common.YearMonthRange year_month_range = 1;
   * @return The yearMonthRange.
   */
  com.google.ads.googleads.v10.common.YearMonthRange getYearMonthRange();
  /**
   *    * The year month range for historical metrics. If not specified the searches
   * will be returned for past 12 months.
   * Searches data is available for the past 4 years. If the search volume is
   * not available for the entire year_month_range provided, the subset of the
   * year month range for which search volume is available will be returned.
   * 
   *
   * optional .google.ads.googleads.v10.common.YearMonthRange year_month_range = 1;
   */
  com.google.ads.googleads.v10.common.YearMonthRangeOrBuilder getYearMonthRangeOrBuilder();

  /**
   *    * Indicates whether to include average cost per click value.
   * Average CPC is a legacy value that will be removed and replaced in the
   * future, and as such we are including it as an optioanl value so clients
   * only use it when strictly necessary and to better track clients that use
   * this value.
   * 
   *
   * bool include_average_cpc = 2;
   * @return The includeAverageCpc.
   */
  boolean getIncludeAverageCpc();
}