A CreativePlaceholder
describes a slot that a creative is expected to fill. This is used
primarily to help in forecasting, and also to validate that the correct creatives are associated
with the line item. A CreativePlaceholder
must contain a size, and it can optionally
contain companions. Companions are only valid if the line item's environment type is EnvironmentType.VIDEO_PLAYER
.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202508
Field
size
The dimensions that the creative is expected to have. This attribute is required.
creativeTemplateId
xsd:
long
The native creative template ID.
This value is only required if creativeSizeType is CreativeSizeType.NATIVE .
companions
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a LineItem.environmentType of EnvironmentType.VIDEO_PLAYER or LineItem.roadblockingType of RoadblockingType.CREATIVE_SET .
appliedLabels
AppliedLabel
[]
The set of label frequency caps applied directly to this creative placeholder.
effectiveAppliedLabels
AppliedLabel
[]
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google.
expectedCreativeCount
xsd:
int
Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
creativeSizeType
Describes the types of sizes a creative can be. By default, the creative's size is CreativeSizeType.PIXEL , which is a dimension based size (width-height pair).
Enumerations
-
PIXEL - Dimension based size, an actual height and width.
-
ASPECT_RATIO - Mobile size, that is expressed as a ratio of say 4 by 1, that could be met by a 100 x 25 sized image.
-
INTERSTITIAL - Out-of-page size, that is not related to the slot it is served. But rather is a function of the snippet, and the values set. This must be used with 1x1 size.
-
IGNORED - Size has no meaning
1. For Click Tracking entities, where size doesn't matter 2. For entities that allow all requested sizes, where the size represents all sizes.
-
NATIVE - Native size, which is a function of the how the client renders the creative. This must be used with 1x1 size.
-
AUDIO - Audio size. Used with audio ads. This must be used with 1x1 size.
targetingName
xsd:
string
The name of the CreativeTargeting for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a LineItemCreativeAssociation when associating a Creative with the LineItem .
isAmpOnly
xsd:
boolean
Indicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
