type Role (v202411)

  • A Role defines user permissions for specific operations within the system and is identified by a unique ID assigned by Google.

  • Each Role has a name, description, and status, all of which are read-only and assigned by Google.

  • The status field, with possible values of ACTIVE or INACTIVE, determines the role's visibility in the user interface.

  • Roles created by Google are assigned negative IDs.
Service
UserService
Dependencies
getAllRoles()
▼
Role

Each Role provides a user with permissions to perform specific operations in the system.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

id

xsd:long

The unique ID of the role. This value is readonly and is assigned by Google. Roles that are created by Google will have negative IDs.

name

xsd:string

The name of the role. This value is readonly and is assigned by Google.

description

xsd:string

The description of the role. This value is readonly and is assigned by Google.

status

RoleStatus

The status of the Role. This field is read-only and can have the values RoleStatus.ACTIVE (default) or RoleStatus.INACTIVE, which determines the visibility of the role in the UI.

Enumerations
ACTIVE
The status of an active role. (i.e. visible in the UI)
INACTIVE
The status of an inactive role. (i.e. hidden in the UI)
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.