Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.googleAds.searchStream

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/v7/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

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

Response message for GoogleAdsService.SearchStream.

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

object (GoogleAdsRow)

The list of rows that matched the query.

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".

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.

requestId

string

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.