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

Interface SearchGoogleAdsStreamResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchGoogleAdsStreamResponse, SearchGoogleAdsStreamResponse.Builder
public interface SearchGoogleAdsStreamResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.FieldMask
    getFieldMask()
    FieldMask that represents what fields were requested by the user.
    com.google.protobuf.FieldMaskOrBuilder
    getFieldMaskOrBuilder()
    FieldMask that represents what fields were requested by the user.
    long
    getQueryResourceConsumption()
    The amount of resources consumed to serve the query.
    String
    getRequestId()
    The unique id of the request that is used for debugging purposes.
    com.google.protobuf.ByteString
    getRequestIdBytes()
    The unique id of the request that is used for debugging purposes.
    GoogleAdsRow
    getResults(int index)
    The list of rows that matched the query.
    int
    getResultsCount()
    The list of rows that matched the query.
    List<GoogleAdsRow>
    getResultsList()
    The list of rows that matched the query.
    GoogleAdsRowOrBuilder
    getResultsOrBuilder(int index)
    The list of rows that matched the query.
    List<? extends GoogleAdsRowOrBuilder>
    getResultsOrBuilderList()
    The list of rows that matched the query.
    GoogleAdsRow
    getSummaryRow()
    Summary row that contains summary of metrics in results.
    GoogleAdsRowOrBuilder
    getSummaryRowOrBuilder()
    Summary row that contains summary of metrics in results.
    boolean
    hasFieldMask()
    FieldMask that represents what fields were requested by the user.
    boolean
    hasSummaryRow()
    Summary row that contains summary of metrics in results.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getResultsList

      List<GoogleAdsRow> getResultsList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResults

      GoogleAdsRow getResults(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResultsCount

      int getResultsCount()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResultsOrBuilderList

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

    • getResultsOrBuilder

      GoogleAdsRowOrBuilder getResultsOrBuilder(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • hasFieldMask

      boolean hasFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 2;
      Returns:
      Whether the fieldMask field is set.

    • getFieldMask

      com.google.protobuf.FieldMask getFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 2;
      Returns:
      The fieldMask.

    • getFieldMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 2;

    • hasSummaryRow

      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;
      Returns:
      Whether the summaryRow field is set.

    • getSummaryRow

      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;
      Returns:
      The summaryRow.

    • getSummaryRowOrBuilder

      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;

    • getRequestId

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

    • getRequestIdBytes

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

    • getQueryResourceConsumption

      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;
      Returns:
      The queryResourceConsumption.