Package com.google.ads.googleads.v14.services

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

        public GenerateKeywordHistoricalMetricsRequest 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<GenerateKeywordHistoricalMetricsRequest.Builder>

      • mergeFrom

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

      • setCustomerId

        public GenerateKeywordHistoricalMetricsRequest.Builder setCustomerId​(java.lang.String value)
         The ID of the customer with the recommendation.
        string customer_id = 1;
        Parameters:
        value - The customerId to set.
        Returns:
        This builder for chaining.

      • setCustomerIdBytes

        public GenerateKeywordHistoricalMetricsRequest.Builder setCustomerIdBytes​(com.google.protobuf.ByteString value)
         The ID of the customer with the recommendation.
        string customer_id = 1;
        Parameters:
        value - The bytes for customerId to set.
        Returns:
        This builder for chaining.

      • getKeywordsList

        public com.google.protobuf.ProtocolStringList getKeywordsList()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsList in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        A list containing the keywords.

      • getKeywordsCount

        public int getKeywordsCount()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsCount in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The count of keywords.

      • getKeywords

        public java.lang.String getKeywords​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywords in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The keywords at the given index.

      • getKeywordsBytes

        public com.google.protobuf.ByteString getKeywordsBytes​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keywords at the given index.

      • setKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder setKeywords​(int index,
                                                                   java.lang.String value)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        index - The index to set the value at.
        value - The keywords to set.
        Returns:
        This builder for chaining.

      • addKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder addKeywords​(java.lang.String value)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        value - The keywords to add.
        Returns:
        This builder for chaining.

      • addAllKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder addAllKeywords​(java.lang.Iterable<java.lang.String> values)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        values - The keywords to add.
        Returns:
        This builder for chaining.

      • clearKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder clearKeywords()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Returns:
        This builder for chaining.

      • addKeywordsBytes

        public GenerateKeywordHistoricalMetricsRequest.Builder addKeywordsBytes​(com.google.protobuf.ByteString value)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        value - The bytes of the keywords to add.
        Returns:
        This builder for chaining.

      • hasLanguage

        public boolean hasLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        hasLanguage in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        Whether the language field is set.

      • getLanguage

        public java.lang.String getLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        getLanguage in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The language.

      • getLanguageBytes

        public com.google.protobuf.ByteString getLanguageBytes()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        getLanguageBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The bytes for language.

      • setLanguage

        public GenerateKeywordHistoricalMetricsRequest.Builder setLanguage​(java.lang.String value)
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Parameters:
        value - The language to set.
        Returns:
        This builder for chaining.

      • clearLanguage

        public GenerateKeywordHistoricalMetricsRequest.Builder clearLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Returns:
        This builder for chaining.

      • setLanguageBytes

        public GenerateKeywordHistoricalMetricsRequest.Builder setLanguageBytes​(com.google.protobuf.ByteString value)
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Parameters:
        value - The bytes for language to set.
        Returns:
        This builder for chaining.

      • setIncludeAdultKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder setIncludeAdultKeywords​(boolean value)
         If true, adult keywords will be included in response.
 The default value is false.
        bool include_adult_keywords = 5;
        Parameters:
        value - The includeAdultKeywords to set.
        Returns:
        This builder for chaining.

      • clearIncludeAdultKeywords

        public GenerateKeywordHistoricalMetricsRequest.Builder clearIncludeAdultKeywords()
         If true, adult keywords will be included in response.
 The default value is false.
        bool include_adult_keywords = 5;
        Returns:
        This builder for chaining.

      • getGeoTargetConstantsList

        public com.google.protobuf.ProtocolStringList getGeoTargetConstantsList()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsList in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        A list containing the geoTargetConstants.

      • getGeoTargetConstantsCount

        public int getGeoTargetConstantsCount()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsCount in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The count of geoTargetConstants.

      • getGeoTargetConstants

        public java.lang.String getGeoTargetConstants​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstants in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The geoTargetConstants at the given index.

      • getGeoTargetConstantsBytes

        public com.google.protobuf.ByteString getGeoTargetConstantsBytes​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the geoTargetConstants at the given index.

      • setGeoTargetConstants

        public GenerateKeywordHistoricalMetricsRequest.Builder setGeoTargetConstants​(int index,
                                                                             java.lang.String value)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Parameters:
        index - The index to set the value at.
        value - The geoTargetConstants to set.
        Returns:
        This builder for chaining.

      • addGeoTargetConstants

        public GenerateKeywordHistoricalMetricsRequest.Builder addGeoTargetConstants​(java.lang.String value)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Parameters:
        value - The geoTargetConstants to add.
        Returns:
        This builder for chaining.

      • addAllGeoTargetConstants

        public GenerateKeywordHistoricalMetricsRequest.Builder addAllGeoTargetConstants​(java.lang.Iterable<java.lang.String> values)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Parameters:
        values - The geoTargetConstants to add.
        Returns:
        This builder for chaining.

      • clearGeoTargetConstants

        public GenerateKeywordHistoricalMetricsRequest.Builder clearGeoTargetConstants()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Returns:
        This builder for chaining.

      • addGeoTargetConstantsBytes

        public GenerateKeywordHistoricalMetricsRequest.Builder addGeoTargetConstantsBytes​(com.google.protobuf.ByteString value)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Parameters:
        value - The bytes of the geoTargetConstants to add.
        Returns:
        This builder for chaining.

      • getKeywordPlanNetworkValue

        public int getKeywordPlanNetworkValue()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v14.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Specified by:
        getKeywordPlanNetworkValue in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • setKeywordPlanNetworkValue

        public GenerateKeywordHistoricalMetricsRequest.Builder setKeywordPlanNetworkValue​(int value)
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v14.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Parameters:
        value - The enum numeric value on the wire for keywordPlanNetwork to set.
        Returns:
        This builder for chaining.

      • clearKeywordPlanNetwork

        public GenerateKeywordHistoricalMetricsRequest.Builder clearKeywordPlanNetwork()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v14.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Returns:
        This builder for chaining.

      • hasAggregateMetrics

        public boolean hasAggregateMetrics()
         The aggregate fields to include in response.
        .google.ads.googleads.v14.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
        Specified by:
        hasAggregateMetrics in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        Whether the aggregateMetrics field is set.

      • getAggregateMetricsBuilder

        public KeywordPlanAggregateMetrics.Builder getAggregateMetricsBuilder()
         The aggregate fields to include in response.
        .google.ads.googleads.v14.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;

      • clearHistoricalMetricsOptions

        public GenerateKeywordHistoricalMetricsRequest.Builder clearHistoricalMetricsOptions()
         The options for historical metrics data.
        .google.ads.googleads.v14.common.HistoricalMetricsOptions historical_metrics_options = 3;

      • getHistoricalMetricsOptionsBuilder

        public HistoricalMetricsOptions.Builder getHistoricalMetricsOptionsBuilder()
         The options for historical metrics data.
        .google.ads.googleads.v14.common.HistoricalMetricsOptions historical_metrics_options = 3;