Queries: runquery

    • This version of the Bid Manager API has been sunset, and users must migrate to Bid Manager API v2.

    • Requests to this version may return an error, and if successful, certain fields in retrieved Query resources will be empty.

    • This method requires authorization with the https://www.googleapis.com/auth/doubleclickbidmanager scope.

    • The request body for this method includes optional fields for dataRange , reportDataStartTimeMs , reportDataEndTimeMs , and timezoneCode .

    • If successful, this method returns an empty response body.

    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:

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

    For more information, see the authentication and authorization page.

    Request body

    In the request body, supply data with the following structure:

    {
  "dataRange": string 
,
  "reportDataStartTimeMs": long 
,
  "reportDataEndTimeMs": long 
,
  "timezoneCode": string 
}
    Property name
    Value
    Description
    Notes
    dataRange
    string
    Report data range used to generate the report.

    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 "
    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.
    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.
    timezoneCode
    string
    Canonical timezone code for report data time. Defaults to America/New_York .

    Response

    If successful, this method returns an empty response body.

    Try it!

    Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: