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

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

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}
↳ display_name string

Required. The name of the line item. This attribute has a maximum length of 255 characters.
↳ external_line_item_id string

Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
↳ order_display_name string

Output only. The name of the Order.
↳ 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.
↳ target_end_time Google\Protobuf\Timestamp

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.
↳ end_time Google\Protobuf\Timestamp

Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.
↳ auto_extension_days int

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
↳ end_time_unlimited bool

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.
↳ creative_rotation_type int

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.
↳ delivery_rate_type int

Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.
↳ delivery_forecast_source int

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.
↳ custom_pacing_curve CustomPacingCurve

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.
↳ roadblocking_type int

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.
↳ skippable_ad_type int

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.
↳ frequency_caps array<FrequencyCap>

Optional. The set of frequency capping units for this LineItem.
↳ line_item_type int

Required. Indicates the line item type of a LineItem. 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.
↳ priority int

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type: - LineItemType: default priority (minimum priority, maximum priority) - SPONSORSHIP: 4 (2, 5) - STANDARD: 8 (6, 10) - NETWORK: 12 (11, 14) - BULK: 12 (11, 14) - PRICE_PRIORITY: 12 (11, 14) - HOUSE: 16 (15, 16) - CLICK_TRACKING: 16 (1, 16) - AD_EXCHANGE: 12 (1, 16) - ADSENSE: 12 (1, 16) - BUMPER: 16 (15, 16) - ADMOB: 21 (1, 16) - PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
↳ rate Google\Type\Money

Required. The amount of money to spend per impression or click.
↳ value_cpm Google\Type\Money

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.
↳ cost_type int

Required. The method used for billing this LineItem.
↳ discount LineItemDiscount

Optional. Discount information for the line item.
↳ contracted_units_bought int|string

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.
↳ creative_placeholders array<CreativePlaceholder>

Required. Details about the creatives that are expected to serve through this LineItem.
↳ environment_type int

Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
↳ companion_delivery_option int

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met: - The "Guaranteed roadblocks" feature is enabled on your network. - One of the following is true (both cannot be true, these are mutually exclusive). - The environmentType is VIDEO_PLAYER. - The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
↳ allow_overbook bool

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
↳ skip_inventory_check bool

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
↳ skip_cross_selling_rule_warning_checks bool

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
↳ reserve_on_creation bool

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.
↳ stats LineItemStats

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.
↳ delivery_indicator DeliveryIndicator

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons: - The line item is not delivering. - The line item has an unlimited goal or cap. - The line item has a percentage based goal or cap.
↳ 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.
↳ status int

Output only. The status of the LineItem.
↳ reservation_status int

Output only. Describes whether or not inventory has been reserved for the LineItem.
↳ archived bool

Output only. The archival status of the LineItem.
↳ web_property_code string

Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.
↳ applied_labels array<AppliedLabel>

Optional. The set of labels applied directly to this line item.
↳ effective_applied_labels array<AppliedLabel>

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
↳ same_advertiser_exception_enabled bool

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
↳ update_source string

Output only. The application that last modified this line item.
↳ notes string

Optional. Provides any additional notes that may annotate the LineItem. This attribute has a maximum length of 65,535 characters.
↳ competitive_constraint_scope int

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.
↳ update_time Google\Protobuf\Timestamp

Output only. The time this line item was last modified.
↳ create_time Google\Protobuf\Timestamp

Output only. The time this line item was created.
↳ custom_field_values array<CustomFieldValue>

Optional. The values of the custom fields associated with this line item.
↳ missing_creatives bool

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including: - Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded. - The Creative.applied_labels of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
↳ third_party_measurement_settings ThirdPartyMeasurementSettings

Optional. Third party auto-pixeling settings for cross-sell Partners.
↳ youtube_kids_restricted bool

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.
↳ max_video_creative_duration Google\Protobuf\Duration

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.
↳ goal Goal

Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
↳ secondary_goals array<Goal>

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
↳ grp_settings GrpSettings

Optional. Contains the information for a line item which has a target GRP demographic.
↳ deal_info LineItemDealInfo

Optional. The deal information associated with this line item, if it is programmatic.
↳ viewability_provider_companies string[]

Optional. Optional IDs of the Company that provide ad verification for this line item.
↳ child_content_eligibility int

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.
↳ custom_vast_extension string

Optional. Custom XML to be rendered in a custom VAST response at serving time.
↳ sponsorship_exclusivity_enabled bool

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.
↳ repeated_creative_serving_enabled bool

Optional. Indicates whether repeated creative serving is enabled for this line item.
↳ targeting Targeting

Required. Contains the targeting criteria for the ad campaign.
↳ creative_targetings array<CreativeTargeting>

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the CreativeTargeting.display_name field. It also needs to be re-specified in the LineItemCreativeAssociation.targeting_display_name field when associating a line item with a creative that fits into that placeholder.
↳ allowed_formats int[]

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

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

Required. Immutable. The ID of the Order to which the LineItem belongs.

Format: networks/{network_code}/orders/{order}

Returns
Type Description
string

hasOrder

clearOrder

setOrder

Required. Immutable. The ID of the Order to which the LineItem belongs.

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 has a maximum length of 255 characters.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getExternalLineItemId

Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

Returns
Type Description
string

hasExternalLineItemId

clearExternalLineItemId

setExternalLineItemId

Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderDisplayName

Output only. The name of the Order.

Returns
Type Description
string

hasOrderDisplayName

clearOrderDisplayName

setOrderDisplayName

Output only. The name of the Order.

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

getTargetEndTime

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasTargetEndTime

clearTargetEndTime

setTargetEndTime

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. The timestamp when the LineItem will stop serving. This attribute 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 includes auto extension days.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAutoExtensionDays

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

Returns
Type Description
int

hasAutoExtensionDays

clearAutoExtensionDays

setAutoExtensionDays

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

Parameter
Name Description
var int
Returns
Type Description
$this

getEndTimeUnlimited

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

Returns
Type Description
bool

hasEndTimeUnlimited

clearEndTimeUnlimited

setEndTimeUnlimited

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreativeRotationType

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

Returns
Type Description
int

hasCreativeRotationType

clearCreativeRotationType

setCreativeRotationType

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getDeliveryRateType

Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.

Returns
Type Description
int

hasDeliveryRateType

clearDeliveryRateType

setDeliveryRateType

Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.

Parameter
Name Description
var int
Returns
Type Description
$this

getDeliveryForecastSource

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

Returns
Type Description
int

hasDeliveryForecastSource

clearDeliveryForecastSource

setDeliveryForecastSource

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomPacingCurve

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

Returns
Type Description
CustomPacingCurve|null

hasCustomPacingCurve

clearCustomPacingCurve

setCustomPacingCurve

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

Parameter
Name Description
var CustomPacingCurve
Returns
Type Description
$this

getRoadblockingType

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

Returns
Type Description
int

hasRoadblockingType

clearRoadblockingType

setRoadblockingType

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

Parameter
Name Description
var int
Returns
Type Description
$this

getSkippableAdType

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

Returns
Type Description
int

hasSkippableAdType

clearSkippableAdType

setSkippableAdType

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

Parameter
Name Description
var int
Returns
Type Description
$this

getFrequencyCaps

Optional. The set of frequency capping units for this LineItem.

Returns
Type Description
Google\Protobuf\RepeatedField<FrequencyCap>

setFrequencyCaps

Optional. The set of frequency capping units for this LineItem.

Parameter
Name Description
var array<FrequencyCap>
Returns
Type Description
$this

getLineItemType

Required. Indicates the line item type of a LineItem. 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

Required. Indicates the line item type of a LineItem. 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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPriority

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • LineItemType: default priority (minimum priority, maximum priority)
  • SPONSORSHIP: 4 (2, 5)
  • STANDARD: 8 (6, 10)
  • NETWORK: 12 (11, 14)
  • BULK: 12 (11, 14)
  • PRICE_PRIORITY: 12 (11, 14)
  • HOUSE: 16 (15, 16)
  • CLICK_TRACKING: 16 (1, 16)
  • AD_EXCHANGE: 12 (1, 16)
  • ADSENSE: 12 (1, 16)
  • BUMPER: 16 (15, 16)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
Returns
Type Description
int

hasPriority

clearPriority

setPriority

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • LineItemType: default priority (minimum priority, maximum priority)
  • SPONSORSHIP: 4 (2, 5)
  • STANDARD: 8 (6, 10)
  • NETWORK: 12 (11, 14)
  • BULK: 12 (11, 14)
  • PRICE_PRIORITY: 12 (11, 14)
  • HOUSE: 16 (15, 16)
  • CLICK_TRACKING: 16 (1, 16)
  • AD_EXCHANGE: 12 (1, 16)
  • ADSENSE: 12 (1, 16)
  • BUMPER: 16 (15, 16)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
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

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

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getValueCpm

Optional. Non-empty default. An amount to help the adserver rank inventory.

value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

Returns
Type Description
Google\Type\Money|null

hasValueCpm

clearValueCpm

setValueCpm

Optional. Non-empty default. An amount to help the adserver rank inventory.

value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getCostType

Required. The method used for billing this LineItem.

Returns
Type Description
int

hasCostType

clearCostType

setCostType

Required. The method used for billing this LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getDiscount

Optional. Discount information for the line item.

Returns
Type Description
LineItemDiscount|null

hasDiscount

clearDiscount

setDiscount

Optional. Discount information for the line item.

Parameter
Name Description
var LineItemDiscount
Returns
Type Description
$this

getContractedUnitsBought

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

Returns
Type Description
int|string

hasContractedUnitsBought

clearContractedUnitsBought

setContractedUnitsBought

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getCreativePlaceholders

Required. Details about the creatives that are expected to serve through this LineItem.

Returns
Type Description
Google\Protobuf\RepeatedField<CreativePlaceholder>

setCreativePlaceholders

Required. Details about the creatives that are expected to serve through this LineItem.

Parameter
Name Description
var array<CreativePlaceholder>
Returns
Type Description
$this

getEnvironmentType

Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.

Returns
Type Description
int

hasEnvironmentType

clearEnvironmentType

setEnvironmentType

Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.

Parameter
Name Description
var int
Returns
Type Description
$this

getCompanionDeliveryOption

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
    • The environmentType is VIDEO_PLAYER.
    • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
Returns
Type Description
int

hasCompanionDeliveryOption

clearCompanionDeliveryOption

setCompanionDeliveryOption

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
    • The environmentType is VIDEO_PLAYER.
    • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
Parameter
Name Description
var int
Returns
Type Description
$this

getAllowOverbook

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

Returns
Type Description
bool

hasAllowOverbook

clearAllowOverbook

setAllowOverbook

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSkipInventoryCheck

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false.

Note: this field won't persist on the line item itself, and the value will only affect the current request.

Returns
Type Description
bool

hasSkipInventoryCheck

clearSkipInventoryCheck

setSkipInventoryCheck

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false.

Note: this field won't persist on the line item itself, and the value will only affect the current request.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSkipCrossSellingRuleWarningChecks

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

Returns
Type Description
bool

hasSkipCrossSellingRuleWarningChecks

clearSkipCrossSellingRuleWarningChecks

setSkipCrossSellingRuleWarningChecks

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

Parameter
Name Description
var bool
Returns
Type Description
$this

getReserveOnCreation

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

Returns
Type Description
bool

hasReserveOnCreation

clearReserveOnCreation

setReserveOnCreation

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStats

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

Returns
Type Description
LineItemStats|null

hasStats

clearStats

setStats

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

Parameter
Name Description
var LineItemStats
Returns
Type Description
$this

getDeliveryIndicator

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
    • The line item has a percentage based goal or cap.
Returns
Type Description
DeliveryIndicator|null

hasDeliveryIndicator

clearDeliveryIndicator

setDeliveryIndicator

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
    • The line item has a percentage based goal or cap.
Parameter
Name Description
var DeliveryIndicator
Returns
Type Description
$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.

Returns
Type Description
Google\Type\Money|null

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.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getStatus

Output only. The status of the LineItem.

Returns
Type Description
int

hasStatus

clearStatus

setStatus

Output only. The status of the LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getReservationStatus

Output only. Describes whether or not inventory has been reserved for the LineItem.

Returns
Type Description
int

hasReservationStatus

clearReservationStatus

setReservationStatus

Output only. Describes whether or not inventory has been reserved for the LineItem.

Parameter
Name Description
var int
Returns
Type Description
$this

getArchived

Output only. The archival status of the LineItem.

Returns
Type Description
bool

hasArchived

clearArchived

setArchived

Output only. The archival status of the LineItem.

Parameter
Name Description
var bool
Returns
Type Description
$this

getWebPropertyCode

Optional. The web property code used for dynamic allocation line items.

This web property is only required with line item types AD_EXCHANGE and ADSENSE.

Returns
Type Description
string

hasWebPropertyCode

clearWebPropertyCode

setWebPropertyCode

Optional. The web property code used for dynamic allocation line items.

This web property is only required with line item types AD_EXCHANGE and ADSENSE.

Parameter
Name Description
var string
Returns
Type Description
$this

getAppliedLabels

Optional. The set of labels applied directly to this line item.

Returns
Type Description
Google\Protobuf\RepeatedField<AppliedLabel>

setAppliedLabels

Optional. The set of labels applied directly to this line item.

Parameter
Name Description
var array<AppliedLabel>
Returns
Type Description
$this

getEffectiveAppliedLabels

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

Returns
Type Description
Google\Protobuf\RepeatedField<AppliedLabel>

setEffectiveAppliedLabels

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

Parameter
Name Description
var array<AppliedLabel>
Returns
Type Description
$this

getSameAdvertiserExceptionEnabled

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser.

Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

Returns
Type Description
bool

hasSameAdvertiserExceptionEnabled

clearSameAdvertiserExceptionEnabled

setSameAdvertiserExceptionEnabled

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser.

Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUpdateSource

Output only. The application that last modified this line item.

Returns
Type Description
string

hasUpdateSource

clearUpdateSource

setUpdateSource

Output only. The application that last modified this line item.

Parameter
Name Description
var string
Returns
Type Description
$this

getNotes

Optional. Provides any additional notes that may annotate the LineItem.

This attribute has a maximum length of 65,535 characters.

Returns
Type Description
string

hasNotes

clearNotes

setNotes

Optional. Provides any additional notes that may annotate the LineItem.

This attribute has a maximum length of 65,535 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getCompetitiveConstraintScope

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

Returns
Type Description
int

hasCompetitiveConstraintScope

clearCompetitiveConstraintScope

setCompetitiveConstraintScope

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

Parameter
Name Description
var int
Returns
Type Description
$this

getUpdateTime

Output only. The time this line item was last modified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time this line item was last modified.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreateTime

Output only. The time this line item was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time this line item was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCustomFieldValues

Optional. The values of the custom fields associated with this line item.

Returns
Type Description
Google\Protobuf\RepeatedField<CustomFieldValue>

setCustomFieldValues

Optional. The values of the custom fields associated with this line item.

Parameter
Name Description
var array<CustomFieldValue>
Returns
Type Description
$this

getMissingCreatives

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.

  • The Creative.applied_labels of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
Returns
Type Description
bool

hasMissingCreatives

clearMissingCreatives

setMissingCreatives

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.

  • The Creative.applied_labels of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
Parameter
Name Description
var bool
Returns
Type Description
$this

getThirdPartyMeasurementSettings

Optional. Third party auto-pixeling settings for cross-sell Partners.

Returns
Type Description
ThirdPartyMeasurementSettings|null

hasThirdPartyMeasurementSettings

clearThirdPartyMeasurementSettings

setThirdPartyMeasurementSettings

Optional. Third party auto-pixeling settings for cross-sell Partners.

Parameter
Name Description
var ThirdPartyMeasurementSettings
Returns
Type Description
$this

getYoutubeKidsRestricted

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved.

See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

Returns
Type Description
bool

hasYoutubeKidsRestricted

clearYoutubeKidsRestricted

setYoutubeKidsRestricted

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved.

See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMaxVideoCreativeDuration

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxVideoCreativeDuration

clearMaxVideoCreativeDuration

setMaxVideoCreativeDuration

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getGoal

Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

Returns
Type Description
Goal|null

hasGoal

clearGoal

setGoal

Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

Parameter
Name Description
var Goal
Returns
Type Description
$this

getSecondaryGoals

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

Returns
Type Description
Google\Protobuf\RepeatedField<Goal>

setSecondaryGoals

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

Parameter
Name Description
var array<Goal>
Returns
Type Description
$this

getGrpSettings

Optional. Contains the information for a line item which has a target GRP demographic.

Returns
Type Description
GrpSettings|null

hasGrpSettings

clearGrpSettings

setGrpSettings

Optional. Contains the information for a line item which has a target GRP demographic.

Parameter
Name Description
var GrpSettings
Returns
Type Description
$this

getDealInfo

Optional. The deal information associated with this line item, if it is programmatic.

Returns
Type Description
LineItemDealInfo|null

hasDealInfo

clearDealInfo

setDealInfo

Optional. The deal information associated with this line item, if it is programmatic.

Parameter
Name Description
var LineItemDealInfo
Returns
Type Description
$this

getViewabilityProviderCompanies

Optional. Optional IDs of the Company that provide ad verification for this line item.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setViewabilityProviderCompanies

Optional. Optional IDs of the Company that provide ad verification for this line item.

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

getChildContentEligibility

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

Returns
Type Description
int

hasChildContentEligibility

clearChildContentEligibility

setChildContentEligibility

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomVastExtension

Optional. Custom XML to be rendered in a custom VAST response at serving time.

Returns
Type Description
string

hasCustomVastExtension

clearCustomVastExtension

setCustomVastExtension

Optional. Custom XML to be rendered in a custom VAST response at serving time.

Parameter
Name Description
var string
Returns
Type Description
$this

getSponsorshipExclusivityEnabled

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

Returns
Type Description
bool

hasSponsorshipExclusivityEnabled

clearSponsorshipExclusivityEnabled

setSponsorshipExclusivityEnabled

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRepeatedCreativeServingEnabled

Optional. Indicates whether repeated creative serving is enabled for this line item.

Returns
Type Description
bool

hasRepeatedCreativeServingEnabled

clearRepeatedCreativeServingEnabled

setRepeatedCreativeServingEnabled

Optional. Indicates whether repeated creative serving is enabled for this line item.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTargeting

Required. Contains the targeting criteria for the ad campaign.

Returns
Type Description
Targeting|null

hasTargeting

clearTargeting

setTargeting

Required. Contains the targeting criteria for the ad campaign.

Parameter
Name Description
var Targeting
Returns
Type Description
$this

getCreativeTargetings

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the CreativeTargeting.display_name field. It also needs to be re-specified in the LineItemCreativeAssociation.targeting_display_name field when associating a line item with a creative that fits into that placeholder.

Returns
Type Description
Google\Protobuf\RepeatedField<CreativeTargeting>

setCreativeTargetings

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the CreativeTargeting.display_name field. It also needs to be re-specified in the LineItemCreativeAssociation.targeting_display_name field when associating a line item with a creative that fits into that placeholder.

Parameter
Name Description
var array<CreativeTargeting>
Returns
Type Description
$this

getAllowedFormats

Optional. The set of allowed formats for this line item.

If empty, all formats are allowed. This property only applies to programmatic video line items.

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setAllowedFormats

Optional. The set of allowed formats for this line item.

If empty, all formats are allowed. This property only applies to programmatic video line items.

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