Stay organized with collectionsSave and categorize content based on your preferences.
Runs a stored query to generate a report.Try it now.
Request
HTTP request
POST https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
Parameters
Parameter name
Value
Description
Path parameters
queryId
long
Query ID to run.
Optional query parameters
asynchronous
boolean
Whether the query should be run asynchronously. When true, this method
will return immediately. When false or not specified, this method will not
return until the query has finished running.
(Default:false)
Authorization
This request requires authorization with the following scope:
[[["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 2024-08-21 UTC."],[[["\u003cp\u003eThis version of the Bid Manager API is sunset, and users should migrate to Bid Manager API v2.\u003c/p\u003e\n"],["\u003cp\u003eRequests to this version may return errors, and specific fields in retrieved \u003ccode\u003eQuery\u003c/code\u003e resources will be empty.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erunquery\u003c/code\u003e request runs a stored query to generate a report, accepting parameters like \u003ccode\u003equeryId\u003c/code\u003e, \u003ccode\u003easynchronous\u003c/code\u003e, \u003ccode\u003edataRange\u003c/code\u003e, and time parameters.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclickbidmanager\u003c/code\u003e scope is required for this request.\u003c/p\u003e\n"]]],["The Bid Manager API v1.1 is sunset; users must migrate to v2. Requests to v1.1 may error, and successful requests will return empty `metadata.googleCloudStoragePathForLatestReport`, `metadata.latestReportRunTimeMs`, and `metadata.googleDrivePathForLatestReport` fields. To run a query, send a POST request with the `queryId`, optional asynchronous parameter, and report data range, start/end times, and timezone in the request body. This requires authorization with the `doubleclickbidmanager` scope.\n"],null,["# Queries: runquery\n\n| This version of the Bid Manager API has been sunset. Users must [migrate to Bid Manager API v2](/bid-manager/how-tos/v2-migration).\n|\n|\n| Requests to this version may return an error. If the request is successful, the following fields in retrieved [`Query`](/bid-manager/v1.1/queries#resource) resources will be empty:\n|\n| - [`metadata.googleCloudStoragePathForLatestReport`](/bid-manager/v1.1/queries#metadata.googleCloudStoragePathForLatestReport)\n| - [`metadata.latestReportRunTimeMs`](/bid-manager/v1.1/queries#metadata.latestReportRunTimeMs)\n| - [`metadata.googleDrivePathForLatestReport`](/bid-manager/v1.1/queries#metadata.googleDrivePathForLatestReport)\n|\n| \u003cbr /\u003e\n|\n| **Note:** Requires [authorization](#auth).\n\nRuns a stored query to generate a report.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `queryId` | `long` | Query ID to run. |\n| **Optional query parameters** |||\n| `asynchronous` | `boolean` | Whether the query should be run asynchronously. When true, this method will return immediately. When false or not specified, this method will not return until the query has finished running. (Default: `false`) |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|---------------------------------------------------------|\n| `https://www.googleapis.com/auth/doubleclickbidmanager` |\n\nFor more information, see the [authentication and authorization](/bid-manager/how-tos/authorizing) page.\n\n### Request body\n\nIn the request body, supply data with the following structure:\n\n```text\n{\n \"dataRange\": string,\n \"reportDataStartTimeMs\": long,\n \"reportDataEndTimeMs\": long,\n \"timezoneCode\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|-------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `dataRange` | `string` | Report data range used to generate the report. \u003cbr /\u003e Acceptable values are: - \"`ALL_TIME`\" - \"`CURRENT_DAY`\" - \"`CUSTOM_DATES`\" - \"`LAST_14_DAYS`\" - \"`LAST_30_DAYS`\" - \"`LAST_365_DAYS`\" - \"`LAST_60_DAYS`\" - \"`LAST_7_DAYS`\" - \"`LAST_90_DAYS`\" - \"`MONTH_TO_DATE`\" - \"`PREVIOUS_DAY`\" - \"`PREVIOUS_HALF_MONTH`\" - \"`PREVIOUS_MONTH`\" - \"`PREVIOUS_QUARTER`\" - \"`PREVIOUS_WEEK`\" - \"`PREVIOUS_YEAR`\" - \"`QUARTER_TO_DATE`\" - \"`TYPE_NOT_SUPPORTED`\" - \"`WEEK_TO_DATE`\" - \"`YEAR_TO_DATE`\" | |\n| `reportDataStartTimeMs` | `long` | The starting time for the data that is shown in the report. Note, `reportDataStartTimeMs` is required if `dataRange` is `CUSTOM_DATES` and ignored otherwise. | |\n| `reportDataEndTimeMs` | `long` | The ending time for the data that is shown in the report. Note, `reportDataEndTimeMs` is required if `dataRange` is `CUSTOM_DATES` and ignored otherwise. | |\n| `timezoneCode` | `string` | Canonical timezone code for report data time. Defaults to `America/New_York`. | |\n\nResponse\n--------\n\nIf successful, this method returns an empty response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response.\nAlternatively, try the\n[standalone\nExplorer](https://developers.google.com/apis-explorer/#p/doubleclickbidmanager/v1.1/doubleclickbidmanager.queries.runquery)."]]
