Package com.google.ads.googleads.v21.services

Class SearchGoogleAdsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.services.SearchGoogleAdsRequest
All Implemented Interfaces:
SearchGoogleAdsRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, 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.v21.services.GoogleAdsService.Search].
Protobuf type google.ads.googleads.v21.services.SearchGoogleAdsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchGoogleAdsRequest.Builder
    Request message for [GoogleAdsService.Search][google.ads.googleads.v21.services.GoogleAdsService.Search].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CUSTOMER_ID_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    SEARCH_SETTINGS_FIELD_NUMBER
     
    static final int
    VALIDATE_ONLY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getCustomerId()
    Required.
    com.google.protobuf.ByteString
    getCustomerIdBytes()
    Required.
    static SearchGoogleAdsRequest
    getDefaultInstance()
     
    SearchGoogleAdsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getPageSize()
    This field is deprecated and will be removed in a future version of the API.
    String
    getPageToken()
    Token of the page to retrieve.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Token of the page to retrieve.
    com.google.protobuf.Parser<SearchGoogleAdsRequest>
    getParserForType()
     
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    SearchSettings
    getSearchSettings()
    Settings that allow users to specify request count, summary row, and results behavior.
    SearchSettingsOrBuilder
    getSearchSettingsOrBuilder()
    Settings that allow users to specify request count, summary row, and results behavior.
    int
    getSerializedSize()
     
    boolean
    getValidateOnly()
    If true, the request is validated but not executed.
    int
    hashCode()
     
    boolean
    hasSearchSettings()
    Settings that allow users to specify request count, summary row, and results behavior.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchGoogleAdsRequest.Builder
    newBuilder()
     
    static SearchGoogleAdsRequest.Builder
    newBuilder(SearchGoogleAdsRequest prototype)
     
    SearchGoogleAdsRequest.Builder
    newBuilderForType()
     
    protected SearchGoogleAdsRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SearchGoogleAdsRequest
    parseDelimitedFrom(InputStream input)
     
    static SearchGoogleAdsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsRequest
    parseFrom(byte[] data)
     
    static SearchGoogleAdsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchGoogleAdsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchGoogleAdsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsRequest
    parseFrom(InputStream input)
     
    static SearchGoogleAdsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsRequest
    parseFrom(ByteBuffer data)
     
    static SearchGoogleAdsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchGoogleAdsRequest>
    parser()
     
    SearchGoogleAdsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

    • SEARCH_SETTINGS_FIELD_NUMBER

      public static final int SEARCH_SETTINGS_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()
      Overrides:
      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()
       This field is deprecated and will be removed in
 a future version of the API. As of v17, Google Ads API will return a
 `PAGE_SIZE_NOT_SUPPORTED` error if this field is set in the request body.
 See
 https://ads-developers.googleblog.com/2024/07/upcoming-changes-to-page-size-in-google.html
 to learn more details.
      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.

    • hasSearchSettings

      public boolean hasSearchSettings()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v21.services.SearchSettings search_settings = 10;
      Specified by:
      hasSearchSettings in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      Whether the searchSettings field is set.

    • getSearchSettings

      public SearchSettings getSearchSettings()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v21.services.SearchSettings search_settings = 10;
      Specified by:
      getSearchSettings in interface SearchGoogleAdsRequestOrBuilder
      Returns:
      The searchSettings.

    • getSearchSettingsOrBuilder

      public SearchSettingsOrBuilder getSearchSettingsOrBuilder()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v21.services.SearchSettings search_settings = 10;
      Specified by:
      getSearchSettingsOrBuilder in interface SearchGoogleAdsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • getDefaultInstanceForType

      public SearchGoogleAdsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder