List

Retrieves a list of user roles, possibly filtered

9 variables
16 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 9 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

accountUserRoleOnly BOOLEAN

Select only account level user roles not associated with any specific subaccount

ids INTEGER

Select only user roles with the specified 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, "userrole2015" 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 ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

subaccountId INTEGER

Select only user roles that belong to this subaccount

Output

This building block provides 16 output parameters

  = Parameter name
  = Format

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

Contains properties of auser role, which is used to manage user access

userRoles[].accountId INTEGER

Account ID of this user role. This is a read-only field that can be left blank

userRoles[].defaultUserRole BOOLEAN

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions

userRoles[].id INTEGER

ID of this user role. This is a read-only, auto-generated field

userRoles[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole"

userRoles[].name STRING

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account

userRoles[].parentUserRoleId INTEGER

ID of the user role that this user role is based on or copied from. This is a required field

userRoles[].permissions[] OBJECT

Contains properties of a user role permission

userRoles[].permissions[].availability ENUMERATION

Levels of availability for a user role permission

userRoles[].permissions[].id INTEGER

ID of this user role permission

userRoles[].permissions[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission"

userRoles[].permissions[].name STRING

Name of this user role permission

userRoles[].permissions[].permissionGroupId INTEGER

ID of the permission group that this user role permission belongs to

userRoles[].subaccountId INTEGER

Subaccount ID of this user role. This is a read-only field that can be left blank