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

Class GenerateKeywordIdeaResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.GenerateKeywordIdeaResult
All Implemented Interfaces:
GenerateKeywordIdeaResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateKeywordIdeaResult extends com.google.protobuf.GeneratedMessageV3 implements GenerateKeywordIdeaResultOrBuilder
 The result of generating keyword ideas.
Protobuf type google.ads.googleads.v18.services.GenerateKeywordIdeaResult
See Also:

  • Field Details

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • KEYWORD_IDEA_METRICS_FIELD_NUMBER

      public static final int KEYWORD_IDEA_METRICS_FIELD_NUMBER
      See Also:

    • KEYWORD_ANNOTATIONS_FIELD_NUMBER

      public static final int KEYWORD_ANNOTATIONS_FIELD_NUMBER
      See Also:

    • CLOSE_VARIANTS_FIELD_NUMBER

      public static final int CLOSE_VARIANTS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateKeywordIdeaResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateKeywordIdeaResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateKeywordIdeaResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static GenerateKeywordIdeaResult.Builder newBuilder()

    • newBuilder

      public static GenerateKeywordIdeaResult.Builder newBuilder(GenerateKeywordIdeaResult prototype)

    • toBuilder

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

    • newBuilderForType

      protected GenerateKeywordIdeaResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GenerateKeywordIdeaResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GenerateKeywordIdeaResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<GenerateKeywordIdeaResult> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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