type Team (v202508)
Stay organized with collections
Save and categorize content based on your preferences.
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/v202508
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.
|
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-13 UTC.
[null,null,["Last updated 2025-08-13 UTC."],[],[],null,["# type Team (v202508)\n\n**Service** \n**TeamService** **Dependencies** \n[TeamPage](/ad-manager/api/reference/v202508/TeamService.TeamPage) [createTeams()](/ad-manager/api/reference/v202508/TeamService#createTeams) [updateTeams()](/ad-manager/api/reference/v202508/TeamService#updateTeams) \n▼\n**Team**\n\nA `Team` defines a grouping of users and what entities they have access to. Users are added\nto teams with [UserTeamAssociation](/ad-manager/api/reference/v202508/UserTeamAssociationService.UserTeamAssociation) objects.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202508`\n\n| Field ----- ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `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. |\n| ### `name` | ` `xsd:`string` The name of the `Team`. This value is required to create a team and has a maximum length of 106 characters. |\n| ### `description` | ` `xsd:`string` The description of the `Team`. This value is optional and has a maximum length of 255 characters. |\n| ### `status` | ` `[TeamStatus](/ad-manager/api/reference/v202508/TeamService.TeamStatus)` ` The status of the [Team](/ad-manager/api/reference/v202508/TeamService.Team). This value can be [TeamStatus.ACTIVE](/ad-manager/api/reference/v202508/TeamService.TeamStatus#ACTIVE) (default) or [TeamStatus.INACTIVE](/ad-manager/api/reference/v202508/TeamService.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. \u003cbr /\u003e |\n| ### `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. |\n| ### `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. |\n| ### `teamAccessType` | ` `[TeamAccessType](/ad-manager/api/reference/v202508/TeamService.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. \u003cbr /\u003e |"]]
