Google Ads Ad Manager V1 Client - Class Label (0.7.0)

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

A Label is additional information that can be added to an entity.

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

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 Label. Format: networks/{network_code}/labels/{label_id}

↳ display_name string

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

↳ description string

Optional. A description of the label. This attribute has a maximum length of 255 characters.

↳ active bool

Output only. Specifies whether or not the label is active.

↳ types int[]

Required. Unordered list. The types of the Label.

getName

Identifier. The resource name of the Label.

Format: networks/{network_code}/labels/{label_id}

Returns
Type Description
string

setName

Identifier. The resource name of the Label.

Format: networks/{network_code}/labels/{label_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A description of the label. This attribute has a maximum length of 255 characters.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

Optional. A description of the label. This attribute has a maximum length of 255 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getActive

Output only. Specifies whether or not the label is active.

Returns
Type Description
bool

hasActive

clearActive

setActive

Output only. Specifies whether or not the label is active.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTypes

Required. Unordered list. The types of the Label.

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setTypes

Required. Unordered list. The types of the Label.

Parameter
Name Description
var int[]
Returns
Type Description
$this