type ProductTemplate (v201808)

ProductTemplate is used to generate products. All generated products will inherit all attributes from their ProductTemplate, except for segmentation, which will be included in the Product.targeting. The generated products in turn will be used to create proposal line items so that almost all attributes in the product template are properties of the proposal line item.


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

Field

id

xsd:long

Uniquely identifies the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

name

xsd:string

The name of the ProductTemplate. This attribute has maximum length of 255 characters.

This attribute is required.

creationDateTime

DateTime

The creation time of the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

lastModifiedDateTime

DateTime

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

description

xsd:string

The description of the ProductTemplate. This attribute has maximum length of 511 characters. This attribute is optional.

nameMacro

xsd:string

The name macro of the ProductTemplate. The name macro is used to generate the Product.name. This attribute is required and has maximum length of 1023 characters. The name macro can contain plain text and several placeholders that will be replaced with values specified in the ProductTemplate when generating product names. Allowed placeholders are:

Placeholder Segmentation
<ad-unit> ProductSegmentation.adUnitSegments
<placement> ProductSegmentation.placementSegment
<location> ProductSegmentation.geoSegment
<user-domain> ProductSegmentation.userDomainSegment
<bandwidth-group> ProductSegmentation.bandwidthSegment
<browser> ProductSegmentation.browserSegment
<browser-language> ProductSegmentation.browserLanguageSegment
<operating-system> ProductSegmentation.operatingSystemSegment
<frequency-cap> frequencyCaps
<rate-type> rateType
<creative-placeholder-size> creativePlaceholders
<line-item-type> lineItemType
<line-item-priority> priority
<template-name> name
Each placeholder should appear no more than once and all expanded features must have their corresponding placeholders in the name macro. This attribute is required.

status

ProductTemplateStatus

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


Enumerations
ACTIVE
Product template is active, and all products it generates without status overridden are available in product catalog.
DRAFT
Not used.
CANCELED
Product template is inactive, no product is generated.
ARCHIVED
No unarchived proposal should reference this template and report on it. All persisted products based on this product template are archived as well.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

productType

ProductType

The type of generated Product. Note: if the type is ProductType.OFFLINE, then the following fields must be null or empty: roadblockingType, lineItemType, frequencyCaps, productSegmentation and targeting.


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 required.

creatorId

xsd:long

The id of the user who created the ProductTemplate. This attribute is read-only and is assigned by Google.

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 required.

roadblockingType

RoadblockingType

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 if productType is ProductType.DFP, or RoadblockingType.CREATIVE_SET if there are companion sizes in creativePlaceholders.


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.

deliveryRateType

DeliveryRateType

The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY if productType is ProductType.DFP.


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.

creativeRotationType

CreativeRotationType

The strategy used for displaying multiple Creative objects that are associated with the created ProposalLineItem. This attribute is optional and defaults to CreativeRotationType.OPTIMIZED if productType is ProductType.DFP.


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.

companionDeliveryOption

CompanionDeliveryOption

The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  1. The Guaranteed roadblocks feature is enabled on your network.
  2. One of the following is true.

This field is optional and defaults to CompanionDeliveryOption.OPTIONAL if the above conditions are met and productType is ProductType.DFP.


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.

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 required when productType is ProductType.DFP.

lineItemType

LineItemType

Indicates the line item type for the created ProposalLineItem. This attribute is required when productType is ProductType.DFP.


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.

priority

xsd:int

Priority of ProposalLineItem. The priority is a value between 1 and 16. If not specified, the default priority of the LineItemType will be assigned. The following default, minimum and maximum priority values is allowed 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
Note: it's ignored when productType is ProductType.OFFLINE.

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 optional.

productSegmentation

ProductSegmentation

The product segmentation. The combination from the segments and the targeting will produce the targeting on the resulting ProposalLineItem. Any type of segmentation cannot also be used for targeting. This attribute is optional. Note: if you specify ProducSegmentation.geoSegment, then ProductTemplateTargeting.geoTargeting must be null or empty, vice versa. This also applies to other targeting and segmentation.

builtInTargeting

Targeting

Targeting to be included in the created ProposalLineItem. Any type targeted cannot also be used for segmentation.

This attribute is optional. Note: if productType is ProductType.DFP and productSegmentation is not specified, this attribute is required.

customizableAttributes

CustomizableAttributes

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

This attribute is optional. If not specified, then no targeting or attributes are customizable.

customFieldValues

  1. BaseCustomFieldValue[]
    1. CustomFieldValue
    2. DropDownCustomFieldValue

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

environmentType

EnvironmentType

The environment that the created ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then the ProposalLineItem can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.


Enumerations
BROWSER
A regular web browser.
VIDEO_PLAYER
Video players.

videoMaxDuration

xsd:long

The max duration of a video creative associated with this ProductTemplate in milliseconds. This attribute is optional, defaults to 0, and only meaningful if this is a video product template.

productTemplateMarketplaceInfo

ProductTemplateMarketplaceInfo

Marketplace information of this ProductTemplate.

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

Send feedback about...

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