|
Ads API .NET library
|
|
Ads API .NET library
|
The More...
Properties | |
| 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] |
| bool | youtubeKidsRestricted [get, set] |
| 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 Ad Manager Help Center for more information. More... | |
| bool | youtubeKidsRestrictedSpecified [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... | |
The
LineItemSummary represents the base class from which a LineItem is derived.
|
getset |
This attribute is required and meaningful only if the LineItem::costType is CostType.CPA.
|
getset |
The set of allowedFormats that this programmatic line item can have. If the set is empty, this line item allows all formats.
|
getset |
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.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
|
getset |
true, if a value is specified for allowOverbook, false otherwise.
|
getset |
The set of labels applied directly to this line item.
|
getset |
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.
|
getset |
true, if a value is specified for autoExtensionDays, false otherwise.
|
getset |
|
getset |
Child content eligibility designation for this line item.
This field is optional and defaults to ChildContentEligibility::DISALLOWED.
|
getset |
true, if a value is specified for childContentEligibility, false otherwise.
|
getset |
The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
This field is optional and defaults to CompanionDeliveryOption::OPTIONAL if the above conditions are met. In all other cases it defaults to CompanionDeliveryOption::UNKNOWN and is not meaningful.
|
getset |
true, if a value is specified for companionDeliveryOption, false otherwise.
|
getset |
The
CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field is optional, defaults to CompetitiveConstraintScope::POD, and only applies to video line items.
|
getset |
true, if a value is specified for competitiveConstraintScope, false otherwise.
|
getset |
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 LineItemType::SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only.
For LineItemType::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 LineItemType::STANDARD line items if you have this feature enabled on your network.
|
getset |
true, if a value is specified for contractedUnitsBought, false otherwise.
|
getset |
The amount of money to spend per impression or click. This attribute is required for creating a
|
getset |
The method used for billing this
LineItem. This attribute is required.
|
getset |
true, if a value is specified for costType, false otherwise.
|
getset |
This attribute may be
null for line items created before this feature was introduced.
|
getset |
Details about the creatives that are expected to serve through this
LineItem. This attribute is required and replaces the creativeSizes attribute.
|
getset |
The strategy used for displaying multiple Creative objects that are associated with the
. This attribute is required.
|
getset |
true, if a value is specified for creativeRotationType, false otherwise.
|
getset |
The values of the custom fields associated with this line item.
|
getset |
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.
|
getset |
Custom XML to be rendered in a custom VAST response at serving time.
|
getset |
The deal information associated with this line item, if it is programmatic.
|
getset |
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
null if the delivery data cannot be computed due to one of the following reasons:
|
getset |
Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to DeliveryForecastSource::HISTORICAL.
|
getset |
true, if a value is specified for deliveryForecastSource, false otherwise.
|
getset |
Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be
null if the delivery indicator information is not available due to one of the following reasons:
|
getset |
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.
|
getset |
true, if a value is specified for deliveryRateType, false otherwise.
|
getset |
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.
|
getset |
true, if a value is specified for disableSameAdvertiserCompetitiveExclusion, false otherwise.
|
getset |
The number here is either a percentage or an absolute value depending on the
LineItemDiscountType. If the is LineItemDiscountType::PERCENTAGE, then only non-fractional values are supported.
|
getset |
true, if a value is specified for discount, false otherwise.
|
getset |
The type of discount being applied to a
LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType::PERCENTAGE.
|
getset |
true, if a value is specified for discountType, false otherwise.
|
getset |
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.
|
getset |
The date and time on which the
LineItem will stop serving. This attribute is required unless LineItem::unlimitedEndDateTime is set to true. If specified, it must be after the LineItem::startDateTime. This end date and time does not include auto extension days.
|
getset |
The environment that the
LineItem is targeting. The default value is EnvironmentType::BROWSER. If this value is EnvironmentType::VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also .
|
getset |
true, if a value is specified for environmentType, false otherwise.
|
getset |
An identifier for the
LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
|
getset |
The set of frequency capping units for this
LineItem. This attribute is optional.
|
getset |
Contains the information for a line item which has a target GRP demographic.
|
getset |
|
getset |
true, if a value is specified for id, false otherwise.
|
getset |
The archival status of the
LineItem. This attribute is readonly.
|
getset |
true, if a value is specified for isArchived, false otherwise.
|
getset |
Indicates if a
LineItem is missing any creatives for the creativePlaceholders specified.
Creatives can be considered missing for several reasons including:
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. Creative do not match the CreativePlaceholder::effectiveAppliedLabels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
|
getset |
true, if a value is specified for isMissingCreatives, false otherwise.
|
getset |
The application that last modified this line item. This attribute is read only and is assigned by Google.
|
getset |
The date and time this line item was last modified.
|
getset |
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 on the Ad Manager Help Center.
|
getset |
true, if a value is specified for lineItemType, false otherwise.
|
getset |
The name of the line item. This attribute is required and has a maximum length of 255 characters.
|
getset |
Provides any additional notes that may annotate the
. This attribute is optional and has a maximum length of 65,535 characters.
|
getset |
The ID of the Order to which the
belongs. This attribute is required.
|
getset |
true, if a value is specified for orderId, false otherwise.
|
getset |
The name of the Order. This value is read-only.
|
getset |
The primary goal that this
LineItem is associated with, which is used in its pacing and budgeting.
|
getset |
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.
The following table shows the default, minimum, and maximum priority values are for each line item type:
| LineItemType - default priority (minimum priority, maximum priority) | |
|---|---|
| LineItemType::SPONSORSHIP | 4 (2, 5) |
| LineItemType::STANDARD | 8 (6, 10) |
| LineItemType::NETWORK | 12 (11, 14) |
| LineItemType::BULK | 12 (11, 14) |
| LineItemType::PRICE_PRIORITY | 12 (11, 14) |
| LineItemType::HOUSE | 16 (15, 16) |
| LineItemType::CLICK_TRACKING | 16 (1, 16) |
| LineItemType::AD_EXCHANGE | 12 (1, 16) |
| LineItemType::ADSENSE | 12 (1, 16) |
| LineItemType::BUMPER | 16 (15, 16) |
This field can only be edited by certain networks, otherwise a PermissionError will occur.
|
getset |
true, if a value is specified for priority, false otherwise.
|
getset |
Indicates the ProgrammaticCreativeSource of the programmatic line item. This is a read-only field. Any changes must be made on the ProposalLineItem.
|
getset |
true, if a value is specified for programmaticCreativeSource, false otherwise.
|
getset |
Describes whether or not inventory has been reserved for the
. This attribute is readonly and is assigned by Google.
|
getset |
true, if a value is specified for reservationStatus, false otherwise.
|
getset |
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.
|
getset |
true, if a value is specified for reserveAtCreation, false otherwise.
|
getset |
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.
|
getset |
true, if a value is specified for roadblockingType, false otherwise.
|
getset |
The secondary goals that this
LineItem is associated with. It is required and meaningful only if the LineItem::costType is CostType.CPA or if the LineItem::lineItemType is LineItemType::SPONSORSHIP and LineItem::costType is CostType.CPM.
|
getset |
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.
|
getset |
true, if a value is specified for skipCrossSellingRuleWarningChecks, false otherwise.
|
getset |
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 will not persist on the line item itself, and the value will only affect the current request.
|
getset |
true, if a value is specified for skipInventoryCheck, false otherwise.
|
getset |
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.
|
getset |
true, if a value is specified for skippableAdType, false otherwise.
|
getset |
The date and time on which the
LineItem is enabled to begin serving. This attribute is required and must be in the future.
|
getset |
Specifies whether to start serving to the
LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType::USE_START_DATE_TIME.
|
getset |
true, if a value is specified for startDateTimeType, false otherwise.
|
getset |
Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be
null in case there are no statistics for a line item yet.
|
getset |
The status of the
LineItem. This attribute is readonly.
|
getset |
true, if a value is specified for status, false otherwise.
|
getset |
|
getset |
Specifies whether or not the
LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType::SPONSORSHIP, LineItemType::NETWORK, LineItemType::PRICE_PRIORITY and LineItemType::HOUSE.
|
getset |
true, if a value is specified for unlimitedEndDateTime, false otherwise.
|
getset |
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.
|
getset |
The max duration of a video creative associated with this
in milliseconds.
This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0.
|
getset |
true, if a value is specified for videoMaxDuration, false otherwise.
|
getset |
Optional IDs of the Company that provide ad verification for this line item. Company.Type::VIEWABILITY_PROVIDER.
|
getset |
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.
|
getset |
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 Ad Manager Help Center for more information.
|
getset |
true, if a value is specified for youtubeKidsRestricted, false otherwise.
1.8.5