Package com.google.ads.googleads.v10.services

Class KeywordPlanKeywordHistoricalMetrics.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<KeywordPlanKeywordHistoricalMetrics.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<KeywordPlanKeywordHistoricalMetrics.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public KeywordPlanKeywordHistoricalMetrics.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<KeywordPlanKeywordHistoricalMetrics.Builder>
        Throws:
        java.io.IOException

      • hasSearchQuery

        public boolean hasSearchQuery()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Specified by:
        hasSearchQuery in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        Whether the searchQuery field is set.

      • getSearchQuery

        public java.lang.String getSearchQuery()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Specified by:
        getSearchQuery in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        The searchQuery.

      • getSearchQueryBytes

        public com.google.protobuf.ByteString getSearchQueryBytes()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Specified by:
        getSearchQueryBytes in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        The bytes for searchQuery.

      • setSearchQuery

        public KeywordPlanKeywordHistoricalMetrics.Builder setSearchQuery​(java.lang.String value)
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Parameters:
        value - The searchQuery to set.
        Returns:
        This builder for chaining.

      • clearSearchQuery

        public KeywordPlanKeywordHistoricalMetrics.Builder clearSearchQuery()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Returns:
        This builder for chaining.

      • setSearchQueryBytes

        public KeywordPlanKeywordHistoricalMetrics.Builder setSearchQueryBytes​(com.google.protobuf.ByteString value)
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Parameters:
        value - The bytes for searchQuery to set.
        Returns:
        This builder for chaining.

      • getCloseVariantsList

        public com.google.protobuf.ProtocolStringList getCloseVariantsList()
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsList in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        A list containing the closeVariants.

      • getCloseVariantsCount

        public int getCloseVariantsCount()
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsCount in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        The count of closeVariants.

      • getCloseVariants

        public java.lang.String getCloseVariants​(int index)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariants in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The closeVariants at the given index.

      • getCloseVariantsBytes

        public com.google.protobuf.ByteString getCloseVariantsBytes​(int index)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsBytes in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the closeVariants at the given index.

      • setCloseVariants

        public KeywordPlanKeywordHistoricalMetrics.Builder setCloseVariants​(int index,
                                                                    java.lang.String value)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Parameters:
        index - The index to set the value at.
        value - The closeVariants to set.
        Returns:
        This builder for chaining.

      • addCloseVariants

        public KeywordPlanKeywordHistoricalMetrics.Builder addCloseVariants​(java.lang.String value)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Parameters:
        value - The closeVariants to add.
        Returns:
        This builder for chaining.

      • addAllCloseVariants

        public KeywordPlanKeywordHistoricalMetrics.Builder addAllCloseVariants​(java.lang.Iterable<java.lang.String> values)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Parameters:
        values - The closeVariants to add.
        Returns:
        This builder for chaining.

      • clearCloseVariants

        public KeywordPlanKeywordHistoricalMetrics.Builder clearCloseVariants()
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Returns:
        This builder for chaining.

      • addCloseVariantsBytes

        public KeywordPlanKeywordHistoricalMetrics.Builder addCloseVariantsBytes​(com.google.protobuf.ByteString value)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Parameters:
        value - The bytes of the closeVariants to add.
        Returns:
        This builder for chaining.

      • hasKeywordMetrics

        public boolean hasKeywordMetrics()
         The historical metrics for the query associated with one or more
 ad_group_keywords in the plan.
        .google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
        Specified by:
        hasKeywordMetrics in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        Whether the keywordMetrics field is set.

      • clearKeywordMetrics

        public KeywordPlanKeywordHistoricalMetrics.Builder clearKeywordMetrics()
         The historical metrics for the query associated with one or more
 ad_group_keywords in the plan.
        .google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

      • getKeywordMetricsBuilder

        public KeywordPlanHistoricalMetrics.Builder getKeywordMetricsBuilder()
         The historical metrics for the query associated with one or more
 ad_group_keywords in the plan.
        .google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;