Share your feedback about the Display & Video 360 API. Take the 2022 Display & Video 360 API Annual Survey.

REST Resource: users

Stay organized with collections Save and categorize content based on your preferences.

Resource: User

A single user in Display & Video 360.

JSON representation
{
  "name": string,
  "userId": string,
  "email": string,
  "displayName": string,
  "assignedUserRoles": [
    {
      object (AssignedUserRole)
    }
  ]
}
Fields
name

string

Output only. The resource name of the user.

userId

string (int64 format)

Output only. The unique ID of the user. Assigned by the system.

email

string

Required. Immutable. The email address used to identify the user.

displayName

string

Required. The display name of the user.

Must be UTF-8 encoded with a maximum size of 240 bytes.

assignedUserRoles[]

object (AssignedUserRole)

The assigned user roles.

Required in users.create. Output only in users.patch. Can only be updated through users.bulkEditAssignedUserRoles.

AssignedUserRole

A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

JSON representation
{
  "assignedUserRoleId": string,
  "userRole": enum (UserRole),

  // Union field entity_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field entity_id.
}
Fields
assignedUserRoleId

string

Output only. The ID of the assigned user role.

userRole

enum (UserRole)

Required. The user role to assign to a user for the entity.

Union field entity_id. Required.

The ID of the entity that the assigned user role applies to. entity_id can be only one of the following:

partnerId

string (int64 format)

The ID of the partner that the assigned user role applies to.

advertiserId

string (int64 format)

The ID of the advertiser that the assigend user role applies to.

UserRole

Possible user roles.

Enums
USER_ROLE_UNSPECIFIED Default value when the user role is not specified or is unknown in this version.
ADMIN The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can view and edit billing information, create or modify users, and enable or disable exchanges. This role can only be assigned for a partner entity.
ADMIN_PARTNER_CLIENT The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can create and modify other ADMIN_PARTNER_CLIENT users and view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for a partner entity.
STANDARD The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create and modify users or view billing information.
STANDARD_PLANNER The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity, including all cost data. They can create and modify planning-related features, including plans and inventory.
STANDARD_PLANNER_LIMITED The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity. They can create or modify planning-related features, including plans and inventory. They have no access to cost data and cannot start, accept, or negotiate deals.
STANDARD_PARTNER_CLIENT The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create or modify other users or view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for an advertiser entity.
READ_ONLY The user can only build reports and view data for the entity.
REPORTING_ONLY The user can only create and manage reports.
LIMITED_REPORTING_ONLY The user can only create and manage the following client-safe reports: General, Audience Performance, Cross-Partner, Keyword, Order ID, Category, and Third-Party Data Provider.
CREATIVE The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace.
CREATIVE_ADMIN The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace. In addition, they can add other creative admins or creative users to the entity.

Methods

bulkEditAssignedUserRoles

Bulk edits user roles for a user.

create

Creates a new user.

delete

Deletes a user.

get

Gets a user.

list

Lists users that are accessible to the current user.

patch

Updates an existing user.