Method: accounts.list

AI-generated Key Takeaways

This method retrieves a list of accounts, with optional filtering and paging support.
The HTTP request uses a GET method with a URL including the user profile ID.
You can filter accounts using query parameters like IDs, search string, active status, and control the number of results and sorting.
The request body must be empty.
The response body contains a list of accounts and a next page token for pagination.

Retrieves the list of accounts, possibly filtered. This method supports paging .

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

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`profileId`	`string ( int64 format)` User profile ID associated with this request.

profileId

string ( int64 format)

User profile ID associated with this request.

Parameters
`ids[]`	`string ( int64 format)` Select only accounts with these IDs.
`searchString`	`string` Allows searching for objects by name or ID. Wildcards ( `` ) are allowed. For example, `"account2015"` will return objects with names like `"account June 2015"` , `"account April 2015"` , or simply `"account 2015"` . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of `"account"` will match objects with name `"my account"` , `"account 2015"` , or simply `"account"` .
`active`	`boolean` Select only active accounts. Don't set this field to select both active and non-active accounts.
`maxResults`	`integer` Maximum number of results to return.
`pageToken`	`string` Value of the `nextPageToken` from the previous result page.
`sortField`	`enum ( SortField )` Field by which to sort the list.
`sortOrder`	`enum ( SortOrder )` Order of sorted results.

The request body must be empty.

Account accounts.list Response

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

JSON representation
{ "kind" : string , "nextPageToken" : string , "accounts" : [ { object ( `Account` ) } ] }

Fields

Fields
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string `"dfareporting#accountsListResponse"` .
`nextPageToken`	`string` Pagination token to be used for the next list operation.
`accounts[]`	`object ( Account )` Account collection.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#accountsListResponse"

nextPageToken

string

Pagination token to be used for the next list operation.

accounts[]

object ( Account )

Account collection.

Requires the following OAuth scope: