Package com.google.ads.googleads.v10.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

      All Methods Instance Methods Abstract Methods 
      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 Detail

      • hasYearMonthRange

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

      • getYearMonthRange

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

      • getYearMonthRangeOrBuilder

        YearMonthRangeOrBuilder getYearMonthRangeOrBuilder()
         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;

      • getIncludeAverageCpc

        boolean getIncludeAverageCpc()
         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;
        Returns:
        The includeAverageCpc.