Method: customers.searchAds360.searchStream

  • Returns all rows matching the specified search stream query, enabling retrieval of Search Ads 360 data.

  • Requires a POST request to the designated endpoint with query parameters including customerId, query, batchSize, and summaryRowSetting.

  • The response includes a list of matching rows, field mask, summary row (optional), custom column headers, and request ID.

  • Utilizes gRPC Transcoding for URL syntax and necessitates the https://www.googleapis.com/auth/doubleclicksearch OAuth scope for authorization.

Returns all rows that match the search stream query.

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

HTTP request

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Fields
query

string

Required. The query string.
batchSize

integer

The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows.
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 SearchAds360Service.SearchStream.

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

JSON representation 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Fields
results[]

object (SearchAds360Row)

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 (SearchAds360Row)

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.
customColumnHeaders[]

object (CustomColumnHeader)

The headers of the custom columns in the results.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

The headers of the conversion custom metrics in the results.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

The headers of the conversion custom dimension in the results.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

The headers of the raw event conversion metrics in the results.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

The headers of the raw event conversion dimensions in the results.
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/doubleclicksearch