type Product (v201808)

Proposal line items are created from products, from which their properties are copied.


Namespace
https://www.google.com/apis/ads/publisher/v201808

Field

name

xsd:string

The name of the Product. This attribute is populated by Google, but can be updated. To overwrite this, set the nameSource to ValueSourceType.DIRECTLY_SPECIFIED when setting the value of this field. It has maximum length of 255 characters if overridden via update.

This attribute is required.

nameSource

ValueSourceType

Specifies the source of the Product.name value. To revert an overridden value to its default, set this field to ValueSourceType.PARENT.


Enumerations
PARENT
The field's value is inherited from the parent object.
DIRECTLY_SPECIFIED
The field's value is user specified and not inherited.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

status

ProductStatus

The status of the Product. This attribute is read-only.


Enumerations
ACTIVE
Accessible to sales person.
INACTIVE
Not accessible to sales person.
ARCHIVED
Products can no longer be used.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

productType

ProductType

The type of Product. This will always be ProductType.DFP for programmatic guaranteed products.


Enumerations
DFP
For line items that are booked and managed in DFP.
OFFLINE
Offline charges indicate services you render for a client which are also outside of the DFP system, such as consulting or creative services.
NON_DFP
For campaigns that are booked and managed by a third party outside of DFP.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

productTemplateId

xsd:long

The ID of the ProductTemplate from which this product is generated.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

id

xsd:long

Unique identifier of the Product. This attribute is read-only and is assigned by Google when a Product is created.

notes

xsd:string

The notes of this product. This attribute is optional, with a maximum length of 511 characters.

productTemplateDescription

xsd:string

The description of the ProductTemplate from which this product is generated.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

lastModifiedDateTime

DateTime

The date and time this product was last modified. This attribute is read-only and is assigned by Google when a product is updated.

rateType

RateType

The method used for billing the created ProposalLineItem.


Enumerations
CPM
The rate applies to cost per mille (CPM) revenue.
CPC
The rate applies to cost per click (CPC) revenue.
CPD
The rate applies to cost per day (CPD) revenue.
CPU
The rate applies to cost per unit (CPU) revenue.
FLAT_FEE
The rate applies to flat fee revenue.
VCPM
The rate applies to Active View viewable cost per mille (vCPM) revenue.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

roadblockingType

RoadblockingType

The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page.


Enumerations
ONLY_ONE
Only one creative from a line item can serve at a time.
ONE_OR_MORE
Any number of creatives from a line item can serve together at a time.
AS_MANY_AS_POSSIBLE
As many creatives from a line item as can fit on a page will serve. This could mean anywhere from one to all of a line item's creatives given the size constraints of ad slots on a page.
ALL_ROADBLOCK
All or none of the creatives from a line item will serve. This option will only work if served to a GPT tag using SRA (single request architecture mode).
CREATIVE_SET
A master/companion CreativeSet roadblocking type. A LineItem.creativePlaceholders must be set accordingly.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

deliveryRateType

DeliveryRateType

The strategy for delivering ads over the course of the line item's duration.


Enumerations
EVENLY
Line items are served as evenly as possible across the number of days specified in a line item's LineItem.duration.
FRONTLOADED
Line items are served more aggressively in the beginning of the flight date.
AS_FAST_AS_POSSIBLE
The booked impressions for a line item may be delivered well before the LineItem.endDateTime. Other lower-priority or lower-value line items will be stopped from delivering until this line item meets the number of impressions or clicks it is booked for.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

creativeRotationType

CreativeRotationType

The strategy used for displaying multiple Creative objects that are associated with the created ProposalLineItem.


Enumerations
EVEN
Creatives are displayed roughly the same number of times over the duration of the line item.
OPTIMIZED
Creatives are served roughly proportionally to their performance.
MANUAL
Creatives are served roughly proportionally to their weights, set on the LineItemCreativeAssociation.
SEQUENTIAL
Creatives are served exactly in sequential order, aka Storyboarding. Set on the LineItemCreativeAssociation.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

companionDeliveryOption

CompanionDeliveryOption

The delivery option for companions.


Enumerations
OPTIONAL
Companions are not required to serve a creative set. The creative set can serve to inventory that has zero or more matching companions.
AT_LEAST_ONE
At least one companion must be served in order for the creative set to be used.
ALL
All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled.
UNKNOWN
The delivery type is unknown.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

creativePlaceholders

CreativePlaceholder[]

Details about the creatives that are expected to serve for the created ProposalLineItem.

For a roadblockingType of RoadblockingType.CREATIVE_SET, all creative placeholders must have a master and at least one companion size.

This attribute is read-only when:
using programmatic guaranteed, using sales management.
not using programmatic, using sales management.

lineItemType

LineItemType

Indicates the line item type for the created ProposalLineItem.


Enumerations
SPONSORSHIP
The type of LineItem for which a percentage of all the impressions that are being sold are reserved.
STANDARD
The type of LineItem for which a fixed quantity of impressions or clicks are reserved.
NETWORK
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the daily percentage of unsold impressions or clicks when creating this line item.
BULK
The type of LineItem for which a fixed quantity of impressions or clicks will be delivered at a priority lower than the LineItemType.STANDARD type.
PRICE_PRIORITY
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the fixed quantity of unsold impressions or clicks when creating this line item.
HOUSE
The type of LineItem typically used for ads that promote products and services chosen by the publisher. These usually do not generate revenue and have the lowest delivery priority.
LEGACY_DFP
Represents a legacy LineItem that has been migrated from the DFP system. Such line items cannot be created any more. Also, these line items cannot be activated or resumed.
CLICK_TRACKING
The type of LineItem used for ads that track ads being served externally of Ad Manager, for example an email newsletter. The click through would reference this ad, and the click would be tracked via this ad.
ADSENSE
A LineItem using dynamic allocation backed by AdSense.
AD_EXCHANGE
A LineItem using dynamic allocation backed by the Google Ad Exchange.
BUMPER
Represents a non-monetizable video LineItem that targets one or more bumper positions, which are short house video messages used by publishers to separate content from ad breaks.
ADMOB
A LineItem using dynamic allocation backed by AdMob.
PREFERRED_DEAL
The type of LineItem for which there are no impressions reserved, and will serve for a second price bid. All LineItems of type LineItemType.PREFERRED_DEAL should be created via a ProposalLineItem with a matching type. When creating a LineItem of type LineItemType.PREFERRED_DEAL, the ProposalLineItem.estimatedMinimumImpressions field is required.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

priority

xsd:int

The priority for the created ProposalLineItem. The priority is a value between 1 and 16.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

frequencyCaps

FrequencyCap[]

The set of frequency capping units for the created ProposalLineItem. Each frequency cap in the list must have unique TimeUnit.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

builtInTargeting

Targeting

The targeting for the created ProposalLineItem. For those scenarios using sales management, it's a combination of ProductTemplate.productSegmentation and ProductTemplate.builtInTargeting. See details in ProductTemplate.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

customizableAttributes

CustomizableAttributes

Specifies what targeting or attributes for the created ProposalLineItem are customizable.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

customFieldValues

  1. BaseCustomFieldValue[]
    1. CustomFieldValue
    2. DropDownCustomFieldValue

The values of the custom fields associated with this Product. This attribute is optional.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

environmentType

EnvironmentType

The environment that the created ProposalLineItem will target. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then the ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER.


Enumerations
BROWSER
A regular web browser.
VIDEO_PLAYER
Video players.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

productMarketplaceInfo

ProductMarketplaceInfo

Marketplace information of this Product.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
This attribute is required when:
  • using programmatic guaranteed, using sales management.

videoMaxDuration

xsd:long

The max duration of a video creative associated with this Product in milliseconds. This value is only meaningful if this is a video product.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.