Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202111.LineItem Class Reference

LineItem is an advertiser's commitment to purchase a specific number of ad impressions, clicks, or time. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202111.LineItem:
Google.Api.Ads.AdManager.v202111.LineItemSummary

Properties

Targeting targeting [get, set]
 Contains the targeting criteria for the ad campaign. This attribute is required. More...
 
CreativeTargeting[] creativeTargetings [get, set]
 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 creative placeholder's CreativePlaceholder::targetingName field by referencing the creative targeting's CreativeTargeting::name name. It also needs to be re-specified in the LineItemCreativeAssociation::targetingName field when associating a line item with a creative that fits into that placeholder. More...
 
- Properties inherited from Google.Api.Ads.AdManager.v202111.LineItemSummary
long orderId [get, set]
 The ID of the Order to which the More...
 
bool orderIdSpecified [get, set]
 
long id [get, set]
 Uniquely identifies the More...
 
bool idSpecified [get, set]
 
string name [get, set]
 The name of the line item. This attribute is required and has a maximum length of 255 characters. More...
 
string externalId [get, set]
 An identifier for the More...
 
string orderName [get, set]
 The name of the Order. This value is read-only. More...
 
DateTime startDateTime [get, set]
 The date and time on which the More...
 
StartDateTimeType startDateTimeType [get, set]
 Specifies whether to start serving to the More...
 
bool startDateTimeTypeSpecified [get, set]
 
DateTime endDateTime [get, set]
 The date and time on which the More...
 
int autoExtensionDays [get, set]
 The number of days to allow a line item to deliver past its #endDateTime. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts. More...
 
bool autoExtensionDaysSpecified [get, set]
 
bool unlimitedEndDateTime [get, set]
 Specifies whether or not the More...
 
bool unlimitedEndDateTimeSpecified [get, set]
 
CreativeRotationType creativeRotationType [get, set]
 The strategy used for displaying multiple Creative objects that are associated with the More...
 
bool creativeRotationTypeSpecified [get, set]
 
DeliveryRateType deliveryRateType [get, set]
 The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType::EVENLY or DeliveryRateType::FRONTLOADED depending on the network's configuration. More...
 
bool deliveryRateTypeSpecified [get, set]
 
DeliveryForecastSource deliveryForecastSource [get, set]
 Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to DeliveryForecastSource::HISTORICAL. More...
 
bool deliveryForecastSourceSpecified [get, set]
 
CustomPacingCurve customPacingCurve [get, set]
 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 DeliveryForecastSource::CUSTOM_PACING_CURVE. More...
 
RoadblockingType roadblockingType [get, set]
 The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to RoadblockingType::ONE_OR_MORE. More...
 
bool roadblockingTypeSpecified [get, set]
 
SkippableAdType skippableAdType [get, set]
 The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to SkippableAdType::NOT_SKIPPABLE. More...
 
bool skippableAdTypeSpecified [get, set]
 
FrequencyCap[] frequencyCaps [get, set]
 The set of frequency capping units for this More...
 
LineItemType lineItemType [get, set]
 Indicates the line item type of a More...
 
bool lineItemTypeSpecified [get, set]
 
int priority [get, set]
 The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the LineItemType. More...
 
bool prioritySpecified [get, set]
 
Money costPerUnit [get, set]
 The amount of money to spend per impression or click. This attribute is required for creating a More...
 
Money valueCostPerUnit [get, set]
 An amount to help the adserver rank inventory. LineItem::valueCostPerUnit artificially raises the value of inventory over the LineItem::costPerUnit but avoids raising the actual LineItem::costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money::microAmount 0. More...
 
CostType costType [get, set]
 The method used for billing this More...
 
bool costTypeSpecified [get, set]
 
LineItemDiscountType discountType [get, set]
 The type of discount being applied to a More...
 
bool discountTypeSpecified [get, set]
 
double discount [get, set]
 The number here is either a percentage or an absolute value depending on the More...
 
bool discountSpecified [get, set]
 
long contractedUnitsBought [get, set]
 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. More...
 
bool contractedUnitsBoughtSpecified [get, set]
 
CreativePlaceholder[] creativePlaceholders [get, set]
 Details about the creatives that are expected to serve through this More...
 
LineItemActivityAssociation[] activityAssociations [get, set]
 This attribute is required and meaningful only if the LineItem::costType is CostType.CPA. More...
 
EnvironmentType environmentType [get, set]
 The environment that the More...
 
bool environmentTypeSpecified [get, set]
 
AllowedFormats[] allowedFormats [get, set]
 The set of allowedFormats that this programmatic line item can have. If the set is empty, this line item allows all formats. More...
 
CompanionDeliveryOption companionDeliveryOption [get, set]
 The delivery option for companions. Setting this field is only meaningful if the following conditions are met: More...
 
bool companionDeliveryOptionSpecified [get, set]
 
bool allowOverbook [get, set]
 The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType::SPONSORSHIP and LineItemType::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. More...
 
bool allowOverbookSpecified [get, set]
 
bool skipInventoryCheck [get, set]
 The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. More...
 
bool skipInventoryCheckSpecified [get, set]
 
bool skipCrossSellingRuleWarningChecks [get, set]
 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. More...
 
bool skipCrossSellingRuleWarningChecksSpecified [get, set]
 
bool reserveAtCreation [get, set]
 The flag indicates whether inventory should be reserved when creating a line item of types LineItemType::SPONSORSHIP and LineItemType::STANDARD in an unapproved Order. The default value is false. More...
 
bool reserveAtCreationSpecified [get, set]
 
Stats stats [get, set]
 Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be More...
 
DeliveryIndicator deliveryIndicator [get, set]
 Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be More...
 
long[] deliveryData [get, set]
 Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be More...
 
Money budget [get, set]
 The amount of money allocated to the More...
 
ComputedStatus status [get, set]
 The status of the More...
 
bool statusSpecified [get, set]
 
LineItemSummaryReservationStatus reservationStatus [get, set]
 Describes whether or not inventory has been reserved for the More...
 
bool reservationStatusSpecified [get, set]
 
bool isArchived [get, set]
 The archival status of the More...
 
bool isArchivedSpecified [get, set]
 
string webPropertyCode [get, set]
 The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType::AD_EXCHANGE and LineItemType::ADSENSE. More...
 
AppliedLabel[] appliedLabels [get, set]
 The set of labels applied directly to this line item. More...
 
AppliedLabel[] effectiveAppliedLabels [get, set]
 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. This field is readonly and is assigned by Google. More...
 
bool disableSameAdvertiserCompetitiveExclusion [get, set]
 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 More...
 
bool disableSameAdvertiserCompetitiveExclusionSpecified [get, set]
 
string lastModifiedByApp [get, set]
 The application that last modified this line item. This attribute is read only and is assigned by Google. More...
 
string notes [get, set]
 Provides any additional notes that may annotate the More...
 
CompetitiveConstraintScope competitiveConstraintScope [get, set]
 The More...
 
bool competitiveConstraintScopeSpecified [get, set]
 
DateTime lastModifiedDateTime [get, set]
 The date and time this line item was last modified. More...
 
DateTime creationDateTime [get, set]
 This attribute may be More...
 
BaseCustomFieldValue[] customFieldValues [get, set]
 The values of the custom fields associated with this line item. More...
 
bool isMissingCreatives [get, set]
 Indicates if a More...
 
bool isMissingCreativesSpecified [get, set]
 
ProgrammaticCreativeSource programmaticCreativeSource [get, set]
 Indicates the ProgrammaticCreativeSource of the programmatic line item. This is a read-only field. Any changes must be made on the ProposalLineItem. More...
 
bool programmaticCreativeSourceSpecified [get, set]
 
ThirdPartyMeasurementSettings thirdPartyMeasurementSettings [get, set]
 
long videoMaxDuration [get, set]
 The max duration of a video creative associated with this More...
 
bool videoMaxDurationSpecified [get, set]
 
Goal primaryGoal [get, set]
 The primary goal that this More...
 
Goal[] secondaryGoals [get, set]
 The secondary goals that this More...
 
GrpSettings grpSettings [get, set]
 Contains the information for a line item which has a target GRP demographic. More...
 
LineItemDealInfoDto dealInfo [get, set]
 The deal information associated with this line item, if it is programmatic. More...
 
long[] viewabilityProviderCompanyIds [get, set]
 Optional IDs of the Company that provide ad verification for this line item. Company.Type::VIEWABILITY_PROVIDER. More...
 
ChildContentEligibility childContentEligibility [get, set]
 Child content eligibility designation for this line item. More...
 
bool childContentEligibilitySpecified [get, set]
 
string customVastExtension [get, set]
 Custom XML to be rendered in a custom VAST response at serving time. More...
 

Detailed Description

LineItem is an advertiser's commitment to purchase a specific number of ad impressions, clicks, or time.

Property Documentation

CreativeTargeting [] Google.Api.Ads.AdManager.v202111.LineItem.creativeTargetings
getset

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 creative placeholder's CreativePlaceholder::targetingName field by referencing the creative targeting's CreativeTargeting::name name. It also needs to be re-specified in the LineItemCreativeAssociation::targetingName field when associating a line item with a creative that fits into that placeholder.

Targeting Google.Api.Ads.AdManager.v202111.LineItem.targeting
getset

Contains the targeting criteria for the ad campaign. This attribute is required.

Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202111.TargetCustomCriteria.Run().


The documentation for this class was generated from the following file: