GOgoogle
userRoles

PATCH /userprofiles/{userprofilesId}/userRoles

Updates an existing user role. This method supports patch semantics.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

idstring int64 required

Required. UserRole ID.

Request body

accountIdstring int64

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

defaultUserRoleboolean

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.

idstring int64

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

kindstring

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

namestring

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.

parentUserRoleIdstring int64

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

subaccountIdstring int64

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

Response

Successful response

accountIdstring int64

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

defaultUserRoleboolean

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.

idstring int64

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

kindstring

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

namestring

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.

parentUserRoleIdstring int64

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

subaccountIdstring int64

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

Changes

No recorded changes to this operation across all 5 revisions of this API.