REST Resource: networks.roles
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Role
| JSON representation |
{
"name": string,
"roleId": string,
"displayName": string,
"description": string,
"builtIn": boolean,
"status": enum (RoleStatus)
} |
| Fields |
name |
string
Identifier. The resource name of the Role. Format: networks/{networkCode}/roles/{roleId}
|
roleId |
string (int64 format)
Output only. Role ID.
|
displayName |
string
Required. The display name of the Role.
|
description |
string
Optional. The description of the Role.
|
builtIn |
boolean
Output only. Whether the Role is a built-in or custom user role.
|
status |
enum (RoleStatus)
Output only. The status of the Role.
|
RoleStatus
| Enums |
ROLE_STATUS_UNSPECIFIED |
No value specified. |
ACTIVE |
Role is active. |
INACTIVE |
Role is inactive. |
Methods |
|
|
API to retrieve a Role object. |
|
|
API to retrieve a list of Role objects. |
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-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eRole\u003c/code\u003e resource represents user roles within Google Ad Manager, including details like name, ID, display name, description, and status.\u003c/p\u003e\n"],["\u003cp\u003eRoles can be either built-in or custom, and their status can be active or inactive, managed through the \u003ccode\u003eRoleStatus\u003c/code\u003e enum.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation provides details on the JSON representation of the \u003ccode\u003eRole\u003c/code\u003e resource and its associated fields.\u003c/p\u003e\n"],["\u003cp\u003eYou can use the provided API methods to retrieve individual \u003ccode\u003eRole\u003c/code\u003e objects or lists of roles.\u003c/p\u003e\n"]]],["The `Role` resource represents a user role, defined by properties like `name`, `roleId`, `displayName`, `description`, `builtIn` status, and `status`. The `RoleStatus` can be `ACTIVE`, `INACTIVE`, or `ROLE_STATUS_UNSPECIFIED`. You can retrieve a single `Role` using the `get` method or a list of `Role` objects with the `list` method. The `roleId`, `builtIn`, and `status` are output-only fields.\n"],null,["# REST Resource: networks.roles\n\n- [Resource: Role](#Role)\n - [JSON representation](#Role.SCHEMA_REPRESENTATION)\n- [RoleStatus](#RoleStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Role\n--------------\n\nThe `Role` resource.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"roleId\": string, \"displayName\": string, \"description\": string, \"builtIn\": boolean, \"status\": enum (/ad-manager/api/beta/reference/rest/v1/networks.roles#RoleStatus) } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the `Role`. Format: `networks/{networkCode}/roles/{roleId}` |\n| `roleId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. `Role` ID. |\n| `displayName` | `string` Required. The display name of the `Role`. |\n| `description` | `string` Optional. The description of the `Role`. |\n| `builtIn` | `boolean` Output only. Whether the `Role` is a built-in or custom user role. |\n| `status` | `enum (`[RoleStatus](/ad-manager/api/beta/reference/rest/v1/networks.roles#RoleStatus)`)` Output only. The status of the `Role`. |\n\nRoleStatus\n----------\n\nThe status of the role.\n\n| Enums ||\n|---------------------------|---------------------|\n| `ROLE_STATUS_UNSPECIFIED` | No value specified. |\n| `ACTIVE` | Role is active. |\n| `INACTIVE` | Role is inactive. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------|-------------------------------------------|\n| ### [get](/ad-manager/api/beta/reference/rest/v1/networks.roles/get) | API to retrieve a `Role` object. |\n| ### [list](/ad-manager/api/beta/reference/rest/v1/networks.roles/list) | API to retrieve a list of `Role` objects. |"]]
