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

Class GenerateKeywordIdeasRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordIdeasRequest.Builder>
com.google.ads.googleads.v18.services.GenerateKeywordIdeasRequest.Builder
All Implemented Interfaces:
GenerateKeywordIdeasRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateKeywordIdeasRequest
public static final class GenerateKeywordIdeasRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordIdeasRequest.Builder> implements GenerateKeywordIdeasRequestOrBuilder
 Request message for
 [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v18.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
Protobuf type google.ads.googleads.v18.services.GenerateKeywordIdeasRequest

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public GenerateKeywordIdeasRequest.Builder mergeFrom(GenerateKeywordIdeasRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getSeedCase

      public GenerateKeywordIdeasRequest.SeedCase getSeedCase()
      Specified by:
      getSeedCase in interface GenerateKeywordIdeasRequestOrBuilder

    • clearSeed

      public GenerateKeywordIdeasRequest.Builder clearSeed()

    • getCustomerId

      public String getCustomerId()
       The ID of the customer with the recommendation.
      string customer_id = 1;
      Specified by:
      getCustomerId in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       The ID of the customer with the recommendation.
      string customer_id = 1;
      Specified by:
      getCustomerIdBytes in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The bytes for customerId.

    • setCustomerId

      public GenerateKeywordIdeasRequest.Builder setCustomerId(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.

    • clearCustomerId

      public GenerateKeywordIdeasRequest.Builder clearCustomerId()
       The ID of the customer with the recommendation.
      string customer_id = 1;
      Returns:
      This builder for chaining.

    • setCustomerIdBytes

      public GenerateKeywordIdeasRequest.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.

    • 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 = 14;
      Specified by:
      hasLanguage in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the language field is set.

    • getLanguage

      public 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 = 14;
      Specified by:
      getLanguage in interface GenerateKeywordIdeasRequestOrBuilder
      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 = 14;
      Specified by:
      getLanguageBytes in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The bytes for language.

    • setLanguage

      public GenerateKeywordIdeasRequest.Builder setLanguage(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 = 14;
      Parameters:
      value - The language to set.
      Returns:
      This builder for chaining.

    • clearLanguage

      public GenerateKeywordIdeasRequest.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 = 14;
      Returns:
      This builder for chaining.

    • setLanguageBytes

      public GenerateKeywordIdeasRequest.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 = 14;
      Parameters:
      value - The bytes for language to set.
      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 = 15;
      Specified by:
      getGeoTargetConstantsList in interface GenerateKeywordIdeasRequestOrBuilder
      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 = 15;
      Specified by:
      getGeoTargetConstantsCount in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The count of geoTargetConstants.

    • getGeoTargetConstants

      public 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 = 15;
      Specified by:
      getGeoTargetConstants in interface GenerateKeywordIdeasRequestOrBuilder
      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 = 15;
      Specified by:
      getGeoTargetConstantsBytes in interface GenerateKeywordIdeasRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the geoTargetConstants at the given index.

    • setGeoTargetConstants

      public GenerateKeywordIdeasRequest.Builder setGeoTargetConstants(int index, 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 = 15;
      Parameters:
      index - The index to set the value at.
      value - The geoTargetConstants to set.
      Returns:
      This builder for chaining.

    • addGeoTargetConstants

      public GenerateKeywordIdeasRequest.Builder addGeoTargetConstants(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 = 15;
      Parameters:
      value - The geoTargetConstants to add.
      Returns:
      This builder for chaining.

    • addAllGeoTargetConstants

      public GenerateKeywordIdeasRequest.Builder addAllGeoTargetConstants(Iterable<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 = 15;
      Parameters:
      values - The geoTargetConstants to add.
      Returns:
      This builder for chaining.

    • clearGeoTargetConstants

      public GenerateKeywordIdeasRequest.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 = 15;
      Returns:
      This builder for chaining.

    • addGeoTargetConstantsBytes

      public GenerateKeywordIdeasRequest.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 = 15;
      Parameters:
      value - The bytes of the geoTargetConstants to add.
      Returns:
      This builder for chaining.

    • getIncludeAdultKeywords

      public boolean getIncludeAdultKeywords()
       If true, adult keywords will be included in response.
 The default value is false.
      bool include_adult_keywords = 10;
      Specified by:
      getIncludeAdultKeywords in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The includeAdultKeywords.

    • setIncludeAdultKeywords

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

    • clearIncludeAdultKeywords

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

    • getPageToken

      public String getPageToken()
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
      string page_token = 12;
      Specified by:
      getPageToken in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
      string page_token = 12;
      Specified by:
      getPageTokenBytes in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public GenerateKeywordIdeasRequest.Builder setPageToken(String value)
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
      string page_token = 12;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public GenerateKeywordIdeasRequest.Builder clearPageToken()
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
      string page_token = 12;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public GenerateKeywordIdeasRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
      string page_token = 12;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Number of results to retrieve in a single page.
 A maximum of 10,000 results may be returned, if the page_size
 exceeds this, it is ignored.
 If unspecified, at most 10,000 results will be returned.
 The server may decide to further limit the number of returned resources.
 If the response contains fewer than 10,000 results it may not be assumed
 as last page of results.
      int32 page_size = 13;
      Specified by:
      getPageSize in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public GenerateKeywordIdeasRequest.Builder setPageSize(int value)
       Number of results to retrieve in a single page.
 A maximum of 10,000 results may be returned, if the page_size
 exceeds this, it is ignored.
 If unspecified, at most 10,000 results will be returned.
 The server may decide to further limit the number of returned resources.
 If the response contains fewer than 10,000 results it may not be assumed
 as last page of results.
      int32 page_size = 13;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public GenerateKeywordIdeasRequest.Builder clearPageSize()
       Number of results to retrieve in a single page.
 A maximum of 10,000 results may be returned, if the page_size
 exceeds this, it is ignored.
 If unspecified, at most 10,000 results will be returned.
 The server may decide to further limit the number of returned resources.
 If the response contains fewer than 10,000 results it may not be assumed
 as last page of results.
      int32 page_size = 13;
      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.v18.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
      Specified by:
      getKeywordPlanNetworkValue in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The enum numeric value on the wire for keywordPlanNetwork.

    • setKeywordPlanNetworkValue

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

    • getKeywordPlanNetwork

      public KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork()
       Targeting network.
 If not set, Google Search And Partners Network will be used.
      .google.ads.googleads.v18.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
      Specified by:
      getKeywordPlanNetwork in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The keywordPlanNetwork.

    • setKeywordPlanNetwork

      public GenerateKeywordIdeasRequest.Builder setKeywordPlanNetwork(KeywordPlanNetworkEnum.KeywordPlanNetwork value)
       Targeting network.
 If not set, Google Search And Partners Network will be used.
      .google.ads.googleads.v18.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
      Parameters:
      value - The keywordPlanNetwork to set.
      Returns:
      This builder for chaining.

    • clearKeywordPlanNetwork

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

    • getKeywordAnnotationList

      public List<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation> getKeywordAnnotationList()
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Specified by:
      getKeywordAnnotationList in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      A list containing the keywordAnnotation.

    • getKeywordAnnotationCount

      public int getKeywordAnnotationCount()
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Specified by:
      getKeywordAnnotationCount in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The count of keywordAnnotation.

    • getKeywordAnnotation

      public KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation getKeywordAnnotation(int index)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Specified by:
      getKeywordAnnotation in interface GenerateKeywordIdeasRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The keywordAnnotation at the given index.

    • setKeywordAnnotation

      public GenerateKeywordIdeasRequest.Builder setKeywordAnnotation(int index, KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation value)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      index - The index to set the value at.
      value - The keywordAnnotation to set.
      Returns:
      This builder for chaining.

    • addKeywordAnnotation

      public GenerateKeywordIdeasRequest.Builder addKeywordAnnotation(KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation value)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      value - The keywordAnnotation to add.
      Returns:
      This builder for chaining.

    • addAllKeywordAnnotation

      public GenerateKeywordIdeasRequest.Builder addAllKeywordAnnotation(Iterable<? extends KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation> values)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      values - The keywordAnnotation to add.
      Returns:
      This builder for chaining.

    • clearKeywordAnnotation

      public GenerateKeywordIdeasRequest.Builder clearKeywordAnnotation()
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Returns:
      This builder for chaining.

    • getKeywordAnnotationValueList

      public List<Integer> getKeywordAnnotationValueList()
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Specified by:
      getKeywordAnnotationValueList in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for keywordAnnotation.

    • getKeywordAnnotationValue

      public int getKeywordAnnotationValue(int index)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Specified by:
      getKeywordAnnotationValue in interface GenerateKeywordIdeasRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of keywordAnnotation at the given index.

    • setKeywordAnnotationValue

      public GenerateKeywordIdeasRequest.Builder setKeywordAnnotationValue(int index, int value)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for keywordAnnotation to set.
      Returns:
      This builder for chaining.

    • addKeywordAnnotationValue

      public GenerateKeywordIdeasRequest.Builder addKeywordAnnotationValue(int value)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      value - The enum numeric value on the wire for keywordAnnotation to add.
      Returns:
      This builder for chaining.

    • addAllKeywordAnnotationValue

      public GenerateKeywordIdeasRequest.Builder addAllKeywordAnnotationValue(Iterable<Integer> values)
       The keyword annotations to include in response.
      repeated .google.ads.googleads.v18.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
      Parameters:
      values - The enum numeric values on the wire for keywordAnnotation to add.
      Returns:
      This builder for chaining.

    • hasAggregateMetrics

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

    • getAggregateMetrics

      public KeywordPlanAggregateMetrics getAggregateMetrics()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
      Specified by:
      getAggregateMetrics in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The aggregateMetrics.

    • setAggregateMetrics

      public GenerateKeywordIdeasRequest.Builder setAggregateMetrics(KeywordPlanAggregateMetrics value)
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;

    • setAggregateMetrics

      public GenerateKeywordIdeasRequest.Builder setAggregateMetrics(KeywordPlanAggregateMetrics.Builder builderForValue)
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;

    • mergeAggregateMetrics

      public GenerateKeywordIdeasRequest.Builder mergeAggregateMetrics(KeywordPlanAggregateMetrics value)
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;

    • clearAggregateMetrics

      public GenerateKeywordIdeasRequest.Builder clearAggregateMetrics()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;

    • getAggregateMetricsBuilder

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

    • getAggregateMetricsOrBuilder

      public KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
      Specified by:
      getAggregateMetricsOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • hasHistoricalMetricsOptions

      public boolean hasHistoricalMetricsOptions()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;
      Specified by:
      hasHistoricalMetricsOptions in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the historicalMetricsOptions field is set.

    • getHistoricalMetricsOptions

      public HistoricalMetricsOptions getHistoricalMetricsOptions()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;
      Specified by:
      getHistoricalMetricsOptions in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The historicalMetricsOptions.

    • setHistoricalMetricsOptions

      public GenerateKeywordIdeasRequest.Builder setHistoricalMetricsOptions(HistoricalMetricsOptions value)
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;

    • setHistoricalMetricsOptions

      public GenerateKeywordIdeasRequest.Builder setHistoricalMetricsOptions(HistoricalMetricsOptions.Builder builderForValue)
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;

    • mergeHistoricalMetricsOptions

      public GenerateKeywordIdeasRequest.Builder mergeHistoricalMetricsOptions(HistoricalMetricsOptions value)
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;

    • clearHistoricalMetricsOptions

      public GenerateKeywordIdeasRequest.Builder clearHistoricalMetricsOptions()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;

    • getHistoricalMetricsOptionsBuilder

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

    • getHistoricalMetricsOptionsOrBuilder

      public HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 18;
      Specified by:
      getHistoricalMetricsOptionsOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • hasKeywordAndUrlSeed

      public boolean hasKeywordAndUrlSeed()
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
      Specified by:
      hasKeywordAndUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the keywordAndUrlSeed field is set.

    • getKeywordAndUrlSeed

      public KeywordAndUrlSeed getKeywordAndUrlSeed()
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
      Specified by:
      getKeywordAndUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The keywordAndUrlSeed.

    • setKeywordAndUrlSeed

      public GenerateKeywordIdeasRequest.Builder setKeywordAndUrlSeed(KeywordAndUrlSeed value)
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

    • setKeywordAndUrlSeed

      public GenerateKeywordIdeasRequest.Builder setKeywordAndUrlSeed(KeywordAndUrlSeed.Builder builderForValue)
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

    • mergeKeywordAndUrlSeed

      public GenerateKeywordIdeasRequest.Builder mergeKeywordAndUrlSeed(KeywordAndUrlSeed value)
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

    • clearKeywordAndUrlSeed

      public GenerateKeywordIdeasRequest.Builder clearKeywordAndUrlSeed()
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

    • getKeywordAndUrlSeedBuilder

      public KeywordAndUrlSeed.Builder getKeywordAndUrlSeedBuilder()
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

    • getKeywordAndUrlSeedOrBuilder

      public KeywordAndUrlSeedOrBuilder getKeywordAndUrlSeedOrBuilder()
       A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
      .google.ads.googleads.v18.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
      Specified by:
      getKeywordAndUrlSeedOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • hasKeywordSeed

      public boolean hasKeywordSeed()
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;
      Specified by:
      hasKeywordSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the keywordSeed field is set.

    • getKeywordSeed

      public KeywordSeed getKeywordSeed()
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;
      Specified by:
      getKeywordSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The keywordSeed.

    • setKeywordSeed

      public GenerateKeywordIdeasRequest.Builder setKeywordSeed(KeywordSeed value)
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;

    • setKeywordSeed

      public GenerateKeywordIdeasRequest.Builder setKeywordSeed(KeywordSeed.Builder builderForValue)
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;

    • mergeKeywordSeed

      public GenerateKeywordIdeasRequest.Builder mergeKeywordSeed(KeywordSeed value)
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;

    • clearKeywordSeed

      public GenerateKeywordIdeasRequest.Builder clearKeywordSeed()
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;

    • getKeywordSeedBuilder

      public KeywordSeed.Builder getKeywordSeedBuilder()
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;

    • getKeywordSeedOrBuilder

      public KeywordSeedOrBuilder getKeywordSeedOrBuilder()
       A Keyword or phrase to generate ideas from, for example, cars.
      .google.ads.googleads.v18.services.KeywordSeed keyword_seed = 3;
      Specified by:
      getKeywordSeedOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • hasUrlSeed

      public boolean hasUrlSeed()
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;
      Specified by:
      hasUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the urlSeed field is set.

    • getUrlSeed

      public UrlSeed getUrlSeed()
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;
      Specified by:
      getUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The urlSeed.

    • setUrlSeed

      public GenerateKeywordIdeasRequest.Builder setUrlSeed(UrlSeed value)
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;

    • setUrlSeed

      public GenerateKeywordIdeasRequest.Builder setUrlSeed(UrlSeed.Builder builderForValue)
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;

    • mergeUrlSeed

      public GenerateKeywordIdeasRequest.Builder mergeUrlSeed(UrlSeed value)
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;

    • clearUrlSeed

      public GenerateKeywordIdeasRequest.Builder clearUrlSeed()
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;

    • getUrlSeedBuilder

      public UrlSeed.Builder getUrlSeedBuilder()
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;

    • getUrlSeedOrBuilder

      public UrlSeedOrBuilder getUrlSeedOrBuilder()
       A specific url to generate ideas from, for example, www.example.com/cars.
      .google.ads.googleads.v18.services.UrlSeed url_seed = 5;
      Specified by:
      getUrlSeedOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • hasSiteSeed

      public boolean hasSiteSeed()
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;
      Specified by:
      hasSiteSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      Whether the siteSeed field is set.

    • getSiteSeed

      public SiteSeed getSiteSeed()
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;
      Specified by:
      getSiteSeed in interface GenerateKeywordIdeasRequestOrBuilder
      Returns:
      The siteSeed.

    • setSiteSeed

      public GenerateKeywordIdeasRequest.Builder setSiteSeed(SiteSeed value)
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;

    • setSiteSeed

      public GenerateKeywordIdeasRequest.Builder setSiteSeed(SiteSeed.Builder builderForValue)
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;

    • mergeSiteSeed

      public GenerateKeywordIdeasRequest.Builder mergeSiteSeed(SiteSeed value)
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;

    • clearSiteSeed

      public GenerateKeywordIdeasRequest.Builder clearSiteSeed()
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;

    • getSiteSeedBuilder

      public SiteSeed.Builder getSiteSeedBuilder()
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;

    • getSiteSeedOrBuilder

      public SiteSeedOrBuilder getSiteSeedOrBuilder()
       The site to generate ideas from, for example, www.example.com.
      .google.ads.googleads.v18.services.SiteSeed site_seed = 11;
      Specified by:
      getSiteSeedOrBuilder in interface GenerateKeywordIdeasRequestOrBuilder

    • setUnknownFields

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

    • mergeUnknownFields

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