Method: files.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists files for a user profile.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eLists files for a user profile, allowing filtering by scope, sorting, and pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/dfareporting\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eAccepts \u003ccode\u003eprofileId\u003c/code\u003e as a path parameter and \u003ccode\u003emaxResults\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003escope\u003c/code\u003e, \u003ccode\u003esortField\u003c/code\u003e, and \u003ccode\u003esortOrder\u003c/code\u003e as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ca href=\"/doubleclick-advertisers/rest/v4/FileList\"\u003eFileList\u003c/a\u003e object containing the list of files if successful.\u003c/p\u003e\n"]]],[],null,["# Method: files.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Scope](#Scope)\n- [SortField](#SortField)\n- [Try it!](#try-it)\n\nLists files for a user profile.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/files`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The Campaign Manager 360 user profile ID. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------|\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` The value of the nextToken from the previous result page. |\n| `scope` | `enum (`[Scope](/doubleclick-advertisers/rest/v4/files/list#Scope)`)` The scope that defines which results are returned. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/files/list#SortField)`)` The field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [FileList](/doubleclick-advertisers/rest/v4/FileList).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfareporting`\n\nScope\n-----\n\n| Enums ||\n|------------------|-----------------------|\n| `ALL` | All files in account. |\n| `MINE` | My files. |\n| `SHARED_WITH_ME` | Files shared with me. |\n\nSortField\n---------\n\n| Enums ||\n|----------------------|---------------------------------|\n| `ID` | Sort by file ID. |\n| `LAST_MODIFIED_TIME` | Sort by 'lastmodifiedAt' field. |"]]