Package com.google.ads.googleads.v17.services

Class SearchGoogleAdsRequest.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public SearchGoogleAdsRequest.Builder mergeFrom(SearchGoogleAdsRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer being queried.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer being queried.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The bytes for customerId.

    • setCustomerId

      public SearchGoogleAdsRequest.Builder setCustomerId(String value)
       Required. The ID of the customer being queried.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The customerId to set.
      Returns:
      This builder for chaining.

    • clearCustomerId

      public SearchGoogleAdsRequest.Builder clearCustomerId()
       Required. The ID of the customer being queried.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setCustomerIdBytes

      public SearchGoogleAdsRequest.Builder setCustomerIdBytes(com.google.protobuf.ByteString value)
       Required. The ID of the customer being queried.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for customerId to set.
      Returns:
      This builder for chaining.

    • getQuery

      public String getQuery()
       Required. The query string.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Required. The query string.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryBytes in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public SearchGoogleAdsRequest.Builder setQuery(String value)
       Required. The query string.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchGoogleAdsRequest.Builder clearQuery()
       Required. The query string.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchGoogleAdsRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       Required. The query string.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for query to set.
      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. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
      string page_token = 3;
      Specified by:
      getPageToken in interface SearchGoogleAdsRequestOrBuilder
      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. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public SearchGoogleAdsRequest.Builder setPageToken(String value)
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchGoogleAdsRequest.Builder clearPageToken()
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchGoogleAdsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Token of the page to retrieve. If not specified, the first
 page of results will be returned. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Number of elements to retrieve in a single page.
 When too large a page is requested, the server may decide to
 further limit the number of returned resources.
      int32 page_size = 4;
      Specified by:
      getPageSize in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public SearchGoogleAdsRequest.Builder setPageSize(int value)
       Number of elements to retrieve in a single page.
 When too large a page is requested, the server may decide to
 further limit the number of returned resources.
      int32 page_size = 4;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchGoogleAdsRequest.Builder clearPageSize()
       Number of elements to retrieve in a single page.
 When too large a page is requested, the server may decide to
 further limit the number of returned resources.
      int32 page_size = 4;
      Returns:
      This builder for chaining.

    • getValidateOnly

      public boolean getValidateOnly()
       If true, the request is validated but not executed.
      bool validate_only = 5;
      Specified by:
      getValidateOnly in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The validateOnly.

    • setValidateOnly

      public SearchGoogleAdsRequest.Builder setValidateOnly(boolean value)
       If true, the request is validated but not executed.
      bool validate_only = 5;
      Parameters:
      value - The validateOnly to set.
      Returns:
      This builder for chaining.

    • clearValidateOnly

      public SearchGoogleAdsRequest.Builder clearValidateOnly()
       If true, the request is validated but not executed.
      bool validate_only = 5;
      Returns:
      This builder for chaining.

    • getReturnTotalResultsCount

      public boolean getReturnTotalResultsCount()
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 7;
      Specified by:
      getReturnTotalResultsCount in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The returnTotalResultsCount.

    • setReturnTotalResultsCount

      public SearchGoogleAdsRequest.Builder setReturnTotalResultsCount(boolean value)
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 7;
      Parameters:
      value - The returnTotalResultsCount to set.
      Returns:
      This builder for chaining.

    • clearReturnTotalResultsCount

      public SearchGoogleAdsRequest.Builder clearReturnTotalResultsCount()
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 7;
      Returns:
      This builder for chaining.

    • getSummaryRowSettingValue

      public int getSummaryRowSettingValue()
       Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
      .google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
      Specified by:
      getSummaryRowSettingValue in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for summaryRowSetting.

    • setSummaryRowSettingValue

      public SearchGoogleAdsRequest.Builder setSummaryRowSettingValue(int value)
       Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
      .google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
      Parameters:
      value - The enum numeric value on the wire for summaryRowSetting to set.
      Returns:
      This builder for chaining.

    • getSummaryRowSetting

      public SummaryRowSettingEnum.SummaryRowSetting getSummaryRowSetting()
       Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
      .google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
      Specified by:
      getSummaryRowSetting in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The summaryRowSetting.

    • setSummaryRowSetting

      public SearchGoogleAdsRequest.Builder setSummaryRowSetting(SummaryRowSettingEnum.SummaryRowSetting value)
       Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
      .google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
      Parameters:
      value - The summaryRowSetting to set.
      Returns:
      This builder for chaining.

    • clearSummaryRowSetting

      public SearchGoogleAdsRequest.Builder clearSummaryRowSetting()
       Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
      .google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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