type Role (v202508)
Stay organized with collections
Save and categorize content based on your preferences.
Each Role provides a user with permissions to perform specific operations in the system.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202508
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-13 UTC.
[null,null,["Last updated 2025-08-13 UTC."],[],[],null,["# type Role (v202508)\n\n**Service** \n**UserService** **Dependencies** \n[getAllRoles()](/ad-manager/api/reference/v202508/UserService#getAllRoles) \n▼\n**Role**\n\nEach `Role` provides a user with permissions to perform specific operations in the system.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202508`\n\n| Field ----- ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `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. |\n| ### `name` | ` `xsd:`string` The name of the role. This value is readonly and is assigned by Google. |\n| ### `description` | ` `xsd:`string` The description of the role. This value is readonly and is assigned by Google. |\n| ### `status` | ` `[RoleStatus](/ad-manager/api/reference/v202508/UserService.RoleStatus)` ` The status of the [Role](/ad-manager/api/reference/v202508/UserService.Role). This field is read-only and can have the values [RoleStatus.ACTIVE](/ad-manager/api/reference/v202508/UserService.RoleStatus#ACTIVE) (default) or [RoleStatus.INACTIVE](/ad-manager/api/reference/v202508/UserService.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. \u003cbr /\u003e |"]]
