Method: queries.reports.list

  • Lists reports based on a provided query ID, using a GET request.

  • Allows for pagination through the use of pageSize and pageToken query parameters.

  • Results can be sorted using the orderBy query parameter.

  • Requires authorization with the https://www.googleapis.com/auth/doubleclickbidmanager scope.

  • Response includes a list of reports and a token for retrieving subsequent pages.

Lists reports generated by the provided query.

HTTP request

GET https://doubleclickbidmanager.googleapis.com/v2/queries/{queryId}/reports

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
queryId

string (int64 format)

Required. The ID of the query that generated the reports.

Query parameters

Parameters
pageSize

integer

Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
pageToken

string

A token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the queries.reports.list method. If unspecified, the first page of results is returned.
orderBy

string

Field to sort the list by. Accepts the following values:

  • key.reportId (default)

The default sorting order is ascending. To specify descending order for a field, add the suffix desc to the field name. For example, key.reportId desc.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "reports": [
    {
      object (Report)
    }
  ],
  "nextPageToken": string
}
Fields
reports[]

object (Report)

The list of reports.

This field will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to queries.reports.list method to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.