Package com.google.ads.googleads.v18.services

Class GenerateKeywordHistoricalMetricsResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.Builder>
com.google.ads.googleads.v18.services.GenerateKeywordHistoricalMetricsResult.Builder
All Implemented Interfaces:
GenerateKeywordHistoricalMetricsResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateKeywordHistoricalMetricsResult
public static final class GenerateKeywordHistoricalMetricsResult.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.Builder> implements GenerateKeywordHistoricalMetricsResultOrBuilder
 The result of generating keyword historical metrics.
Protobuf type google.ads.googleads.v18.services.GenerateKeywordHistoricalMetricsResult

  • Method Details

    • 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<GenerateKeywordHistoricalMetricsResult.Builder>

    • clear

      public GenerateKeywordHistoricalMetricsResult.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.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<GenerateKeywordHistoricalMetricsResult.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public GenerateKeywordHistoricalMetricsResult.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.Builder>

    • setField

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

    • clearField

      public GenerateKeywordHistoricalMetricsResult.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.Builder>

    • clearOneof

      public GenerateKeywordHistoricalMetricsResult.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordHistoricalMetricsResult.Builder>

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

      public GenerateKeywordHistoricalMetricsResult.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateKeywordHistoricalMetricsResult.Builder>

    • mergeFrom

      public GenerateKeywordHistoricalMetricsResult.Builder mergeFrom(GenerateKeywordHistoricalMetricsResult other)

    • isInitialized

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

    • mergeFrom

      public GenerateKeywordHistoricalMetricsResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<GenerateKeywordHistoricalMetricsResult.Builder>
      Throws:
      IOException

    • hasText

      public boolean hasText()
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Specified by:
      hasText in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Specified by:
      getText in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The text.

    • getTextBytes

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

    • setText

      public GenerateKeywordHistoricalMetricsResult.Builder setText(String value)
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

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

    • setTextBytes

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

    • getCloseVariantsList

      public com.google.protobuf.ProtocolStringList getCloseVariantsList()
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsList in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      A list containing the closeVariants.

    • getCloseVariantsCount

      public int getCloseVariantsCount()
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsCount in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The count of closeVariants.

    • getCloseVariants

      public String getCloseVariants(int index)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariants in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      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 variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsBytes in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the closeVariants at the given index.

    • setCloseVariants

      public GenerateKeywordHistoricalMetricsResult.Builder setCloseVariants(int index, String value)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      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 GenerateKeywordHistoricalMetricsResult.Builder addCloseVariants(String value)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Parameters:
      value - The closeVariants to add.
      Returns:
      This builder for chaining.

    • addAllCloseVariants

      public GenerateKeywordHistoricalMetricsResult.Builder addAllCloseVariants(Iterable<String> values)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Parameters:
      values - The closeVariants to add.
      Returns:
      This builder for chaining.

    • clearCloseVariants

      public GenerateKeywordHistoricalMetricsResult.Builder clearCloseVariants()
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Returns:
      This builder for chaining.

    • addCloseVariantsBytes

      public GenerateKeywordHistoricalMetricsResult.Builder addCloseVariantsBytes(com.google.protobuf.ByteString value)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      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 text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      hasKeywordMetrics in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      Whether the keywordMetrics field is set.

    • getKeywordMetrics

      public KeywordPlanHistoricalMetrics getKeywordMetrics()
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      getKeywordMetrics in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The keywordMetrics.

    • setKeywordMetrics

      public GenerateKeywordHistoricalMetricsResult.Builder setKeywordMetrics(KeywordPlanHistoricalMetrics value)
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

    • setKeywordMetrics

      public GenerateKeywordHistoricalMetricsResult.Builder setKeywordMetrics(KeywordPlanHistoricalMetrics.Builder builderForValue)
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

    • mergeKeywordMetrics

      public GenerateKeywordHistoricalMetricsResult.Builder mergeKeywordMetrics(KeywordPlanHistoricalMetrics value)
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

    • clearKeywordMetrics

      public GenerateKeywordHistoricalMetricsResult.Builder clearKeywordMetrics()
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

    • getKeywordMetricsBuilder

      public KeywordPlanHistoricalMetrics.Builder getKeywordMetricsBuilder()
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;

    • getKeywordMetricsOrBuilder

      public KeywordPlanHistoricalMetricsOrBuilder getKeywordMetricsOrBuilder()
       The historical metrics for text and its close variants
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      getKeywordMetricsOrBuilder in interface GenerateKeywordHistoricalMetricsResultOrBuilder

    • setUnknownFields

      public final GenerateKeywordHistoricalMetricsResult.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<GenerateKeywordHistoricalMetricsResult.Builder>

    • mergeUnknownFields

      public final GenerateKeywordHistoricalMetricsResult.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<GenerateKeywordHistoricalMetricsResult.Builder>