Method: queries.run
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eRuns an existing query to generate a report using the specified date range.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclickbidmanager\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eAccepts a \u003ccode\u003equeryId\u003c/code\u003e as a path parameter and optionally a \u003ccode\u003esynchronous\u003c/code\u003e flag as a query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows for specifying a custom \u003ccode\u003edataRange\u003c/code\u003e for the report, otherwise defaults to the query's original data range.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns a \u003ccode\u003eReport\u003c/code\u003e object containing the generated report data.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [RunQueryRequest](#RunQueryRequest)\n - [JSON representation](#RunQueryRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRuns an existing query to generate a report.\n\nHTTP request\n\n`POST https://doubleclickbidmanager.googleapis.com/v2/queries/{queryId}:run`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------|\n| `queryId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the query to run. |\n\nQuery parameters\n\n| Parameters ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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**. |\n\nRequest body\n\nThe request body contains an instance of [RunQueryRequest](/bid-manager/reference/rest/v2/queries/run#RunQueryRequest).\n\nResponse body\n\nIf successful, the response body contains an instance of [Report](/bid-manager/reference/rest/v2/queries.reports#Report).\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nRunQueryRequest Details specifying how to run a query.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------|\n| ``` { \"dataRange\": { object (/bid-manager/reference/rest/v2/queries#DataRange) } } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataRange` | `object (`[DataRange](/bid-manager/reference/rest/v2/queries#DataRange)`)` The date range used by the query to generate the report. If unspecified, the query's original [dataRange](/bid-manager/reference/rest/v2/queries#QueryMetadata.FIELDS.data_range) is used. |"]]
