Package com.google.ads.googleads.v10.common

Class HistoricalMetricsOptions.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • getDefaultInstanceForType

        public HistoricalMetricsOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public HistoricalMetricsOptions build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public HistoricalMetricsOptions buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setField

        public HistoricalMetricsOptions.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • setRepeatedField

        public HistoricalMetricsOptions.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • addRepeatedField

        public HistoricalMetricsOptions.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • mergeFrom

        public HistoricalMetricsOptions.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HistoricalMetricsOptions.Builder>
        Throws:
        java.io.IOException

      • hasYearMonthRange

        public 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;
        Specified by:
        hasYearMonthRange in interface HistoricalMetricsOptionsOrBuilder
        Returns:
        Whether the yearMonthRange field is set.

      • getYearMonthRange

        public 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;
        Specified by:
        getYearMonthRange in interface HistoricalMetricsOptionsOrBuilder
        Returns:
        The yearMonthRange.

      • setYearMonthRange

        public HistoricalMetricsOptions.Builder setYearMonthRange​(YearMonthRange value)
         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;

      • setYearMonthRange

        public HistoricalMetricsOptions.Builder setYearMonthRange​(YearMonthRange.Builder builderForValue)
         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;

      • mergeYearMonthRange

        public HistoricalMetricsOptions.Builder mergeYearMonthRange​(YearMonthRange value)
         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;

      • clearYearMonthRange

        public HistoricalMetricsOptions.Builder clearYearMonthRange()
         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;

      • getYearMonthRangeBuilder

        public YearMonthRange.Builder getYearMonthRangeBuilder()
         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;

      • getYearMonthRangeOrBuilder

        public 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;
        Specified by:
        getYearMonthRangeOrBuilder in interface HistoricalMetricsOptionsOrBuilder

      • getIncludeAverageCpc

        public 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;
        Specified by:
        getIncludeAverageCpc in interface HistoricalMetricsOptionsOrBuilder
        Returns:
        The includeAverageCpc.

      • setIncludeAverageCpc

        public HistoricalMetricsOptions.Builder setIncludeAverageCpc​(boolean value)
         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;
        Parameters:
        value - The includeAverageCpc to set.
        Returns:
        This builder for chaining.

      • clearIncludeAverageCpc

        public HistoricalMetricsOptions.Builder clearIncludeAverageCpc()
         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:
        This builder for chaining.

      • setUnknownFields

        public final HistoricalMetricsOptions.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>

      • mergeUnknownFields

        public final HistoricalMetricsOptions.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HistoricalMetricsOptions.Builder>