Method: files.list

  • This method lists files for a user profile using a GET request to the specified URL.

  • The API request includes a required path parameter profileId and optional query parameters like maxResults, pageToken, scope, sortField, and sortOrder.

  • The request body must be empty, and a successful response body will contain a FileList instance.

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

  • The scope and sortField parameters use specific enum values to filter and order the results respectively.

Lists files for a user profile.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/files

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

If successful, the response body contains an instance of FileList.

Authorization scopes

Requires the following OAuth scope:

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

Scope

Enums
ALL All files in account.
MINE My files.
SHARED_WITH_ME Files shared with me.

SortField

Enums
ID Sort by file ID.
LAST_MODIFIED_TIME Sort by 'lastmodifiedAt' field.