AccountUserProfiles: list

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

Request

HTTP request

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/accountUserProfiles

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
active boolean Select only active user profiles.
ids long Select only user profiles with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
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 string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)
  • "DESCENDING"
subaccountId long Select only user profiles with the specified subaccount ID.
userRoleId long Select only user profiles with the specified user role ID.

Authorization

This request requires authorization with the following scope:

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

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#accountUserProfilesListResponse",
  "nextPageToken": string,
  "accountUserProfiles": [
    accountUserProfiles Resource
  ]
}
Property name Value Description Notes
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[] list Account user profile collection.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.