REST Resource: networks.roles

  • The Role resource represents user roles within Google Ad Manager, including details like name, ID, display name, description, and status.

  • Roles can be either built-in or custom, and their status can be active or inactive, managed through the RoleStatus enum.

  • This documentation provides details on the JSON representation of the Role resource and its associated fields.

  • You can use the provided API methods to retrieve individual Role objects or lists of roles.

Resource: Role

The Role resource.

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

The status of the role.

Enums
ROLE_STATUS_UNSPECIFIED No value specified.
ACTIVE Role is active.
INACTIVE Role is inactive.

Methods

get

 API to retrieve a Role object.

list

 API to retrieve a list of Role objects.