Update
|
|||||
|
|
||||
Updates an existing user role
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 14 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
accountId |
INTEGER |
Account ID of this user role. This is a read-only field that can be left blank |
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 |
id |
INTEGER |
ID of this user role. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole" |
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 |
parentUserRoleId |
INTEGER |
ID of the user role that this user role is based on or copied from. This is a required field |
permissions[] |
OBJECT |
Contains properties of a user role permission |
permissions[].availability |
ENUMERATION |
Levels of availability for a user role permission |
permissions[].id |
INTEGER |
ID of this user role permission |
permissions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission" |
permissions[].name |
STRING |
Name of this user role permission |
permissions[].permissionGroupId |
INTEGER |
ID of the permission group that this user role permission belongs to |
subaccountId |
INTEGER |
Subaccount ID of this user role. This is a read-only field that can be left blank |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
accountId INTEGER Account ID of this user role. This is a read-only field that can be left blank |
|
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 |
|
id INTEGER ID of this user role. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole" |
|
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 |
|
parentUserRoleId INTEGER ID of the user role that this user role is based on or copied from. This is a required field |
|
permissions[] OBJECT Contains properties of a user role permission |
|
permissions[].availability ENUMERATION Levels of availability for a user role permission |
|
permissions[].id INTEGER ID of this user role permission |
|
permissions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission" |
|
permissions[].name STRING Name of this user role permission |
|
permissions[].permissionGroupId INTEGER ID of the permission group that this user role permission belongs to |
|
subaccountId INTEGER Subaccount ID of this user role. This is a read-only field that can be left blank |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this user role. This is a read-only field that can be left blank |
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 |
id |
INTEGER |
ID of this user role. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole" |
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 |
parentUserRoleId |
INTEGER |
ID of the user role that this user role is based on or copied from. This is a required field |
permissions[] |
OBJECT |
Contains properties of a user role permission |
permissions[].availability |
ENUMERATION |
Levels of availability for a user role permission |
permissions[].id |
INTEGER |
ID of this user role permission |
permissions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission" |
permissions[].name |
STRING |
Name of this user role permission |
permissions[].permissionGroupId |
INTEGER |
ID of the permission group that this user role permission belongs to |
subaccountId |
INTEGER |
Subaccount ID of this user role. This is a read-only field that can be left blank |
= Parameter name
= Format
|
accountId INTEGER Account ID of this user role. This is a read-only field that can be left blank |
|
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 |
|
id INTEGER ID of this user role. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole" |
|
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 |
|
parentUserRoleId INTEGER ID of the user role that this user role is based on or copied from. This is a required field |
|
permissions[] OBJECT Contains properties of a user role permission |
|
permissions[].availability ENUMERATION Levels of availability for a user role permission |
|
permissions[].id INTEGER ID of this user role permission |
|
permissions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission" |
|
permissions[].name STRING Name of this user role permission |
|
permissions[].permissionGroupId INTEGER ID of the permission group that this user role permission belongs to |
|
subaccountId INTEGER Subaccount ID of this user role. This is a read-only field that can be left blank |