Looking for a REST API? The Ad Manager API (Beta) is now available.

type Role (v202502)

Page Summary

A Role in the UserService provides a user with specific system operation permissions.
Each Role has a unique, readonly ID assigned by Google, which is negative for Google-created roles.
The Role also has a readonly name and description assigned by Google.
The status field indicates if a Role is ACTIVE (visible in UI) or INACTIVE (hidden in UI).

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/v202502

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.

type Role (v202502) Stay organized with collections Save and categorize content based on your preferences.