Resource: Creative
Contains properties of a Creative.
JSON representation |
---|
{ "id": string, "name": string, "renderingId": string, "advertiserId": string, "accountId": string, "subaccountId": string, "active": boolean, "archived": boolean, "version": integer, "size": { object ( |
Fields | |
---|---|
id |
ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. |
name |
Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. |
renderingId |
ID of current rendering version. This is a read-only field. Applicable to all creative types. |
advertiserId |
Advertiser ID of this creative. This is a required field. Applicable to all creative types. |
accountId |
Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. |
subaccountId |
Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. |
active |
Whether the creative is active. Applicable to all creative types. |
archived |
Whether the creative is archived. Applicable to all creative types. |
version |
The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. |
size |
Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for
,
creatives, and for
creatives with a primary asset of type
, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types:
,
,
,
,
, and all
. |
creativeFieldAssignments[] |
Creative field assignments for this creative. Applicable to all creative types. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
lastModifiedInfo |
Creative last modification information. This is a read-only field. Applicable to all creative types. |
sslCompliant |
Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. |
compatibility[] |
Compatibilities associated with this creative. This is a read-only field.
and
refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively.
and
are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned
or
instead.
refers to rendering in in-stream video ads developed with the VAST standard.
refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types.
|
type |
Type of this creative. This is a required field. Applicable to all creative types.
,
, and
are only used for existing creatives. New creatives should use
as a replacement for these types. |
creativeAssets[] |
Assets associated with a creative. Applicable to all but the following creative types:
,
, and
|
redirectUrl |
URL of hosted image or hosted video or another ad tag. For
creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types:
,
,
, and
|
htmlCode |
HTML code for the creative. This is a required field when applicable. This field is ignored if
is true. Applicable to the following creative types: all
,
, and
, and all
. |
htmlCodeLocked |
Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to
. Applicable to the following creative types:
and
. |
backgroundColor |
The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types:
. |
allowScriptAccess |
Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types:
. |
fsCommand |
OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if
field is true. Applicable to the following creative types:
. |
backupImageTargetWindow |
Target window for backup image. Applicable to the following creative types:
and
. Applicable to
when the primary asset type is not
. |
clickTags[] |
Click tags of the creative. For
,
, and
creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the
. When inserting the creative, populate the creative
field using the
field. For
creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the
field with the
field. Applicable to the following creative types:
,
,
. Applicable to
when the primary asset type is not
. |
backupImageFeatures[] |
accountPermissionGroups.list of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the
' detected features. Applicable to the following creative types:
. Applicable to
when the primary asset type is not
. |
authoringTool |
Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types:
. |
requiredFlashPluginVersion |
The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all
, and all
. |
adTagKeys[] |
Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all
, and all
. |
customKeyValues[] |
Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all
, and all
. |
counterCustomEvents[] |
accountPermissionGroups.list of counter events configured for the creative. For
creatives, these are read-only and auto-generated from
. Applicable to the following creative types:
, all
, and all
. |
exitCustomEvents[] |
accountPermissionGroups.list of exit events configured for the creative. For
and
creatives, these are read-only and auto-generated from
, For
, an event is also created from the
. Applicable to the following creative types:
, all
, and all
. Applicable to
when the primary asset type is not
. |
timerCustomEvents[] |
accountPermissionGroups.list of timer events configured for the creative. For
creatives, these are read-only and auto-generated from
. Applicable to the following creative types:
, all
, and all
. Applicable to
when the primary asset is not
. |
artworkType |
Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all
, and all
. |
requiredFlashVersion |
The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types:
all
, and all
. Applicable to
when the primary asset type is not
. |
thirdPartyBackupImageImpressionsUrl |
Third-party URL used to record backup image impressions. Applicable to the following creative types: all
. |
thirdPartyRichMediaImpressionsUrl |
Third-party URL used to record rich media impressions. Applicable to the following creative types: all
. |
totalFileSize |
Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all
, and all
. |
mediaDuration |
Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types:
,
, all
, and all
. |
commercialId |
Industry standard ID assigned to creative for reach and frequency. Applicable to
creatives. |
companionCreatives[] |
accountPermissionGroups.list of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all
, all
and all
with
set to false. |
mediaDescription |
Description of the audio or video ad. Applicable to the following creative types: all
,
, and all
. |
skippable |
Whether the user can choose to skip the creative. Applicable to the following creative types: all
and all
. |
thirdPartyUrls[] |
Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all
, all
, and all
. |
adParameters |
Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all
. |
overrideCss |
Override CSS value for rich media creatives. Applicable to the following creative types: all
. |
studioCreativeId |
Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all
, and all
. |
studioTraffickedCreativeId |
Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all
, and all
. |
latestTraffickedCreativeId |
Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all
, and all
. |
studioAdvertiserId |
Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all
, and all
. |
autoAdvanceImages |
Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types:
. |
backupImageReportingLabel |
Reporting label used for HTML5 banner backup image. Applicable to the following creative types:
when the primary asset type is not
. |
convertFlashToHtml5 |
Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type:
. Applicable to
when the primary asset type is not
. |
idDimensionValue |
Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. |
renderingIdDimensionValue |
Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. |
sslOverride |
Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. |
skipOffset |
Amount of time to play the video before the skip button appears. Applicable to the following creative types: all
. |
progressOffset |
Amount of time to play the video before counting a view. Applicable to the following creative types: all
. |
obaIcon |
Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all
. |
authoringSource |
Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. |
dynamicAssetSelection |
Set this to true to enable the use of rules to target individual assets in this creative. When set to true
must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to
creatives. |
creativeAssetSelection |
Required if
is true. |
universalAdId |
A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types:
and
and
. |
backupImageClickThroughUrl |
Click-through URL for backup image. Applicable to
when the primary asset type is not
. |
additionalSizes[] |
Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to
creatives when the primary asset type is
. |
CreativeFieldAssignment
Creative Field Assignment.
JSON representation |
---|
{ "creativeFieldId": string, "creativeFieldValueId": string } |
Fields | |
---|---|
creativeFieldId |
ID of the creative field. |
creativeFieldValueId |
ID of the creative field value. |
Compatibility
Enums | |
---|---|
DISPLAY |
|
DISPLAY_INTERSTITIAL |
|
APP |
|
APP_INTERSTITIAL |
|
IN_STREAM_VIDEO |
|
IN_STREAM_AUDIO |
Type
Enums | |
---|---|
IMAGE |
|
DISPLAY_REDIRECT |
|
CUSTOM_DISPLAY |
|
INTERNAL_REDIRECT |
|
CUSTOM_DISPLAY_INTERSTITIAL |
|
INTERSTITIAL_INTERNAL_REDIRECT |
|
TRACKING_TEXT |
|
RICH_MEDIA_DISPLAY_BANNER |
|
RICH_MEDIA_INPAGE_FLOATING |
|
RICH_MEDIA_IM_EXPAND |
|
RICH_MEDIA_DISPLAY_EXPANDING |
|
RICH_MEDIA_DISPLAY_INTERSTITIAL |
|
RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL |
|
RICH_MEDIA_MOBILE_IN_APP |
|
FLASH_INPAGE |
|
INSTREAM_VIDEO |
|
VPAID_LINEAR_VIDEO |
|
VPAID_NON_LINEAR_VIDEO |
|
INSTREAM_VIDEO_REDIRECT |
|
RICH_MEDIA_PEEL_DOWN |
|
HTML5_BANNER |
|
DISPLAY |
|
DISPLAY_IMAGE_GALLERY |
|
BRAND_SAFE_DEFAULT_INSTREAM_VIDEO |
|
INSTREAM_AUDIO |
CreativeAsset
Creative Asset.
JSON representation |
---|
{ "id": string, "assetIdentifier": { object ( |
Fields | |
---|---|
id |
Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all
and
. |
assetIdentifier |
Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all
and
. |
sslCompliant |
Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all
and
. |
size |
Size associated with this creative asset. This is a required field when applicable; however for
and
, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types:
,
,
,
, and all
. Applicable to
when the primary asset type is not
. |
fileSize |
File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all
and
. |
flashVersion |
Flash version of the asset. This is a read-only field. Applicable to the following creative types:
, all
, and all
. Applicable to
when the primary asset type is not
. |
actionScript3 |
Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type:
. Applicable to
when the primary asset type is not
. |
zipFilename |
File name of zip file. This is a read-only field. Applicable to the following creative types:
. |
zipFilesize |
Size of zip file. This is a read-only field. Applicable to the following creative types:
. |
detectedFeatures[] |
accountPermissionGroups.list of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types:
. Applicable to
when the primary asset type is not
. |
displayType |
Type of rich media asset. This is a read-only field. Applicable to the following creative types: all
. |
artworkType |
Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all
. |
collapsedSize |
Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all
and all
. Additionally, applicable to assets whose
is
or
. |
offset |
Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all
and all
. Additionally, only applicable to assets whose
is
or
. |
zIndex |
zIndex value of an asset. Applicable to the following creative types: all
.Additionally, only applicable to assets whose
is NOT one of the following types:
or
. Acceptable values are
to
, inclusive. |
windowMode |
Window mode options for flash assets. Applicable to the following creative types:
,
,
,
, and
. |
transparency |
Whether the asset is transparent. Applicable to the following creative types: all
. Additionally, only applicable to
assets. |
pushdown |
Whether the asset pushes down other content. Applicable to the following creative types: all
. Additionally, only applicable when the asset offsets are 0, the
matches
, and the
is less than
. |
pushdownDuration |
Pushdown duration in seconds for an asset. Applicable to the following creative types: all
.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the
matches
, and the
is less than
. Acceptable values are
to
, inclusive. |
position |
Offset position for an asset. Applicable to the following creative types: all
. |
positionTopUnit |
Offset top unit for an asset. This is a read-only field if the asset
is
. Applicable to the following creative types: all
. |
positionLeftUnit |
Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all
. |
verticallyLocked |
Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all
. |
horizontallyLocked |
Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all
. |
startTimeType |
Initial wait time type before making the asset visible. Applicable to the following creative types: all
. |
customStartTimeValue |
Custom start time in seconds for making the asset visible. Applicable to the following creative types: all
. Value must be greater than or equal to
. |
durationType |
Duration type for which an asset will be displayed. Applicable to the following creative types: all
. |
duration |
Duration in seconds for which an asset will be displayed. Applicable to the following creative types:
,
and
. Value must be greater than or equal to
. |
hideFlashObjects |
Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all
. |
hideSelectionBoxes |
Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all
. |
alignment |
Possible alignments for an asset. This is a read-only field. Applicable to the following creative types:
. |
childAssetType |
Rich media child asset type. This is a read-only field. Applicable to the following creative types: all
. |
originalBackup |
Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all
. |
bitRate |
Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types:
,
and all
. |
mimeType |
Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types:
,
and all
. |
active |
Whether the video or audio asset is active. This is a read-only field for
assets. Applicable to the following creative types:
,
and all
. |
progressiveServingUrl |
Progressive URL for video asset. This is a read-only field. Applicable to the following creative types:
and all
. |
streamingServingUrl |
Streaming URL for video asset. This is a read-only field. Applicable to the following creative types:
and all
. |
mediaDuration |
Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types:
,
and all
. |
expandedDimension |
Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types:
and all
. |
role |
Role of the asset in relation to creative. Applicable to all but the following creative types: all
and
. This is a required field.
applies to
,
,
,
,
, all
(which may contain multiple primary assets), and all
creatives.
applies to
,
,
, and all
creatives. Applicable to
when the primary asset type is not
.
and
apply to
creatives.
refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all
and all
creatives.
refers to videos uploaded by the user in Campaign Manager and is applicable to
and
creatives.
refers to videos transcoded by Campaign Manager from
assets and is applicable to
and
creatives.
refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to
creatives. These cannot be added or removed within Campaign Manager. For
creatives,
,
and
assets that are marked
serve as backup in case the
creative cannot be served. Only
assets can be added or removed for an
or
creative.
refers to audios uploaded by the user in Campaign Manager and is applicable to
creatives.
refers to audios transcoded by Campaign Manager from
assets and is applicable to
creatives. |
backupImageExit |
Exit event configured for the backup image. Applicable to the following creative types: all
. |
companionCreativeIds[] |
accountPermissionGroups.list of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to
creative type with
set to true. |
idDimensionValue |
Dimension value for the ID of the asset. This is a read-only, auto-generated field. |
orientation |
Orientation of video asset. This is a read-only, auto-generated field. |
additionalSizes[] |
Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. |
audioBitRate |
Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types:
,
and all
. |
audioSampleRate |
Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types:
,
and all
. |
frameRate |
Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types:
and all
. |
politeLoad |
Whether this asset is used as a polite load asset. |
CreativeAssetId
Creative Asset ID.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of asset to upload. This is a required field.
and
are no longer supported for new uploads. All image assets should use
. |
name |
Name of the creative asset. This is a required field while inserting an asset. After insertion, this
is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: "
". Spaces are allowed. |
Type
Enums | |
---|---|
IMAGE |
|
FLASH |
|
VIDEO |
|
HTML |
|
HTML_IMAGE |
|
AUDIO |
DetectedFeatures
Enums | |
---|---|
CSS_FONT_FACE |
|
CSS_BACKGROUND_SIZE |
|
CSS_BORDER_IMAGE |
|
CSS_BORDER_RADIUS |
|
CSS_BOX_SHADOW |
|
CSS_FLEX_BOX |
|
CSS_HSLA |
|
CSS_MULTIPLE_BGS |
|
CSS_OPACITY |
|
CSS_RGBA |
|
CSS_TEXT_SHADOW |
|
CSS_ANIMATIONS |
|
CSS_COLUMNS |
|
CSS_GENERATED_CONTENT |
|
CSS_GRADIENTS |
|
CSS_REFLECTIONS |
|
CSS_TRANSFORMS |
|
CSS_TRANSFORMS3D |
|
CSS_TRANSITIONS |
|
APPLICATION_CACHE |
|
CANVAS |
|
CANVAS_TEXT |
|
DRAG_AND_DROP |
|
HASH_CHANGE |
|
HISTORY |
|
AUDIO |
|
VIDEO |
|
INDEXED_DB |
|
INPUT_ATTR_AUTOCOMPLETE |
|
INPUT_ATTR_AUTOFOCUS |
|
INPUT_ATTR_LIST |
|
INPUT_ATTR_PLACEHOLDER |
|
INPUT_ATTR_MAX |
|
INPUT_ATTR_MIN |
|
INPUT_ATTR_MULTIPLE |
|
INPUT_ATTR_PATTERN |
|
INPUT_ATTR_REQUIRED |
|
INPUT_ATTR_STEP |
|
INPUT_TYPE_SEARCH |
|
INPUT_TYPE_TEL |
|
INPUT_TYPE_URL |
|
INPUT_TYPE_EMAIL |
|
INPUT_TYPE_DATETIME |
|
INPUT_TYPE_DATE |
|
INPUT_TYPE_MONTH |
|
INPUT_TYPE_WEEK |
|
INPUT_TYPE_TIME |
|
INPUT_TYPE_DATETIME_LOCAL |
|
INPUT_TYPE_NUMBER |
|
INPUT_TYPE_RANGE |
|
INPUT_TYPE_COLOR |
|
LOCAL_STORAGE |
|
POST_MESSAGE |
|
SESSION_STORAGE |
|
WEB_SOCKETS |
|
WEB_SQL_DATABASE |
|
WEB_WORKERS |
|
GEO_LOCATION |
|
INLINE_SVG |
|
SMIL |
|
SVG_HREF |
|
SVG_CLIP_PATHS |
|
TOUCH |
|
WEBGL |
|
SVG_FILTERS |
|
SVG_FE_IMAGE |
DisplayType
Enums | |
---|---|
ASSET_DISPLAY_TYPE_INPAGE |
|
ASSET_DISPLAY_TYPE_FLOATING |
|
ASSET_DISPLAY_TYPE_OVERLAY |
|
ASSET_DISPLAY_TYPE_EXPANDING |
|
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH |
|
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING |
|
ASSET_DISPLAY_TYPE_PEEL_DOWN |
|
ASSET_DISPLAY_TYPE_VPAID_LINEAR |
|
ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR |
|
ASSET_DISPLAY_TYPE_BACKDROP |
ArtworkType
Enums | |
---|---|
ARTWORK_TYPE_FLASH |
|
ARTWORK_TYPE_HTML5 |
|
ARTWORK_TYPE_MIXED |
|
ARTWORK_TYPE_IMAGE |
OffsetPosition
Offset Position.
JSON representation |
---|
{ "top": integer, "left": integer } |
Fields | |
---|---|
top |
Offset distance from top side of an asset or a window. |
left |
Offset distance from left side of an asset or a window. |
WindowMode
Enums | |
---|---|
OPAQUE |
|
WINDOW |
|
TRANSPARENT |
PositionTopUnit
Enums | |
---|---|
OFFSET_UNIT_PIXEL |
|
OFFSET_UNIT_PERCENT |
|
OFFSET_UNIT_PIXEL_FROM_CENTER |
PositionLeftUnit
Enums | |
---|---|
OFFSET_UNIT_PIXEL |
|
OFFSET_UNIT_PERCENT |
|
OFFSET_UNIT_PIXEL_FROM_CENTER |
StartTimeType
Enums | |
---|---|
ASSET_START_TIME_TYPE_NONE |
|
ASSET_START_TIME_TYPE_CUSTOM |
DurationType
Enums | |
---|---|
ASSET_DURATION_TYPE_AUTO |
|
ASSET_DURATION_TYPE_NONE |
|
ASSET_DURATION_TYPE_CUSTOM |
Alignment
Enums | |
---|---|
ALIGNMENT_TOP |
|
ALIGNMENT_RIGHT |
|
ALIGNMENT_BOTTOM |
|
ALIGNMENT_LEFT |
ChildAssetType
Enums | |
---|---|
CHILD_ASSET_TYPE_FLASH |
|
CHILD_ASSET_TYPE_VIDEO |
|
CHILD_ASSET_TYPE_IMAGE |
|
CHILD_ASSET_TYPE_DATA |
Role
Enums | |
---|---|
PRIMARY |
|
BACKUP_IMAGE |
|
ADDITIONAL_IMAGE |
|
ADDITIONAL_FLASH |
|
PARENT_VIDEO |
|
TRANSCODED_VIDEO |
|
OTHER |
|
ALTERNATE_VIDEO |
|
PARENT_AUDIO |
|
TRANSCODED_AUDIO |
CreativeCustomEvent
Creative Custom Event.
JSON representation |
---|
{ "artworkLabel": string, "id": string, "videoReportingId": string, "artworkType": enum ( |
Fields | |
---|---|
artworkLabel |
Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. |
id |
ID of this event. This is a required field and should not be modified after insertion. |
videoReportingId |
Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. |
artworkType |
Artwork type used by the creative.This is a read-only field. |
advertiserCustomEventName |
User-entered name for the event. |
targetType |
Target type used by the event. |
advertiserCustomEventType |
Type of the event. This is a read-only field. |
popupWindowProperties |
Properties for rich media popup windows. This field is used only for exit events. |
advertiserCustomEventId |
Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. |
exitClickThroughUrl |
Exit click-through URL for the event. This field is used only for exit events. |
ArtworkType
Enums | |
---|---|
ARTWORK_TYPE_FLASH |
|
ARTWORK_TYPE_HTML5 |
|
ARTWORK_TYPE_MIXED |
|
ARTWORK_TYPE_IMAGE |
TargetType
Enums | |
---|---|
TARGET_BLANK |
|
TARGET_TOP |
|
TARGET_SELF |
|
TARGET_PARENT |
|
TARGET_POPUP |
AdvertiserCustomEventType
Enums | |
---|---|
ADVERTISER_EVENT_TIMER |
|
ADVERTISER_EVENT_EXIT |
|
ADVERTISER_EVENT_COUNTER |
PopupWindowProperties
Popup Window Properties.
JSON representation |
---|
{ "offset": { object ( |
Fields | |
---|---|
offset |
Upper-left corner coordinates of the popup window. Applicable if
is
. |
showScrollBar |
Whether to display the browser scroll bar. |
showToolBar |
Whether to display the browser tool bar. |
showMenuBar |
Whether to display the browser menu bar. |
showAddressBar |
Whether to display the browser address bar. |
showStatusBar |
Whether to display the browser status bar. |
positionType |
Popup window position either centered or at specific coordinate. |
dimension |
Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all
and all
|
title |
Title of popup window. |
PositionType
Enums | |
---|---|
CENTER |
|
COORDINATES |
CreativeClickThroughUrl
Click-through URL
JSON representation |
---|
{ "landingPageId": string, "customClickThroughUrl": string, "computedClickThroughUrl": string } |
Fields | |
---|---|
landingPageId |
ID of the landing page for the click-through URL. |
customClickThroughUrl |
Custom click-through URL. Applicable if the
field is left unset. |
computedClickThroughUrl |
Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
Orientation
Enums | |
---|---|
LANDSCAPE |
|
PORTRAIT |
|
SQUARE |
FsCommand
FsCommand.
JSON representation |
---|
{
"positionOption": enum ( |
Fields | |
---|---|
positionOption |
Position in the browser where the window will open. |
top |
Distance from the top of the browser. Applicable when positionOption is
. |
left |
Distance from the left of the browser.Applicable when positionOption is
. |
windowWidth |
Width of the window. |
windowHeight |
Height of the window. |
PositionOption
Enums | |
---|---|
CENTERED |
|
DISTANCE_FROM_TOP_LEFT_CORNER |
TargetWindow
Target Window.
JSON representation |
---|
{
"targetWindowOption": enum ( |
Fields | |
---|---|
targetWindowOption |
Type of browser window for which the backup image of the flash creative can be displayed. |
customHtml |
User-entered value. |
TargetWindowOption
Enums | |
---|---|
NEW_WINDOW |
|
CURRENT_WINDOW |
|
CUSTOM |
ClickTag
Creative Click Tag.
JSON representation |
---|
{
"name": string,
"eventName": string,
"clickThroughUrl": {
object ( |
Fields | |
---|---|
name |
Parameter name for the specified click tag. For
creative assets, this field must match the value of the creative asset's
field. |
eventName |
Advertiser event name associated with the click tag. This field is used by
and
creatives. Applicable to
when the primary asset type is not
. |
clickThroughUrl |
Parameter value for the specified click tag. This field contains a click-through url. |
BackupImageFeatures
Enums | |
---|---|
CSS_FONT_FACE |
|
CSS_BACKGROUND_SIZE |
|
CSS_BORDER_IMAGE |
|
CSS_BORDER_RADIUS |
|
CSS_BOX_SHADOW |
|
CSS_FLEX_BOX |
|
CSS_HSLA |
|
CSS_MULTIPLE_BGS |
|
CSS_OPACITY |
|
CSS_RGBA |
|
CSS_TEXT_SHADOW |
|
CSS_ANIMATIONS |
|
CSS_COLUMNS |
|
CSS_GENERATED_CONTENT |
|
CSS_GRADIENTS |
|
CSS_REFLECTIONS |
|
CSS_TRANSFORMS |
|
CSS_TRANSFORMS3D |
|
CSS_TRANSITIONS |
|
APPLICATION_CACHE |
|
CANVAS |
|
CANVAS_TEXT |
|
DRAG_AND_DROP |
|
HASH_CHANGE |
|
HISTORY |
|
AUDIO |
|
VIDEO |
|
INDEXED_DB |
|
INPUT_ATTR_AUTOCOMPLETE |
|
INPUT_ATTR_AUTOFOCUS |
|
INPUT_ATTR_LIST |
|
INPUT_ATTR_PLACEHOLDER |
|
INPUT_ATTR_MAX |
|
INPUT_ATTR_MIN |
|
INPUT_ATTR_MULTIPLE |
|
INPUT_ATTR_PATTERN |
|
INPUT_ATTR_REQUIRED |
|
INPUT_ATTR_STEP |
|
INPUT_TYPE_SEARCH |
|
INPUT_TYPE_TEL |
|
INPUT_TYPE_URL |
|
INPUT_TYPE_EMAIL |
|
INPUT_TYPE_DATETIME |
|
INPUT_TYPE_DATE |
|
INPUT_TYPE_MONTH |
|
INPUT_TYPE_WEEK |
|
INPUT_TYPE_TIME |
|
INPUT_TYPE_DATETIME_LOCAL |
|
INPUT_TYPE_NUMBER |
|
INPUT_TYPE_RANGE |
|
INPUT_TYPE_COLOR |
|
LOCAL_STORAGE |
|
POST_MESSAGE |
|
SESSION_STORAGE |
|
WEB_SOCKETS |
|
WEB_SQL_DATABASE |
|
WEB_WORKERS |
|
GEO_LOCATION |
|
INLINE_SVG |
|
SMIL |
|
SVG_HREF |
|
SVG_CLIP_PATHS |
|
TOUCH |
|
WEBGL |
|
SVG_FILTERS |
|
SVG_FE_IMAGE |
AuthoringTool
Enums | |
---|---|
NINJA |
|
SWIFFY |
ArtworkType
Enums | |
---|---|
ARTWORK_TYPE_FLASH |
|
ARTWORK_TYPE_HTML5 |
|
ARTWORK_TYPE_MIXED |
|
ARTWORK_TYPE_IMAGE |
ThirdPartyTrackingUrl
Third-party Tracking URL.
JSON representation |
---|
{
"thirdPartyUrlType": enum ( |
Fields | |
---|---|
thirdPartyUrlType |
Third-party URL type for in-stream video and in-stream audio creatives. |
url |
URL for the specified third-party URL type. |
ThirdPartyUrlType
Enums | |
---|---|
IMPRESSION |
|
CLICK_TRACKING |
|
VIDEO_START |
|
VIDEO_FIRST_QUARTILE |
|
VIDEO_MIDPOINT |
|
VIDEO_THIRD_QUARTILE |
|
VIDEO_COMPLETE |
|
VIDEO_MUTE |
|
VIDEO_PAUSE |
|
VIDEO_REWIND |
|
VIDEO_FULLSCREEN |
|
VIDEO_STOP |
|
VIDEO_CUSTOM |
|
SURVEY |
|
RICH_MEDIA_IMPRESSION |
|
RICH_MEDIA_RM_IMPRESSION |
|
RICH_MEDIA_BACKUP_IMPRESSION |
|
VIDEO_SKIP |
|
VIDEO_PROGRESS |
AuthoringSource
Enums | |
---|---|
CREATIVE_AUTHORING_SOURCE_DCM |
|
CREATIVE_AUTHORING_SOURCE_DBM |
|
CREATIVE_AUTHORING_SOURCE_STUDIO |
|
CREATIVE_AUTHORING_SOURCE_GWD |
|
CREATIVE_AUTHORING_SOURCE_ACS |
CreativeAssetSelection
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to
INSTREAM_VIDEO
creatives.
JSON representation |
---|
{
"rules": [
{
object ( |
Fields | |
---|---|
rules[] |
Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to
creatives. |
defaultAssetId |
A
. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. |
Rule
A rule associates an asset with a targeting template for asset-level targeting. Applicable to
INSTREAM_VIDEO
creatives.
JSON representation |
---|
{ "name": string, "assetId": string, "targetingTemplateId": string } |
Fields | |
---|---|
name |
A user-friendly name for this rule. This is a required field. |
assetId |
A
. This should refer to one of the parent assets in this creative. This is a required field. |
targetingTemplateId |
A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. |
UniversalAdId
A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types:
INSTREAM_AUDIO
,
INSTREAM_VIDEO
and
VPAID
.
JSON representation |
---|
{
"registry": enum ( |
Fields | |
---|---|
registry |
Registry used for the Ad ID value. |
value |
ID value for this creative. Only alphanumeric characters and the following symbols are valid: "
". Maximum length is 64 characters. Read only when
is
. |
Registry
Enums | |
---|---|
OTHER |
|
AD_ID_OFFICIAL |
|
CLEARCAST |
|
DCM |
Methods |
|
---|---|
|
Gets one creative by ID. |
|
Inserts a new creative. |
|
Retrieves a list of creatives, possibly filtered. |
|
Updates an existing creative. |
|
Updates an existing creative. |