Skip to main content

user_roles

Overview

Nameuser_roles
TypeResource
Idgoogleads.dfareporting.user_roles

Fields

NameDatatypeDescription
idstringID of this user role. This is a read-only, auto-generated field.
namestringName 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.
subaccountIdstringSubaccount ID of this user role. This is a read-only field that can be left blank.
accountIdstringAccount ID of this user role. This is a read-only field that can be left blank.
defaultUserRolebooleanWhether 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.
kindstringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
parentUserRoleIdstringID of the user role that this user role is based on or copied from. This is a required field.
permissionsarrayList of permissions associated with this user role.

Methods

NameAccessible byRequired ParamsDescription
userRoles_getSELECTid, profileIdGets one user role by ID.
userRoles_listSELECTprofileIdRetrieves a list of user roles, possibly filtered. This method supports paging.
userRoles_deleteDELETEid, profileIdDeletes an existing user role.
userRoles_insertEXECprofileIdInserts a new user role.
userRoles_patchEXECid, profileIdUpdates an existing user role. This method supports patch semantics.
userRoles_updateEXECprofileIdUpdates an existing user role.