Package com.google.ads.googleads.v18.common

Interface HistoricalMetricsOptionsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getIncludeAverageCpc()
    Indicates whether to include average cost per click value.
    YearMonthRange
    getYearMonthRange()
    The year month range for historical metrics.
    YearMonthRangeOrBuilder
    getYearMonthRangeOrBuilder()
    The year month range for historical metrics.
    boolean
    hasYearMonthRange()
    The year month range for historical metrics.

    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

    • hasYearMonthRange

      boolean hasYearMonthRange()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are 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 are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;
      Returns:
      Whether the yearMonthRange field is set.

    • getYearMonthRange

      YearMonthRange getYearMonthRange()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are 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 are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;
      Returns:
      The yearMonthRange.

    • getYearMonthRangeOrBuilder

      YearMonthRangeOrBuilder getYearMonthRangeOrBuilder()
       The year month range for historical metrics. If not specified, metrics
 for the past 12 months are returned.
 Search metrics are 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 are returned.
      optional .google.ads.googleads.v18.common.YearMonthRange year_month_range = 1;

    • getIncludeAverageCpc

      boolean getIncludeAverageCpc()
       Indicates whether to include average cost per click value.
 Average CPC is provided only for legacy support.
      bool include_average_cpc = 2;
      Returns:
      The includeAverageCpc.