Method: reports.list

  • This page details how to retrieve a list of reports using a GET HTTP request.

  • The request requires a path parameter for the user profile ID.

  • Optional query parameters like maxResults, pageToken, scope, sortField, and sortOrder can be used to refine the results.

  • The request body must be empty, and the response body contains a JSON representation of the list of reports.

  • The request requires authorization with the https://www.googleapis.com/auth/dfareporting scope.

Retrieves list of reports.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/reports

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

The Campaign Manager 360 user profile ID.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.
pageToken

string

The value of the nextToken from the previous result page.
scope

enum (Scope)

The scope that defines which results are returned.
sortField

enum (SortField)

The field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Represents the list of reports.

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

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

string

The kind of list this is, in this case

dfareporting#reportList

.
etag

string

The eTag of this response for caching purposes.
items[]

object (Report)

The reports returned in this response.
nextPageToken

string

Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.

Authorization scopes

Requires the following OAuth scope:

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

Scope

Enums
ALL All reports in account.
MINE My reports.

SortField

Enums
ID Sort by report ID.
LAST_MODIFIED_TIME Sort by 'lastModifiedTime' field.
NAME Sort by name of reports.

SortOrder

Enums
ASCENDING Ascending order.
DESCENDING Descending order.