Google Ads Ad Manager V1 Client - Class LineItemTemplate (0.15.0)

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

The LineItemTemplate resource.

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

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 LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

↳ display_name string

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

↳ default_template bool

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

↳ same_advertiser_exception_enabled bool

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

↳ line_item_display_name string

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

↳ line_item_type int

Required. The default line_item_type of a new LineItem.

↳ notes string

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

↳ delivery_rate_type int

Required. The default delivery_rate_type of a new LineItem.

↳ roadblocking_type int

Required. The default roadblocking_type of a new LineItem.

↳ creative_rotation_type int

Required. The default creative_rotation_type of a new LineItem.

getName

Identifier. The resource name of the LineItemTemplate.

Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

Returns
Type Description
string

setName

Identifier. The resource name of the LineItemTemplate.

Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDefaultTemplate

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

Returns
Type Description
bool

hasDefaultTemplate

clearDefaultTemplate

setDefaultTemplate

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSameAdvertiserExceptionEnabled

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

Returns
Type Description
bool

hasSameAdvertiserExceptionEnabled

clearSameAdvertiserExceptionEnabled

setSameAdvertiserExceptionEnabled

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLineItemDisplayName

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

Returns
Type Description
string

hasLineItemDisplayName

clearLineItemDisplayName

setLineItemDisplayName

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getLineItemType

Required. The default line_item_type of a new LineItem.

Returns
Type Description
int

hasLineItemType

clearLineItemType

setLineItemType

Required. The default line_item_type of a new LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getNotes

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

Returns
Type Description
string

hasNotes

clearNotes

setNotes

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeliveryRateType

Required. The default delivery_rate_type of a new LineItem.

Returns
Type Description
int

hasDeliveryRateType

clearDeliveryRateType

setDeliveryRateType

Required. The default delivery_rate_type of a new LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getRoadblockingType

Required. The default roadblocking_type of a new LineItem.

Returns
Type Description
int

hasRoadblockingType

clearRoadblockingType

setRoadblockingType

Required. The default roadblocking_type of a new LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreativeRotationType

Required. The default creative_rotation_type of a new LineItem.

Returns
Type Description
int

hasCreativeRotationType

clearCreativeRotationType

setCreativeRotationType

Required. The default creative_rotation_type of a new LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this