Method: accountUserProfiles.list

  • This method retrieves a list of account user profiles, which can be filtered using various parameters.

  • The request uses a GET HTTP method and requires a profileId path parameter.

  • Optional query parameters are available to filter results by IDs, user role ID, subaccount ID, active status, and for pagination and sorting.

  • The request body must be empty.

  • The response body contains a list of account user profiles, a kind identifier, and a nextPageToken for pagination.

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

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

HTTP request

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

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 user profiles with these IDs.
userRoleId

string (int64 format)

Select only user profiles with the specified user role ID.
subaccountId

string (int64 format)

Select only user profiles with the specified subaccount ID.
active

boolean

Select only active user profiles.
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, ID or email. Wildcards (

*

) are allowed. For example,

"user profile*2015"

will return objects with names like

"user profile June 2015"

,

"user profile April 2015"

, or simply

"user profile 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

"user profile"

will match objects with name

"my user profile"

,

"user profile 2015"

, or simply

"user profile"

.
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 User Profile accountUserProfiles.list Response

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

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

string

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

"dfareporting#accountUserProfilesListResponse"

.
nextPageToken

string

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

object (AccountUserProfile)

Account user profile collection.

Authorization scopes

Requires the following OAuth scope:

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