Package com.google.ads.googleads.v18.services

Class SearchGoogleAdsStreamResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.SearchGoogleAdsStreamResponse
All Implemented Interfaces:
SearchGoogleAdsStreamResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SearchGoogleAdsStreamResponse extends com.google.protobuf.GeneratedMessageV3 implements SearchGoogleAdsStreamResponseOrBuilder
 Response message for
 [GoogleAdsService.SearchStream][google.ads.googleads.v18.services.GoogleAdsService.SearchStream].
Protobuf type google.ads.googleads.v18.services.SearchGoogleAdsStreamResponse
See Also:

  • Field Details

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:

    • FIELD_MASK_FIELD_NUMBER

      public static final int FIELD_MASK_FIELD_NUMBER
      See Also:

    • SUMMARY_ROW_FIELD_NUMBER

      public static final int SUMMARY_ROW_FIELD_NUMBER
      See Also:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:

    • QUERY_RESOURCE_CONSUMPTION_FIELD_NUMBER

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

    • getResultsList

      public List<GoogleAdsRow> getResultsList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsList in interface SearchGoogleAdsStreamResponseOrBuilder

    • getResultsOrBuilderList

      public List<? extends GoogleAdsRowOrBuilder> getResultsOrBuilderList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsOrBuilderList in interface SearchGoogleAdsStreamResponseOrBuilder

    • getResultsCount

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

    • getResults

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

    • getResultsOrBuilder

      public GoogleAdsRowOrBuilder getResultsOrBuilder(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsOrBuilder in interface SearchGoogleAdsStreamResponseOrBuilder

    • hasFieldMask

      public boolean hasFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 2;
      Specified by:
      hasFieldMask in interface SearchGoogleAdsStreamResponseOrBuilder
      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 = 2;
      Specified by:
      getFieldMask in interface SearchGoogleAdsStreamResponseOrBuilder
      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 = 2;
      Specified by:
      getFieldMaskOrBuilder in interface SearchGoogleAdsStreamResponseOrBuilder

    • 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.v18.services.GoogleAdsRow summary_row = 3;
      Specified by:
      hasSummaryRow in interface SearchGoogleAdsStreamResponseOrBuilder
      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.v18.services.GoogleAdsRow summary_row = 3;
      Specified by:
      getSummaryRow in interface SearchGoogleAdsStreamResponseOrBuilder
      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.v18.services.GoogleAdsRow summary_row = 3;
      Specified by:
      getSummaryRowOrBuilder in interface SearchGoogleAdsStreamResponseOrBuilder

    • getRequestId

      public String getRequestId()
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Specified by:
      getRequestId in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The requestId.

    • getRequestIdBytes

      public com.google.protobuf.ByteString getRequestIdBytes()
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Specified by:
      getRequestIdBytes in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The bytes for requestId.

    • getQueryResourceConsumption

      public long getQueryResourceConsumption()
       The amount of resources consumed to serve the query.
 query_resource_consumption for the Summary row and non-Summary responses
 are returned separately in their respective rows.
 query_resource_consumption for non-Summary responses is returned in the
 final batch of results.
      int64 query_resource_consumption = 6;
      Specified by:
      getQueryResourceConsumption in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The queryResourceConsumption.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchGoogleAdsStreamResponse.Builder newBuilder()

    • newBuilder

      public static SearchGoogleAdsStreamResponse.Builder newBuilder(SearchGoogleAdsStreamResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchGoogleAdsStreamResponse getDefaultInstance()

    • parser

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

    • getParserForType

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