Method: reports.list
Stay organized with collections
Save and categorize content based on your preferences.
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. |
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\u003eRetrieves a list of reports within a specified Campaign Manager 360 user profile.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of reports by scope (all or mine) and sorting by ID, last modified time, or name.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large result sets using \u003ccode\u003epageToken\u003c/code\u003e for subsequent requests.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfareporting\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing report details, including kind, etag, items, and nextPageToken for further navigation.\u003c/p\u003e\n"]]],[],null,["# Method: reports.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 - [JSON representation](#body.ReportList.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Scope](#Scope)\n- [SortField](#SortField)\n- [SortOrder](#SortOrder)\n- [Try it!](#try-it)\n\nRetrieves list of reports.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/reports`\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/reports/list#Scope)`)` The scope that defines which results are returned. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/reports/list#SortField)`)` The field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/reports/list#SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRepresents the list of reports.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/doubleclick-advertisers/rest/v4/reports#Report) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The kind of list this is, in this case `dfareporting#reportList` . |\n| `etag` | `string` The eTag of this response for caching purposes. |\n| `items[]` | `object (`[Report](/doubleclick-advertisers/rest/v4/reports#Report)`)` The reports returned in this response. |\n| `next``Page``Token` | `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. |\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 reports in account. |\n| `MINE` | My reports. |\n\nSortField\n---------\n\n| Enums ||\n|----------------------|-----------------------------------|\n| `ID` | Sort by report ID. |\n| `LAST_MODIFIED_TIME` | Sort by 'lastModifiedTime' field. |\n| `NAME` | Sort by name of reports. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]
