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

Class GenerateKeywordIdeaResult.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public GenerateKeywordIdeaResult.Builder mergeFrom(GenerateKeywordIdeaResult other)

    • isInitialized

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

    • mergeFrom

      public GenerateKeywordIdeaResult.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<GenerateKeywordIdeaResult.Builder>
      Throws:
      IOException

    • hasText

      public boolean hasText()
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Specified by:
      hasText in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Specified by:
      getText in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Specified by:
      getTextBytes in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      The bytes for text.

    • setText

      public GenerateKeywordIdeaResult.Builder setText(String value)
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

      public GenerateKeywordIdeaResult.Builder clearText()
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Returns:
      This builder for chaining.

    • setTextBytes

      public GenerateKeywordIdeaResult.Builder setTextBytes(com.google.protobuf.ByteString value)
       Text of the keyword idea.
 As in Keyword Plan historical metrics, this text may not be an actual
 keyword, but the canonical form of multiple keywords.
 See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
      optional string text = 5;
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.

    • hasKeywordIdeaMetrics

      public boolean hasKeywordIdeaMetrics()
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;
      Specified by:
      hasKeywordIdeaMetrics in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      Whether the keywordIdeaMetrics field is set.

    • getKeywordIdeaMetrics

      public KeywordPlanHistoricalMetrics getKeywordIdeaMetrics()
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;
      Specified by:
      getKeywordIdeaMetrics in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      The keywordIdeaMetrics.

    • setKeywordIdeaMetrics

      public GenerateKeywordIdeaResult.Builder setKeywordIdeaMetrics(KeywordPlanHistoricalMetrics value)
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;

    • setKeywordIdeaMetrics

      public GenerateKeywordIdeaResult.Builder setKeywordIdeaMetrics(KeywordPlanHistoricalMetrics.Builder builderForValue)
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;

    • mergeKeywordIdeaMetrics

      public GenerateKeywordIdeaResult.Builder mergeKeywordIdeaMetrics(KeywordPlanHistoricalMetrics value)
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;

    • clearKeywordIdeaMetrics

      public GenerateKeywordIdeaResult.Builder clearKeywordIdeaMetrics()
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;

    • getKeywordIdeaMetricsBuilder

      public KeywordPlanHistoricalMetrics.Builder getKeywordIdeaMetricsBuilder()
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;

    • getKeywordIdeaMetricsOrBuilder

      public KeywordPlanHistoricalMetricsOrBuilder getKeywordIdeaMetricsOrBuilder()
       The historical metrics for the keyword.
      .google.ads.googleads.v18.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;
      Specified by:
      getKeywordIdeaMetricsOrBuilder in interface GenerateKeywordIdeaResultOrBuilder

    • hasKeywordAnnotations

      public boolean hasKeywordAnnotations()
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;
      Specified by:
      hasKeywordAnnotations in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      Whether the keywordAnnotations field is set.

    • getKeywordAnnotations

      public KeywordAnnotations getKeywordAnnotations()
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;
      Specified by:
      getKeywordAnnotations in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      The keywordAnnotations.

    • setKeywordAnnotations

      public GenerateKeywordIdeaResult.Builder setKeywordAnnotations(KeywordAnnotations value)
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;

    • setKeywordAnnotations

      public GenerateKeywordIdeaResult.Builder setKeywordAnnotations(KeywordAnnotations.Builder builderForValue)
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;

    • mergeKeywordAnnotations

      public GenerateKeywordIdeaResult.Builder mergeKeywordAnnotations(KeywordAnnotations value)
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;

    • clearKeywordAnnotations

      public GenerateKeywordIdeaResult.Builder clearKeywordAnnotations()
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;

    • getKeywordAnnotationsBuilder

      public KeywordAnnotations.Builder getKeywordAnnotationsBuilder()
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;

    • getKeywordAnnotationsOrBuilder

      public KeywordAnnotationsOrBuilder getKeywordAnnotationsOrBuilder()
       The annotations for the keyword.
 The annotation data is only provided if requested.
      .google.ads.googleads.v18.common.KeywordAnnotations keyword_annotations = 6;
      Specified by:
      getKeywordAnnotationsOrBuilder in interface GenerateKeywordIdeaResultOrBuilder

    • getCloseVariantsList

      public com.google.protobuf.ProtocolStringList getCloseVariantsList()
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Specified by:
      getCloseVariantsList in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      A list containing the closeVariants.

    • getCloseVariantsCount

      public int getCloseVariantsCount()
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Specified by:
      getCloseVariantsCount in interface GenerateKeywordIdeaResultOrBuilder
      Returns:
      The count of closeVariants.

    • getCloseVariants

      public String getCloseVariants(int index)
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Specified by:
      getCloseVariants in interface GenerateKeywordIdeaResultOrBuilder
      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 that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Specified by:
      getCloseVariantsBytes in interface GenerateKeywordIdeaResultOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the closeVariants at the given index.

    • setCloseVariants

      public GenerateKeywordIdeaResult.Builder setCloseVariants(int index, String value)
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Parameters:
      index - The index to set the value at.
      value - The closeVariants to set.
      Returns:
      This builder for chaining.

    • addCloseVariants

      public GenerateKeywordIdeaResult.Builder addCloseVariants(String value)
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Parameters:
      value - The closeVariants to add.
      Returns:
      This builder for chaining.

    • addAllCloseVariants

      public GenerateKeywordIdeaResult.Builder addAllCloseVariants(Iterable<String> values)
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Parameters:
      values - The closeVariants to add.
      Returns:
      This builder for chaining.

    • clearCloseVariants

      public GenerateKeywordIdeaResult.Builder clearCloseVariants()
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Returns:
      This builder for chaining.

    • addCloseVariantsBytes

      public GenerateKeywordIdeaResult.Builder addCloseVariantsBytes(com.google.protobuf.ByteString value)
       The list of close variants from the requested keywords that
 are combined into this GenerateKeywordIdeaResult. See
 https://support.google.com/google-ads/answer/9342105 for the
 definition of "close variants".
      repeated string close_variants = 7;
      Parameters:
      value - The bytes of the closeVariants to add.
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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