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

Class SearchGoogleAdsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v17.services.SearchGoogleAdsRequest
All Implemented Interfaces:
SearchGoogleAdsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SearchGoogleAdsRequest extends com.google.protobuf.GeneratedMessageV3 implements SearchGoogleAdsRequestOrBuilder
 Request message for
 [GoogleAdsService.Search][google.ads.googleads.v17.services.GoogleAdsService.Search].
Protobuf type google.ads.googleads.v17.services.SearchGoogleAdsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • VALIDATE_ONLY_FIELD_NUMBER

      public static final int VALIDATE_ONLY_FIELD_NUMBER
      See Also:

    • RETURN_TOTAL_RESULTS_COUNT_FIELD_NUMBER

      public static final int RETURN_TOTAL_RESULTS_COUNT_FIELD_NUMBER
      See Also:

    • SUMMARY_ROW_SETTING_FIELD_NUMBER

      public static final int SUMMARY_ROW_SETTING_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

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

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

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

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

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

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

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

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

    • 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 SearchGoogleAdsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchGoogleAdsRequest.Builder newBuilder()

    • newBuilder

      public static SearchGoogleAdsRequest.Builder newBuilder(SearchGoogleAdsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchGoogleAdsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchGoogleAdsRequest> 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 SearchGoogleAdsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder