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

Class SearchGoogleAdsResponse

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SearchGoogleAdsResponse.Builder
      Response message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • NEXT_PAGE_TOKEN_FIELD_NUMBER

        public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_RESULTS_COUNT_FIELD_NUMBER

        public static final int TOTAL_RESULTS_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FIELD_MASK_FIELD_NUMBER

        public static final int FIELD_MASK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUMMARY_ROW_FIELD_NUMBER

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

      • getResultsCount

        public int getResultsCount()
         The list of rows that matched the query.
        repeated .google.ads.googleads.v10.services.GoogleAdsRow results = 1;
        Specified by:
        getResultsCount in interface SearchGoogleAdsResponseOrBuilder

      • getNextPageToken

        public java.lang.String getNextPageToken()
         Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
        string next_page_token = 2;
        Specified by:
        getNextPageToken in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        The nextPageToken.

      • getNextPageTokenBytes

        public com.google.protobuf.ByteString getNextPageTokenBytes()
         Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
        string next_page_token = 2;
        Specified by:
        getNextPageTokenBytes in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        The bytes for nextPageToken.

      • getTotalResultsCount

        public long getTotalResultsCount()
         Total number of results that match the query ignoring the LIMIT
 clause.
        int64 total_results_count = 3;
        Specified by:
        getTotalResultsCount in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        The totalResultsCount.

      • hasFieldMask

        public boolean hasFieldMask()
         FieldMask that represents what fields were requested by the user.
        .google.protobuf.FieldMask field_mask = 5;
        Specified by:
        hasFieldMask in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        Whether the fieldMask field is set.

      • getFieldMask

        public com.google.protobuf.FieldMask getFieldMask()
         FieldMask that represents what fields were requested by the user.
        .google.protobuf.FieldMask field_mask = 5;
        Specified by:
        getFieldMask in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        The fieldMask.

      • getFieldMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
         FieldMask that represents what fields were requested by the user.
        .google.protobuf.FieldMask field_mask = 5;
        Specified by:
        getFieldMaskOrBuilder in interface SearchGoogleAdsResponseOrBuilder

      • hasSummaryRow

        public boolean hasSummaryRow()
         Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
        .google.ads.googleads.v10.services.GoogleAdsRow summary_row = 6;
        Specified by:
        hasSummaryRow in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        Whether the summaryRow field is set.

      • getSummaryRow

        public GoogleAdsRow getSummaryRow()
         Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
        .google.ads.googleads.v10.services.GoogleAdsRow summary_row = 6;
        Specified by:
        getSummaryRow in interface SearchGoogleAdsResponseOrBuilder
        Returns:
        The summaryRow.

      • getSummaryRowOrBuilder

        public GoogleAdsRowOrBuilder getSummaryRowOrBuilder()
         Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
        .google.ads.googleads.v10.services.GoogleAdsRow summary_row = 6;
        Specified by:
        getSummaryRowOrBuilder in interface SearchGoogleAdsResponseOrBuilder

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

      • parseFrom

        public static SearchGoogleAdsResponse parseFrom​(java.nio.ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static SearchGoogleAdsResponse parseFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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