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 \ V1Methods
__construct
Constructor.
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
↳ 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
↳ 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}
string
setName
Identifier. The resource name of the LineItem
.
Format: networks/{network_code}/lineItems/{line_item_id}
var
string
$this
getOrder
Output only. The ID of the Order to which the LineItem belongs. This
attribute is required. Format: networks/{network_code}/orders/{order}
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}
var
string
$this
getDisplayName
Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.
string
hasDisplayName
clearDisplayName
setDisplayName
Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.
var
string
$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.
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.
$this
getEndTime
Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.
hasEndTime
clearEndTime
setEndTime
Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.
$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 .
int
hasLineItemType
clearLineItemType
setLineItemType
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 .
var
int
$this
getRate
Required. The amount of money to spend per impression or click.
hasRate
clearRate
setRate
Required. The amount of money to spend per impression or click.
$this
getBudget
Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
hasBudget
clearBudget
setBudget
Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
$this
getCustomFieldValues
Optional. The values of the custom fields associated with this line item.
setCustomFieldValues
Optional. The values of the custom fields associated with this line item.
$this
getGoal
Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
hasGoal
clearGoal
setGoal
Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
$this
