Requires authorization
Retrieves a list of user roles, possibly filtered. This method supports paging. Try it now.
Request
HTTP request
GET https://www.googleapis.com/dfareporting/v3.1/userprofiles/profileId/userRoles
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
profileId |
long |
User profile ID associated with this request. |
Optional query parameters | ||
accountUserRoleOnly |
boolean |
Select only account level user roles not associated with any specific subaccount. |
ids |
long |
Select only user roles with the specified 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 or ID. Wildcards (* ) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015" , "userrole April 2015" , or simply "userrole 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 "userrole" will match objects with name "my userrole" , "userrole 2015" , or simply "userrole" .
|
sortField |
string |
Field by which to sort the list.
Acceptable values are:
|
sortOrder |
string |
Order of sorted results.
Acceptable values are:
|
subaccountId |
long |
Select only user roles that belong to this subaccount. |
Authorization
This request requires authorization with the following scope (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/dfatrafficking |
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#userRolesListResponse", "nextPageToken": string, "userRoles": [ userRoles Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse" . |
|
userRoles[] |
list |
User role collection. | |
nextPageToken |
string |
Pagination token to be used for the next list operation. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.