Google Ads Ad Manager V1 Client - Class Team (0.6.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Team.

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

Generated from protobuf message google.ads.admanager.v1.Team

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the Team . Format: networks/{network_code}/teams/{team_id}

↳ display_name
string

Required. The name of the Team. This value has a maximum length of 127 characters.

↳ description
string

Optional. The description of the Team. This value has a maximum length of 255 characters.

↳ status
int

Output only. The status of the Team. This value determines the visibility of the team in the UI.

↳ all_companies_access
bool

Optional. 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.

↳ all_inventory_access
bool

Optional. 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.

↳ access_type
int

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

getName

Identifier. The resource name of the Team .

Format: networks/{network_code}/teams/{team_id}

Returns
Type
Description
string

setName

Identifier. The resource name of the Team .

Format: networks/{network_code}/teams/{team_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Required. The name of the Team. This value has a maximum length of 127 characters.

Returns
Type
Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. The name of the Team. This value has a maximum length of 127 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. The description of the Team. This value has a maximum length of 255 characters.

Returns
Type
Description
string

hasDescription

clearDescription

setDescription

Optional. The description of the Team. This value has a maximum length of 255 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStatus

Output only. The status of the Team. This value determines the visibility of the team in the UI.

Returns
Type
Description
int

hasStatus

clearStatus

setStatus

Output only. The status of the Team. This value determines the visibility of the team in the UI.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getAllCompaniesAccess

Optional. 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.

Returns
Type
Description
bool

hasAllCompaniesAccess

clearAllCompaniesAccess

setAllCompaniesAccess

Optional. 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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAllInventoryAccess

Optional. 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.

Returns
Type
Description
bool

hasAllInventoryAccess

clearAllInventoryAccess

setAllInventoryAccess

Optional. 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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAccessType

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

Returns
Type
Description
int

hasAccessType

clearAccessType

setAccessType

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: