Method: userRoles.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of user roles, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/userRoles
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 roles with the specified IDs.
|
subaccountId |
string (int64 format)
Select only user roles that belong to this subaccount.
|
accountUserRoleOnly |
boolean
Select only account level user roles not associated with any specific subaccount.
|
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,
"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 |
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
User Role userRoles.list Response
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"nextPageToken": string,
"userRoles": [
{
object (UserRole)
}
]
} |
| Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#userRolesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
userRoles[] |
object (UserRole)
User role collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of user roles, optionally filtered by ID, subaccount, or name, with support for paging.\u003c/p\u003e\n"],["\u003cp\u003eSends an HTTP GET request to the specified endpoint with profile ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows specification of various query parameters to refine the results, including filtering, sorting, and paging.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing a list of user roles and a pagination token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: userRoles.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.UserRolesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of user roles, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/userRoles`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only user roles with the specified IDs. |\n| `subaccount``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only user roles that belong to this subaccount. |\n| `account``User``Role``Only` | `boolean` Select only account level user roles not associated with any specific subaccount. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `search``String` | `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\"` . |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nUser Role userRoles.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"userRoles\": [ { object (/doubleclick-advertisers/rest/v4/userRoles#UserRole) } ] } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#userRolesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `user``Roles[]` | `object (`[UserRole](/doubleclick-advertisers/rest/v4/userRoles#UserRole)`)` User role collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]
