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.
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class LineItem : IMessage<LineItem>, IEquatable<LineItem>, IDeepCloneable<LineItem>, IBufferMessage, IMessage
Constructors
LineItem()
Declaration
LineItem(LineItem)
Declaration
public LineItem(LineItem other)
Parameters
Properties
AllowOverbook
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.
Declaration
public bool AllowOverbook { get; set; }
Property Value
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.
Declaration
public RepeatedField<LineItemAllowedFormatEnum.Types.LineItemAllowedFormat> AllowedFormats { get; }
Property Value
AppliedLabels
Optional. The set of labels applied directly to this line item.
Declaration
public RepeatedField<AppliedLabel> AppliedLabels { get; }
Property Value
Archived
Output only. The archival status of the LineItem.
Declaration
public bool Archived { get; set; }
Property Value
AutoExtensionDays
Optional. The number of days to allow a line item to deliver past its
[target_end_time][google.ads.admanager.v1.LineItem.target_end_time]. A
maximum of 7 days is allowed. This is feature is only available for Ad
Manager 360 accounts.
Declaration
public int AutoExtensionDays { get; set; }
Property Value
Budget
Output only. The amount of money allocated to the LineItem. This attribute
is readonly and is populated by Google. The currency code is readonly.
Declaration
public Money Budget { get; set; }
Property Value
ChildContentEligibility
Optional. Non-empty default. Child content eligibility designation for this
line item. This field defaults to DISALLOWED.
Declaration
public ChildContentEligibilityEnum.Types.ChildContentEligibility ChildContentEligibility { get; set; }
Property Value
CompanionDeliveryOption
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.
Declaration
public CompanionDeliveryOptionEnum.Types.CompanionDeliveryOption CompanionDeliveryOption { get; set; }
Property Value
CompetitiveConstraintScope
Optional. Non-empty default. The CompetitiveConstraintScope for the
competitive exclusion labels assigned to this line item. This field
defaults to POD.
Declaration
public ExclusionScopeEnum.Types.ExclusionScope CompetitiveConstraintScope { get; set; }
Property Value
ContractedUnitsBought
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.
Declaration
public long ContractedUnitsBought { get; set; }
Property Value
CostType
Required. The method used for billing this LineItem.
Declaration
public LineItemCostTypeEnum.Types.LineItemCostType CostType { get; set; }
Property Value
CreateTime
Output only. The time this line item was created.
Declaration
public Timestamp CreateTime { get; set; }
Property Value
CreativePlaceholders
Required. Details about the creatives that are expected to serve through
this LineItem.
Declaration
public RepeatedField<CreativePlaceholder> CreativePlaceholders { get; }
Property Value
CreativeRotationType
Required. The strategy used for displaying multiple Creative objects that
are associated with the LineItem.
Declaration
public CreativeRotationTypeEnum.Types.CreativeRotationType CreativeRotationType { get; set; }
Property Value
CreativeTargetings
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][google.ads.admanager.v1.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.
Declaration
public RepeatedField<CreativeTargeting> CreativeTargetings { get; }
Property Value
CustomFieldValues
Optional. The values of the custom fields associated with this line item.
Declaration
public RepeatedField<CustomFieldValue> CustomFieldValues { get; }
Property Value
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.
Declaration
public CustomPacingCurve CustomPacingCurve { get; set; }
Property Value
CustomVastExtension
Optional. Custom XML to be rendered in a custom VAST response at serving
time.
Declaration
public string CustomVastExtension { get; set; }
Property Value
DealInfo
Optional. The deal information associated with this line item, if it is
programmatic.
Declaration
public LineItemDealInfo DealInfo { get; set; }
Property Value
DeliveryForecastSource
Optional. Non-empty default. Strategy for choosing forecasted traffic
shapes to pace line items. This field defaults to HISTORICAL.
Declaration
public LineItemDeliveryForecastSourceEnum.Types.LineItemDeliveryForecastSource DeliveryForecastSource { get; set; }
Property Value
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.
Declaration
public DeliveryIndicator DeliveryIndicator { get; set; }
Property Value
DeliveryRateType
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.
Declaration
public LineItemDeliveryRateTypeEnum.Types.LineItemDeliveryRateType DeliveryRateType { get; set; }
Property Value
Discount
Optional. Discount information for the line item.
Declaration
public LineItemDiscount Discount { get; set; }
Property Value
DisplayName
Required. The name of the line item. This attribute has a maximum length of
255 characters.
Declaration
public string DisplayName { get; set; }
Property Value
EffectiveAppliedLabels
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.
Declaration
public RepeatedField<AppliedLabel> EffectiveAppliedLabels { get; }
Property Value
EndTime
Output only. The timestamp when the LineItem will stop serving. This
attribute includes auto extension days.
Declaration
public Timestamp EndTime { get; set; }
Property Value
EndTimeUnlimited
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.
Declaration
public bool EndTimeUnlimited { get; set; }
Property Value
EnvironmentType
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.
Declaration
public EnvironmentTypeEnum.Types.EnvironmentType EnvironmentType { get; set; }
Property Value
ExternalLineItemId
Optional. An identifier for the LineItem that is meaningful to the
publisher. This attribute has a maximum length of 255 characters.
Declaration
public string ExternalLineItemId { get; set; }
Property Value
FrequencyCaps
Optional. The set of frequency capping units for this LineItem.
Declaration
public RepeatedField<FrequencyCap> FrequencyCaps { get; }
Property Value
Goal
Optional. The primary goal that this LineItem is associated with, which is
used in its pacing and budgeting.
Declaration
public Goal Goal { get; set; }
Property Value
GrpSettings
Optional. Contains the information for a line item which has a target GRP
demographic.
Declaration
public GrpSettings GrpSettings { get; set; }
Property Value
HasAllowOverbook
Gets whether the "allow_overbook" field is set
Declaration
public bool HasAllowOverbook { get; }
Property Value
HasArchived
Gets whether the "archived" field is set
Declaration
public bool HasArchived { get; }
Property Value
HasAutoExtensionDays
Gets whether the "auto_extension_days" field is set
Declaration
public bool HasAutoExtensionDays { get; }
Property Value
HasChildContentEligibility
Gets whether the "child_content_eligibility" field is set
Declaration
public bool HasChildContentEligibility { get; }
Property Value
HasCompanionDeliveryOption
Gets whether the "companion_delivery_option" field is set
Declaration
public bool HasCompanionDeliveryOption { get; }
Property Value
HasCompetitiveConstraintScope
Gets whether the "competitive_constraint_scope" field is set
Declaration
public bool HasCompetitiveConstraintScope { get; }
Property Value
HasContractedUnitsBought
Gets whether the "contracted_units_bought" field is set
Declaration
public bool HasContractedUnitsBought { get; }
Property Value
HasCostType
Gets whether the "cost_type" field is set
Declaration
public bool HasCostType { get; }
Property Value
HasCreativeRotationType
Gets whether the "creative_rotation_type" field is set
Declaration
public bool HasCreativeRotationType { get; }
Property Value
HasCustomVastExtension
Gets whether the "custom_vast_extension" field is set
Declaration
public bool HasCustomVastExtension { get; }
Property Value
HasDeliveryForecastSource
Gets whether the "delivery_forecast_source" field is set
Declaration
public bool HasDeliveryForecastSource { get; }
Property Value
HasDeliveryRateType
Gets whether the "delivery_rate_type" field is set
Declaration
public bool HasDeliveryRateType { get; }
Property Value
HasDisplayName
Gets whether the "display_name" field is set
Declaration
public bool HasDisplayName { get; }
Property Value
HasEndTimeUnlimited
Gets whether the "end_time_unlimited" field is set
Declaration
public bool HasEndTimeUnlimited { get; }
Property Value
HasEnvironmentType
Gets whether the "environment_type" field is set
Declaration
public bool HasEnvironmentType { get; }
Property Value
HasExternalLineItemId
Gets whether the "external_line_item_id" field is set
Declaration
public bool HasExternalLineItemId { get; }
Property Value
HasLineItemType
Gets whether the "line_item_type" field is set
Declaration
public bool HasLineItemType { get; }
Property Value
HasMissingCreatives
Gets whether the "missing_creatives" field is set
Declaration
public bool HasMissingCreatives { get; }
Property Value
HasNotes
Gets whether the "notes" field is set
Declaration
public bool HasNotes { get; }
Property Value
HasOrder
Gets whether the "order" field is set
Declaration
public bool HasOrder { get; }
Property Value
HasOrderDisplayName
Gets whether the "order_display_name" field is set
Declaration
public bool HasOrderDisplayName { get; }
Property Value
HasPriority
Gets whether the "priority" field is set
Declaration
public bool HasPriority { get; }
Property Value
HasRepeatedCreativeServingEnabled
Gets whether the "repeated_creative_serving_enabled" field is set
Declaration
public bool HasRepeatedCreativeServingEnabled { get; }
Property Value
HasReservationStatus
Gets whether the "reservation_status" field is set
Declaration
public bool HasReservationStatus { get; }
Property Value
HasReserveOnCreation
Gets whether the "reserve_on_creation" field is set
Declaration
public bool HasReserveOnCreation { get; }
Property Value
HasRoadblockingType
Gets whether the "roadblocking_type" field is set
Declaration
public bool HasRoadblockingType { get; }
Property Value
HasSameAdvertiserExceptionEnabled
Gets whether the "same_advertiser_exception_enabled" field is set
Declaration
public bool HasSameAdvertiserExceptionEnabled { get; }
Property Value
HasSkipCrossSellingRuleWarningChecks
Gets whether the "skip_cross_selling_rule_warning_checks" field is set
Declaration
public bool HasSkipCrossSellingRuleWarningChecks { get; }
Property Value
HasSkipInventoryCheck
Gets whether the "skip_inventory_check" field is set
Declaration
public bool HasSkipInventoryCheck { get; }
Property Value
HasSkippableAdType
Gets whether the "skippable_ad_type" field is set
Declaration
public bool HasSkippableAdType { get; }
Property Value
Gets whether the "sponsorship_exclusivity_enabled" field is set
Declaration
public bool HasSponsorshipExclusivityEnabled { get; }
Property Value
HasStatus
Gets whether the "status" field is set
Declaration
public bool HasStatus { get; }
Property Value
HasUpdateSource
Gets whether the "update_source" field is set
Declaration
public bool HasUpdateSource { get; }
Property Value
HasWebPropertyCode
Gets whether the "web_property_code" field is set
Declaration
public bool HasWebPropertyCode { get; }
Property Value
HasYoutubeKidsRestricted
Gets whether the "youtube_kids_restricted" field is set
Declaration
public bool HasYoutubeKidsRestricted { get; }
Property Value
LineItemName
Declaration
public LineItemName LineItemName { get; set; }
Property Value
LineItemType
Declaration
public LineItemTypeEnum.Types.LineItemType LineItemType { get; set; }
Property Value
MaxVideoCreativeDuration
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.
Declaration
public Duration MaxVideoCreativeDuration { get; set; }
Property Value
MissingCreatives
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][google.ads.admanager.v1.CreativePlaceholder.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][google.ads.admanager.v1.CreativePlaceholder.applied_labels]
of the LineItem. For example LineItem specifies 750x350 with a Foo
AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
Declaration
public bool MissingCreatives { get; set; }
Property Value
Name
Identifier. The resource name of the LineItem.
Format: networks/{network_code}/lineItems/{line_item_id}
Declaration
public string Name { get; set; }
Property Value
Notes
Optional. Provides any additional notes that may annotate the LineItem.
This attribute has a maximum length of 65,535 characters.
Declaration
public string Notes { get; set; }
Property Value
Order
Required. Immutable. The ID of the Order to which the LineItem belongs.
Format: networks/{network_code}/orders/{order}
Declaration
public string Order { get; set; }
Property Value
OrderAsOrderName
Declaration
public OrderName OrderAsOrderName { get; set; }
Property Value
OrderDisplayName
Output only. The name of the Order.
Declaration
public string OrderDisplayName { get; set; }
Property Value
Priority
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.
Declaration
public int Priority { get; set; }
Property Value
Rate
Required. The amount of money to spend per impression or click.
Declaration
public Money Rate { get; set; }
Property Value
RepeatedCreativeServingEnabled
Optional. Indicates whether repeated creative serving is enabled for this
line item.
Declaration
public bool RepeatedCreativeServingEnabled { get; set; }
Property Value
ReservationStatus
Output only. Describes whether or not inventory has been reserved for the
LineItem.
Declaration
public LineItemReservationStatusEnum.Types.LineItemReservationStatus ReservationStatus { get; set; }
Property Value
ReserveOnCreation
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.
Declaration
public bool ReserveOnCreation { get; set; }
Property Value
RoadblockingType
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.
Declaration
public RoadblockingTypeEnum.Types.RoadblockingType RoadblockingType { get; set; }
Property Value
SameAdvertiserExceptionEnabled
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.
Declaration
public bool SameAdvertiserExceptionEnabled { get; set; }
Property Value
SecondaryGoals
Optional. The secondary goals that this LineItem is associated with. This
is required and meaningful only if the
[line_item_type][google.ads.admanager.v1.LineItem.line_item_type] is
SPONSORSHIP and [cost_type][google.ads.admanager.v1.LineItem.cost_type] is
CPM.
Declaration
public RepeatedField<Goal> SecondaryGoals { get; }
Property Value
SkipCrossSellingRuleWarningChecks
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.
Declaration
public bool SkipCrossSellingRuleWarningChecks { get; set; }
Property Value
SkipInventoryCheck
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.
Declaration
public bool SkipInventoryCheck { get; set; }
Property Value
SkippableAdType
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.
Declaration
public SkippableAdTypeEnum.Types.SkippableAdType SkippableAdType { get; set; }
Property Value
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.
Declaration
public bool SponsorshipExclusivityEnabled { get; set; }
Property Value
StartTime
Required. The date and time on which the LineItem is enabled to begin
serving. This attribute is required and must be in the future.
Declaration
public Timestamp StartTime { get; set; }
Property Value
Stats
Output only. Contains trafficking statistics for the line item. This will
be empty in case there are no statistics for a line item yet.
Declaration
public LineItemStats Stats { get; set; }
Property Value
Status
Output only. The status of the LineItem.
Declaration
public LineItemComputedStatusEnum.Types.LineItemComputedStatus Status { get; set; }
Property Value
TargetEndTime
Optional. The target end time of the line item. This attribute is required
unless
[end_time_unlimited][google.ads.admanager.v1.LineItem.end_time_unlimited]
is set to true. If specified, it must be after the
[start_time][google.ads.admanager.v1.LineItem.start_time]. This does not
include auto extension days.
Declaration
public Timestamp TargetEndTime { get; set; }
Property Value
Targeting
Required. Contains the targeting criteria for the ad campaign.
Declaration
public Targeting Targeting { get; set; }
Property Value
ThirdPartyMeasurementSettings
Optional. Third party auto-pixeling settings for cross-sell Partners.
Declaration
public ThirdPartyMeasurementSettings ThirdPartyMeasurementSettings { get; set; }
Property Value
UpdateSource
Output only. The application that last modified this line item.
Declaration
public string UpdateSource { get; set; }
Property Value
UpdateTime
Output only. The time this line item was last modified.
Declaration
public Timestamp UpdateTime { get; set; }
Property Value
ValueCpm
Optional. Non-empty default. An amount to help the adserver rank inventory.
[value_cpm][google.ads.admanager.v1.LineItem.value_cpm] artificially raises
the value of inventory over the
[rate][google.ads.admanager.v1.LineItem.rate] but avoids raising the actual
[rate][google.ads.admanager.v1.LineItem.rate]. This attribute defaults to a
Money object in the local currency with units and nanos set to 0.
Declaration
public Money ValueCpm { get; set; }
Property Value
ViewabilityProviderCompanies
Optional. Optional IDs of the Company that provide ad verification for this
line item.
Declaration
public RepeatedField<string> ViewabilityProviderCompanies { get; }
Property Value
ViewabilityProviderCompaniesAsCompanyNames
Declaration
public ResourceNameList<CompanyName> ViewabilityProviderCompaniesAsCompanyNames { get; }
Property Value
WebPropertyCode
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.
Declaration
public string WebPropertyCode { get; set; }
Property Value
YoutubeKidsRestricted
Declaration
public bool YoutubeKidsRestricted { get; set; }
Property Value