type LineItemTemplate (v202402)
Service
LineItemTemplateService
Represents the template that populates the fields of a new line item being created.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202402
Field
|
id
|
xsd:long
Uniquely identifies the LineItemTemplate . This attribute is read-only and is assigned
by Google when a template is created.
|
name
|
xsd:string
The name of the LineItemTemplate . This attribute is required.
|
isDefault
|
xsd:boolean
Whether or not the LineItemTemplate represents the default choices for creating a
LineItem . Only one default LineItemTemplate is allowed per Network .
This attribute is readonly.
|
lineItemName
|
xsd:string
The default name of a new LineItem . This attribute is optional
and has a maximum length of 127 characters.
|
enabledForSameAdvertiserException
|
xsd:boolean
The default value for the LineItem.enabledForSameAdvertiserException field of a new
LineItem . This attribute is required.
|
notes
|
xsd:string
The default notes for a new LineItem . This attribute is optional
and has a maximum length of 65,535 characters.
|
lineItemType
|
LineItemType
The default type of a new LineItem . This attribute is
required.
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.
|
deliveryRateType
|
DeliveryRateType
The default delivery strategy for a new LineItem .
This attribute is required.
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.
|
roadblockingType
|
RoadblockingType
The default roadblocking strategy for a new LineItem .
This attribute is required.
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.
|
creativeRotationType
|
CreativeRotationType
The default creative rotation strategy for a new LineItem . This attribute is required.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["Represents a template that automatically populates the fields of a new line item."],["Contains default values for line item properties such as name, type, delivery rate, and roadblocking."],["Only one default `LineItemTemplate` is allowed per network and is indicated by the `isDefault` field."],["A `LineItemTemplate` has various fields including `id`, `name`, `lineItemType`, and `deliveryRateType` among others."],["Fields in the `LineItemTemplate` determine the default settings of newly created line items."]]],[]]