Method: queries.run

  • The core function of this operation is to run an existing query to generate a report.

  • The HTTP request uses a POST method with a URL including a queryId path parameter.

  • An optional synchronous query parameter can be used, but setting it to true is not recommended.

  • The request body contains details on how to run the query, including an optional dataRange.

  • A successful response body will contain a Report object, and authorization requires the https://www.googleapis.com/auth/doubleclickbidmanager OAuth scope.

Runs an existing query to generate a report.

HTTP request

POST https://doubleclickbidmanager.googleapis.com/v2/queries/{queryId}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
queryId

string (int64 format)

Required. The ID of the query to run.

Query parameters

Parameters
synchronous

boolean

Whether the query should be run synchronously. When true, the request won't return until the resulting report has finished running. This parameter is false by default.

Setting this parameter to true is not recommended.

Request body

The request body contains an instance of RunQueryRequest.

Response body

If successful, the response body contains an instance of Report.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

RunQueryRequest

Details specifying how to run a query.

JSON representation 
{
  "dataRange": {
    object (DataRange)
  }
}
Fields
dataRange

object (DataRange)

The date range used by the query to generate the report.

If unspecified, the query's original dataRange is used.