SearchStream

  • SearchStream returns all rows that match the search stream query.

  • SearchStream requires the https://www.googleapis.com/auth/adwords OAuth scope.

Returns all rows that match the search stream query.

List of thrown errors: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v21/customers/{customerId}/googleAds:searchStream

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer being queried.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Fields
query

string

Required. The query string.
summaryRowSetting

enum (SummaryRowSetting)

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.

Response body

Response message for GoogleAdsService.SearchStream.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Fields
fieldMask

string (FieldMask format)

FieldMask that represents what fields were requested by the user.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
queryResourceConsumption

string (int64 format)

The amount of resources consumed to serve the query. queryResourceConsumption for the Summary row and non-Summary responses are returned separately in their respective rows. queryResourceConsumption for non-Summary responses is returned in the final batch of results.
requestId

string

The unique id of the request that is used for debugging purposes.
results[]

object (GoogleAdsRow)

The list of rows that matched the query.
summaryRow

object (GoogleAdsRow)

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.

SummaryRowSetting

Enum describing return summary row settings.

Enums
NO_SUMMARY_ROW Do not return summary row.
SUMMARY_ROW_ONLY Return summary row only and return no results.
SUMMARY_ROW_WITH_RESULTS Return summary row along with results. The summary row will be returned in the last batch alone (last batch will contain no results).
UNKNOWN Represent unknown values of return summary row.
UNSPECIFIED Not specified.
Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.