type Team (v202505)

  • A Team defines a grouping of users and what entities they have access to.

  • Teams are created by TeamService and can be updated using the updateTeams() function.

  • The Team object has fields for id, name, description, status, hasAllCompanies, hasAllInventory, and teamAccessType.

  • Users are added to teams with UserTeamAssociation objects.

  • The Team status can be either ACTIVE or INACTIVE, determining its visibility in the UI.
Service
TeamService
Dependencies
TeamPage createTeams() updateTeams()
▼
Team

A Team defines a grouping of users and what entities they have access to. Users are added to teams with UserTeamAssociation objects.

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

Field

id

xsd:long

The unique ID of the Team. This value is readonly and is assigned by Google. Teams that are created by Google will have negative IDs.

name

xsd:string

The name of the Team. This value is required to create a team and has a maximum length of 106 characters.

description

xsd:string

The description of the Team. This value is optional and has a maximum length of 255 characters.

status

TeamStatus

The status of the Team. This value can be TeamStatus.ACTIVE (default) or TeamStatus.INACTIVE and determines the visibility of the team in the UI.

Enumerations
ACTIVE
The status of an active team. (i.e. visible in the UI)
INACTIVE
The status of an inactive team. (i.e. hidden in the UI)
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

hasAllCompanies

xsd:boolean

Whether or not users on this team have access to all companies. If this value is true, then an error will be thrown if an attempt is made to associate this team with a Company.

hasAllInventory

xsd:boolean

Whether or not users on this team have access to all inventory. If this value is true, then an error will be thrown if an attempt is made to associate this team with an AdUnit.

teamAccessType

TeamAccessType

The default access to orders, for users on this team.

Enumerations
NONE
The level of access in which team members cannot view or edit a team's orders.
READ_ONLY
The level of access in which team members can only view a team's orders.
READ_WRITE
The level of access in which team members can view and edit a team's orders.