Method: accounts.list

  • The accounts.list method retrieves a list of accounts, supporting paging for large results.

  • The HTTP request uses a GET method with a path parameter for the user profile ID.

  • Various query parameters are available to filter, search, and sort the accounts list.

  • The request body must be empty, and the response body contains the list of accounts, pagination information, and identifies the resource type.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

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,

"account*2015"

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.

Request body

The request body must be empty.

Response body

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
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.

Authorization scopes

Requires the following OAuth scope:

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