The Campaign Manager 360 API v3.3 is deprecated and will be sunset on June 30th, 2021. All users must migrate to a newer API version by that date.

Method: reports.list

Retrieves list of reports.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v3.3/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
pageToken

string

The value of the nextToken from the previous result page.

maxResults

integer

Maximum number of results to return.

sortField

enum (SortField)

The field by which to sort the list.

sortOrder

enum (SortOrder)

Order of sorted results.

scope

enum (Scope)

The scope that defines which results are returned.

Request body

The request body must be empty.

Response body

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

Represents the list of reports.

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

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.

Scope

Enums
ALL All reports in account.
MINE My reports.