Method: subaccounts.list

  • This method retrieves a list of subaccounts, with options for filtering and paging.

  • The HTTP request uses a GET method with a URL that includes a user profile ID as a path parameter.

  • Query parameters allow filtering by IDs, controlling the number of results, specifying a page token, searching by string, and sorting the results.

  • The request body must be empty.

  • The response body contains a list of subaccount objects, a kind field, and potentially a nextPageToken for pagination.

Gets a list of subaccounts, possibly filtered. This method supports paging.

HTTP request

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

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 subaccounts with these IDs.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
searchString

string

Allows searching for objects by name or ID. Wildcards (

*

) are allowed. For example,

"subaccount*2015"

will return objects with names like

"subaccount June 2015"

,

"subaccount April 2015"

, or simply

"subaccount 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

"subaccount"

will match objects with name

"my subaccount"

,

"subaccount 2015"

, or simply

"subaccount"

.
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

Subaccount subaccounts.list Response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "subaccounts": [
    {
      object (Subaccount)
    }
  ]
}
Fields
kind

string

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

"dfareporting#subaccountsListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
subaccounts[]

object (Subaccount)

Subaccount collection.

Authorization scopes

Requires the following OAuth scope:

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