|
Ads API .NET library
|
|
Ads API .NET library
|
A More...
Properties | |
| long | id [get, set] |
| The unique ID of the More... | |
| bool | idSpecified [get, set] |
| long | proposalId [get, set] |
| The unique ID of the Proposal, to which the More... | |
| bool | proposalIdSpecified [get, set] |
| string | name [get, set] |
| The name of the More... | |
| DateTime | startDateTime [get, set] |
| The date and time at which the line item associated with the More... | |
| DateTime | endDateTime [get, set] |
| The date and time at which the line item associated with the More... | |
| string | timeZoneId [get, set] |
| The time zone ID in tz database format (e.g. "America/Los_Angeles") for this More... | |
| string | internalNotes [get, set] |
| Provides any additional notes that may annotate the More... | |
| bool | isArchived [get, set] |
| The archival status of the More... | |
| bool | isArchivedSpecified [get, set] |
| Goal | goal [get, set] |
| The goal(i.e. contracted quantity, quantity or limit) that this More... | |
| Goal[] | secondaryGoals [get, set] |
| The secondary goals that this More... | |
| long | contractedUnitsBought [get, set] |
| The contracted number of daily minimum impressions used for LineItemType::SPONSORSHIP More... | |
| bool | contractedUnitsBoughtSpecified [get, set] |
| DeliveryRateType | deliveryRateType [get, set] |
| The strategy for delivering ads over the course of the More... | |
| bool | deliveryRateTypeSpecified [get, set] |
| 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 during creation and defaults to the product's roadblocking type, or RoadblockingType::ONE_OR_MORE if not specified by the product. More... | |
| bool | roadblockingTypeSpecified [get, set] |
| CompanionDeliveryOption | companionDeliveryOption [get, set] |
| The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType::CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption::OPTIONAL. The default value in other cases is CompanionDeliveryOption::UNKNOWN. Providing something other than CompanionDeliveryOption::UNKNOWN will cause an error. More... | |
| bool | companionDeliveryOptionSpecified [get, set] |
| long | videoMaxDuration [get, set] |
| The max duration of a video creative associated with this More... | |
| bool | videoMaxDurationSpecified [get, set] |
| SkippableAdType | videoCreativeSkippableAdType [get, set] |
| The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType::NOT_SKIPPABLE. More... | |
| bool | videoCreativeSkippableAdTypeSpecified [get, set] |
| FrequencyCap[] | frequencyCaps [get, set] |
| The set of frequency capping units for this More... | |
| long | dfpLineItemId [get, set] |
| The unique ID of corresponding LineItem. This will be More... | |
| bool | dfpLineItemIdSpecified [get, set] |
| LineItemType | lineItemType [get, set] |
| The corresponding LineItemType of the More... | |
| bool | lineItemTypeSpecified [get, set] |
| int | lineItemPriority [get, set] |
| The priority for the corresponding LineItem of the More... | |
| bool | lineItemPrioritySpecified [get, set] |
| RateType | rateType [get, set] |
| The method used for billing the More... | |
| bool | rateTypeSpecified [get, set] |
| CreativePlaceholder[] | creativePlaceholders [get, set] |
| Details about the creatives that are expected to serve through the More... | |
| Targeting | targeting [get, set] |
| Contains the targeting criteria for the More... | |
| BaseCustomFieldValue[] | customFieldValues [get, set] |
| The values of the custom fields associated with the More... | |
| AppliedLabel[] | appliedLabels [get, set] |
| The set of labels applied directly to the More... | |
| AppliedLabel[] | effectiveAppliedLabels [get, set] |
| Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. 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] |
| bool | isSold [get, set] |
| Indicates whether this More... | |
| bool | isSoldSpecified [get, set] |
| Money | netRate [get, set] |
| The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money::getAmountInMicros must be multiples of 100. It doesn't include agency commission. More... | |
| Money | netCost [get, set] |
| The cost of the More... | |
| DeliveryIndicator | deliveryIndicator [get, set] |
| Indicates how well the line item generated from this proposal line item has been performing. This will be More... | |
| long[] | deliveryData [get, set] |
| Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be More... | |
| ComputedStatus | computedStatus [get, set] |
| The status of the LineItem generated from this proposal line item. This will be More... | |
| bool | computedStatusSpecified [get, set] |
| DateTime | lastModifiedDateTime [get, set] |
| The date and time this More... | |
| ReservationStatus | reservationStatus [get, set] |
| The reservation status of the ProposalLineItem. This attribute is read-only. More... | |
| bool | reservationStatusSpecified [get, set] |
| DateTime | lastReservationDateTime [get, set] |
| The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only. More... | |
| EnvironmentType | environmentType [get, set] |
| The environment that the More... | |
| bool | environmentTypeSpecified [get, set] |
| AllowedFormats[] | allowedFormats [get, set] |
| The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. More... | |
| bool | isProgrammatic [get, set] |
| Whether or not the Proposal for this More... | |
| bool | isProgrammaticSpecified [get, set] |
| string | additionalTerms [get, set] |
| Additional terms shown to the buyer in Marketplace. More... | |
| ProgrammaticCreativeSource | programmaticCreativeSource [get, set] |
| Indicates the ProgrammaticCreativeSource of the programmatic line item. More... | |
| bool | programmaticCreativeSourceSpecified [get, set] |
| GrpSettings | grpSettings [get, set] |
| Contains the information for a proposal line item which has a target GRP demographic. More... | |
| long | estimatedMinimumImpressions [get, set] |
| The estimated minimum impressions that should be delivered for a proposal line item. More... | |
| bool | estimatedMinimumImpressionsSpecified [get, set] |
| ThirdPartyMeasurementSettings | thirdPartyMeasurementSettings [get, set] |
| Contains third party measurement settings for cross-sell Partners More... | |
| ProposalLineItemMakegoodInfo | makegoodInfo [get, set] |
| Makegood info for this proposal line item. Immutable once created. More... | |
| bool | hasMakegood [get, set] |
| Whether this proposal line item has an associated makegood. This attribute is read-only. More... | |
| bool | hasMakegoodSpecified [get, set] |
| bool | canCreateMakegood [get, set] |
| Whether a new makegood associated with this line item can be created. This attribute is read-only. More... | |
| bool | canCreateMakegoodSpecified [get, set] |
| NegotiationRole | pauseRole [get, set] |
| The NegotiationRole that paused the proposal line item, i.e. NegotiationRole::seller or NegotiationRole::buyer, or More... | |
| bool | pauseRoleSpecified [get, set] |
| string | pauseReason [get, set] |
| The reason for pausing the ProposalLineItem, provided by the pauseRole. It is More... | |
A
ProposalLineItem is added to a programmatic Proposal and is similar to a delivery LineItem. It contains delivery details including information like impression goal or quantity, start and end times, and targeting.
|
getset |
Additional terms shown to the buyer in Marketplace.
|
getset |
The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats.
|
getset |
The set of labels applied directly to the
ProposalLineItem. This attribute is optional.
|
getset |
Whether a new makegood associated with this line item can be created. This attribute is read-only.
|
getset |
true, if a value is specified for canCreateMakegood, false otherwise.
|
getset |
The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType::CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption::OPTIONAL. The default value in other cases is CompanionDeliveryOption::UNKNOWN. Providing something other than CompanionDeliveryOption::UNKNOWN will cause an error.
|
getset |
true, if a value is specified for companionDeliveryOption, false otherwise.
|
getset |
The status of the LineItem generated from this proposal line item. This will be
null if the proposal line item has not pushed to Ad Manager. This attribute is read-only.
|
getset |
true, if a value is specified for computedStatus, false otherwise.
|
getset |
The contracted number of daily minimum impressions used for LineItemType::SPONSORSHIP
deals with a rate type of RateType::CPD.
This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.
|
getset |
true, if a value is specified for contractedUnitsBought, false otherwise.
|
getset |
Details about the creatives that are expected to serve through the
ProposalLineItem. This attribute is optional during creation and defaults to the Product::creativePlaceholders product's creative placeholders. This attribute is required.
|
getset |
The values of the custom fields associated with the
. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
|
getset |
Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be
if the delivery data cannot be computed due to one of the following reasons:
|
getset |
Indicates how well the line item generated from this proposal line item has been performing. This will be
null if the delivery indicator information is not available due to one of the following reasons:
This attribute is read-only.
|
getset |
The strategy for delivering ads over the course of the
's duration. This attribute is required. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType::FRONTLOADED.
|
getset |
true, if a value is specified for deliveryRateType, false otherwise.
|
getset |
|
getset |
true, if a value is specified for dfpLineItemId, 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.
This attribute is optional and defaults to false.
|
getset |
true, if a value is specified for disableSameAdvertiserCompetitiveExclusion, false otherwise.
|
getset |
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
|
getset |
The date and time at which the line item associated with the
stops beening served. This attribute is optional during creation, but required and must be after the #startDateTime. The DateTime::timeZoneID is required if end date time is not null.
|
getset |
The environment that the
ProposalLineItem is targeting. The default value is EnvironmentType::BROWSER. If this value is EnvironmentType::VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize::environmentType is also EnvironmentType::VIDEO_PLAYER.
This field is read-only and set to Product::environmentType of the product this proposal line item was created from.
|
getset |
true, if a value is specified for environmentType, false otherwise.
|
getset |
The estimated minimum impressions that should be delivered for a proposal line item.
|
getset |
true, if a value is specified for estimatedMinimumImpressions, false otherwise.
|
getset |
The set of frequency capping units for this
. This attribute is optional during creation and defaults to the product's frequency caps if Product::allowFrequencyCapsCustomization is false.
|
getset |
The goal(i.e. contracted quantity, quantity or limit) that this
ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal::units must be greater than 0 when the proposal line item turns into a line item, Goal::goalType and Goal::unitType are readonly. For a Preferred deal , the goal type can only be GoalType::NONE. This attribute is required.
|
getset |
Contains the information for a proposal line item which has a target GRP demographic.
|
getset |
Whether this proposal line item has an associated makegood. This attribute is read-only.
|
getset |
true, if a value is specified for hasMakegood, false otherwise.
|
getset |
The unique ID of the
ProposalLineItem. This attribute is read-only.
|
getset |
true, if a value is specified for id, false otherwise.
|
getset |
Provides any additional notes that may annotate the
. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
|
getset |
The archival status of the
ProposalLineItem. This attribute is read-only.
|
getset |
true, if a value is specified for isArchived, false otherwise.
|
getset |
Whether or not the Proposal for this
is a programmatic deal. This attribute is populated from Proposal::isProgrammatic. This attribute is read-only.
|
getset |
true, if a value is specified for isProgrammatic, false otherwise.
|
getset |
Indicates whether this
ProposalLineItem has been sold. This attribute is read-only.
|
getset |
true, if a value is specified for isSold, false otherwise.
|
getset |
The date and time this
ProposalLineItem was last modified.
This attribute is assigned by Google when a is updated. This attribute is read-only.
|
getset |
The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only.
|
getset |
The priority for the corresponding LineItem of the
ProposalLineItem. This attribute is optional during creation and defaults to the default priority of the #lineItemType. For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem::priority for more information.
|
getset |
true, if a value is specified for lineItemPriority, false otherwise.
|
getset |
The corresponding LineItemType of the
ProposalLineItem. For a programmatic , the value can only be one of:
This attribute is required.
|
getset |
true, if a value is specified for lineItemType, false otherwise.
|
getset |
Makegood info for this proposal line item. Immutable once created.
Null if this proposal line item is not a makegood.
|
getset |
The name of the
ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
|
getset |
The cost of the
ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money::getAmountInMicros must be multiples of 10000. It doesn't include agency commission.
For example, if Proposal::currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported.
At least one of the two fields ProposalLineItem::netRate and ProposalLineItem::netCost is required.
|
getset |
The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money::getAmountInMicros must be multiples of 100. It doesn't include agency commission.
For example, if Proposal::currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported.
At least one of the two fields ProposalLineItem::netRate,and ProposalLineItem::netCost is required.
|
getset |
The reason for pausing the ProposalLineItem, provided by the pauseRole. It is
null when the ProposalLineItem is not paused. This attribute is read-only.
|
getset |
The NegotiationRole that paused the proposal line item, i.e. NegotiationRole::seller or NegotiationRole::buyer, or
null when the proposal is not paused. This attribute is read-only.
|
getset |
true, if a value is specified for pauseRole, false otherwise.
|
getset |
Indicates the ProgrammaticCreativeSource of the programmatic line item.
|
getset |
true, if a value is specified for programmaticCreativeSource, false otherwise.
|
getset |
The unique ID of the Proposal, to which the
ProposalLineItem belongs. This attribute is required for creation and then is readonly. This attribute is required.
|
getset |
true, if a value is specified for proposalId, false otherwise.
|
getset |
The method used for billing the
ProposalLineItem. This attribute is read-only. This attribute is required.
|
getset |
true, if a value is specified for rateType, false otherwise.
|
getset |
The reservation status of the ProposalLineItem. This attribute is read-only.
|
getset |
true, if a value is specified for reservationStatus, 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 during creation and defaults to the product's roadblocking type, or RoadblockingType::ONE_OR_MORE if not specified by the product.
|
getset |
true, if a value is specified for roadblockingType, false otherwise.
|
getset |
The secondary goals that this
ProposalLineItem is associated with. For a programmatic line item with the properties RateType::CPM and LineItemType::SPONSORSHIP, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list.
|
getset |
The date and time at which the line item associated with the
is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime::timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.
|
getset |
Contains the targeting criteria for the
ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.
|
getset |
Contains third party measurement settings for cross-sell Partners
|
getset |
The time zone ID in tz database format (e.g. "America/Los_Angeles") for this
ProposalLineItem. The number of serving days is calculated in this time zone. So if #rateType is RateType::CPD, it will affect the cost calculation. The #startDateTime and #endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only.
|
getset |
The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType::NOT_SKIPPABLE.
|
getset |
true, if a value is specified for videoCreativeSkippableAdType, false otherwise.
|
getset |
The max duration of a video creative associated with this
in milliseconds. This attribute is optional, defaults to the Product::videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.
|
getset |
true, if a value is specified for videoMaxDuration, false otherwise.
1.8.5 
