Package com.google.ads.googleads.v10.services

Class SearchGoogleAdsRequest

  • All Implemented Interfaces:
    SearchGoogleAdsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class SearchGoogleAdsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchGoogleAdsRequestOrBuilder
     Request message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].
    Protobuf type google.ads.googleads.v10.services.SearchGoogleAdsRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PAGE_TOKEN_FIELD_NUMBER

        public static final int PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALIDATE_ONLY_FIELD_NUMBER

        public static final int VALIDATE_ONLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RETURN_TOTAL_RESULTS_COUNT_FIELD_NUMBER

        public static final int RETURN_TOTAL_RESULTS_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUMMARY_ROW_SETTING_FIELD_NUMBER

        public static final int SUMMARY_ROW_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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 java.lang.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 java.lang.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 java.lang.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.v10.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.v10.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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchGoogleAdsRequest parseFrom​(java.nio.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​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static SearchGoogleAdsRequest parseDelimitedFrom​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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

      • 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