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

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

A LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

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

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 `LineItem`. Format: `networks/{network_code}/lineItems/{line_item_id}`
`↳ order`	`string` Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: `networks/{network_code}/orders/{order}`
`↳ display_name`	`string` Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.
`↳ start_time`	`Google\Protobuf\Timestamp` Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.
`↳ end_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.
`↳ line_item_type`	`int` Required. Indicates the line item type of a LineItem. This attribute is required. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.
`↳ rate`	`Google\Type\Money` Required. The amount of money to spend per impression or click.
`↳ budget`	`Google\Type\Money` Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
`↳ custom_field_values`	`array<CustomFieldValue>` Optional. The values of the custom fields associated with this line item.
`↳ goal`	`Goal` Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

getName

Identifier. The resource name of the LineItem.

Format: networks/{network_code}/lineItems/{line_item_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the LineItem.

Format: networks/{network_code}/lineItems/{line_item_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrder

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{network_code}/orders/{order}

Returns
Type	Description
`string`

hasOrder

clearOrder

setOrder

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{network_code}/orders/{order}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLineItemType

Required. Indicates the line item type of a LineItem. This attribute is required. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.

Returns
Type	Description
`int`

hasLineItemType

clearLineItemType

setLineItemType

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRate

Required. The amount of money to spend per impression or click.

Returns
Type	Description
`Google\Type\Money\|null`

hasRate

clearRate

setRate