type User (v202411)

  • The UserService is used to manage users of the system.

  • Users are assigned at most one role per network, which determines their permissions.

  • The User object inherits from UserRecord and has fields such as id, name, email, roleId, roleName, isActive, externalId, isServiceAccount, and ordersUiLocalTimeZoneId.

  • User IDs are unique and assigned by Google, while roles created by Google have negative IDs.

  • An inactive user cannot log in or perform operations, and service account users are read-only and added via the UI.
Service
UserService
Dependencies
UserPage createUsers() getCurrentUser() updateUsers()
▼
User
Inheritance
UserRecord
▼
User

Represents a user of the system.

Users may be assigned at most one Role per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field
UserRecord (inherited)

id

xsd:long

The unique ID of the User. This attribute is readonly and is assigned by Google.

name

xsd:string

The name of the User. It has a maximum length of 128 characters.

email

xsd:string

The email or login of the User. In order to create a new user, you must already have a Google Account.

roleId

xsd:long

The unique role ID of the User. Roles that are created by Google will have negative IDs.

roleName

xsd:string

The name of the role assigned to the User. This attribute is readonly.

User

isActive

xsd:boolean

Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.

externalId

xsd:string

An identifier for the User that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.

isServiceAccount

xsd:boolean

Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.

ordersUiLocalTimeZoneId

xsd:string

The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this User. Set this to null to indicate that no such value is defined for the User - UI then defaults to using the Network's timezone.

This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.