PRODUCT
Follow

This article contains the complete list of fields for HTML5 Single Expandable Banner ads and a sample JSON for this ad type.

HTML5 Single Expandable Banner Ad Fields

Field

Data Type

Limitations

Description

type String (AdType Enum) Mandatory Object type data
id Long Mandatory, Unchangeable ID of the ad
createdBy Long Unchangeable ID of the user who created the ad
createdByName String Unchangeable Name of the user who created the ad
createdByAccount Long Unchangeable ID of the account of the user who created the ad
createdByAccountName String Unchangeable Name of the account of the user who created the ad
createdOn Long Unchangeable Date & time on which the ad was created (Date epoch)
lastUpdatedBy Long Read-only ID of the user who last updated the ad
lastUpdatedByName String Read-only Name of the user who last updated the ad
lastUpdatedByAccount Long Read-only ID of the account of the user who last updated the ad
lastUpdatedByAccountName String Read-only Name of the account of the user who last updated the ad
lastUpdatedOn Long Read-only Date & time on which the ad was last updated (Date epoch)
name String Mandatory Name of the ad
masterAdId Long Unchangeable In case of a placement ad, id of the master ad it originated from, empty otherwise
changed Boolean Unchangeable In case of a placement ad, Indicates whether the ad was changed since was created from its matser ad
adStatus String (AdStatus Enum) Mandatory, Unchangeable Status of the ad
enabled Boolean Unchangeable Indicates whther the ad is enabled or disabled (for serving purposes)
adFormat String (AdFormat Enum) Optional The base ad format of the ad - in case of CAF
adFormatId Long Mandatory, Unchangeable ID of the ad format (AdFormat Enum)
adFormatName String Read-only Name of the ad format, for example 'HTML5 Expandable Ad'
accountId Long Mandatory, Unchangeable ID of the account of the user who created the ad
accountName String Read-only Name of the account of the user who created the ad
placementId Long Unchangeable ID of the placement the ad is attached to - placement ad only
placementName String Read-only Name of the placement the ad is attached to - placement ad only
siteId Long Unchangable ID of the site of the placement the ad is attached to - placement ad only
siteName String Read-only Name of the site of the placement the ad is attached to - placement ad only
adAssignmentData Object (AdAssignmentData Class) Unchangeable Assignment data of the ad, for example campaign or brand
mainClickthrough Object (MainClickthrough Class) Optional Main click-through that will be fired when clicking on the ad
adURLs Array of Objects (ThirdPartyURL Class) Optional List of all ad 3rd party tracking URLs
pricingSize Long Read-only Size of the ad (in KB) calculated for billing purposes
overallSize Long Read-only Size of the ad (in KB) including all of its assets
initialSize Long Read-only Size of the ad (in KB) calculted by the asset that is loaded initially
width Long Read-only Width of the ad
height Long Read-only Height of the ad
dimensions String Read-only String representaion of the dimensions as width X height
templateScriptName String (TemplateScriptName Enum)   Maps to the correct base AdConfig.js file
urlTokens String Read-only  
minAudioVersion Double    
fourthPartyTag String    
adChoicesStatus Boolean Optional Controls if the ad choices icon is shown
adChoicesLocation String (AdChoicesLocation Enum) Optional Controls the relative location of the ad choices icon on the ad
qaStatus String (AdQAStatus Enum) Optional Indicates the status of the ad qa review process
numberOfPlcementAds Integer Read-only Number of placements ad the master ad has (Only the ones visible to the user)
overallNumberOfPlacdementAds Integer Read-only Number of placements ad the master ad has (All)
servingMethod String (ServingMethod Enum) Read-only Describes the type of serving method used to display the ad
analyticsData Object (AdAnalyticsData Class)   Provides ad analytics statistics on the ad
analyticsSettings      
customFields Object (CustomFields Class) Optional Custom fields values on entity level; each field must have a metadata definition on parent account.
massVersioning Boolean Optional Indicates if the ad is a mass versioned ad
usedAsTemplate Boolean Unchangeable Indicates if this ad is used as part of an ad template
unSavedTemplateAd Boolean Unchangeable Indicates if the ad was created from HTML5 factory from an ad template but was not actually saved yet
adTemplateId Long Unchangeable ID of the ad template the originated from 
feedEnabled Boolean   Indicates if the smart version ad supports feed
feedStatus String (FeedTransactionStatus Enum)   Staus of the mass versioning feed
defaultImage Object (AdAsset Class) Mandatory Ad's default image
defaultImageClickthrough Object (Clickthrough Class) Optional The url navigated to when click on the default image
additionalAssets Array of Object (AdAdditionalAsset Class) Optional List of additional assets used by the ad
customInteractions Array of Object (AdCustomInteraction Base Class)
Derived Classes:
AdTimerInteraction,
AdClickthroughInteraction,
AdUserActionInteraction, AdAutomaticEventInteraction)
Optional List of custom interaction defined on the ad and its assets
adTranscodingStatus String (AdTranscodingStatus Enum) Unchangeable Indicates the status of the auto-transcoding process of the ad
performAutoVideoTranscoding Boolean Optional Whether to perform auto transcoding on the ad's video assets
variables Array of Object (Variable Class) Optional List of ad variables
downloadMode String (DownloadMode Enum) Required Control whether to wait to full ad load before starting video
initialLoadAsset String (InitialLoadAsset Enum) Mandatory if 'downloadMode' is 'POLITE' Asset to be displayed initially
html5 Object (AdAssetFolder Class) Required Workspace used in the ad.
createdByHTML5Factory Boolean Unchangeable Indicates whether the ad was created using the HTML5 Ad Builder
allowHTML5DynamicExpansion Boolean   Indicates if the ad supports dynamic expansion of panel
adSmartVersionSchema Object (AdSmartVersionSchema Class)   Dynamic element of the mass vesioned ad
disableIncomplete Boolean    
enableRetargeting Boolean   Enable/Disable retargeting for mass versioned ad
rotationType String (RotationType Enum)  

Determines the rotation methods by which to serve the versions.

versionTargetingType String (VersionTargetingType Enum)   Targeting type of the version
versionBasePath String   Path to version JSON file
advancedRetargeting Object (AdvancedRetargeting Class)   Contains retargeting data for a mass versioned ad
panels Object (Panel Class) Optional List of the ad's panels that would be expanded.
panelsSettings Object (PanelsSettings Class)
Derived Classes:
BasePanelsSettings,
PanelsSettings,
ExtendedPanelsSettings
Optional Settings related to the panels

JSON Example

{
"type":"HTML5SingleExpandableBannerAd",
"id":<Auto Generated ID>,
"clientRefId":null,
"version":8369784646084376,
"createdBy":<Auto Generated ID>,
"createdByName":"<Auto Generated ID>",
"createdByAccount":<Auto Generated ID>,
"createdByAccountName":"<Auto Generated ID>",
"createdOn":1450695453894,
"lastUpdatedBy":<Auto Generated ID>,
"lastUpdatedByName":"<Auto Generated ID>",
"lastUpdatedByAccount":<Auto Generated ID>,
"lastUpdatedByAccountName":"<Auto Generated ID>",
"lastUpdateOn":1450695727270,
"name":"<Auto Generated ID>",
"masterAdId":<Auto Generated ID>,
"changed":false,
"adStatus":"NEW",
"enabled":true,
"adFormat":"HTML5_SINGLE_EXPANDABLE_BANNER_AD",
"adFormatId":39,
"adFormatName":"HTML5 Single Expandable Banner",
"accountId":<Auto Generated ID>,
"accountName":"<Auto Generated ID>",
"placementId":null,
"placementName":null,
"siteId":null,
"siteName":null,
"adAssignmentData":{
"type":"AdAssignmentData",
"accountId":null,
"accountName":"",
"advertiserId":null,
"advertiserName":"",
"brandId":null,
"brandName":"",
"campaignId":null,
"campaignName":""
},
"mainClickthrough":{
"type":"MainClickthrough",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"url":"<Auto Generated ID>",
"targetWindowType":"NEW",
"showAddressBar":true,
"showMenuBar":true,
"closeAllAdParts":false
},
"adURLs":null,
"pricingSize":26743,
"overallSize":26743,
"initialSize":26743,
"width":300,
"height":50,
"dimensions":"300x50",
"templateScriptName":"Html5SEBanner",
"urlTokens":null,
"minAudioVersion":0.0,
"fourthPartyTag":"",
"adChoicesStatus":false,
"adChoicesLocation":"TOP_RIGHT",
"qaStatus":"NOT_SUBMITTED",
"numberOfPlacementAds":0,
"overallNumberOfPlacementAds":0,
"servingMethod":null,
"analyticsData":null,
"analyticsSettings":null,
"customFields":null,
"massVersioning":false,
"usedAsTemplate":false,
"unSavedTemplateAd":false,
"adTemplateId":null,
"feedEnabled":null,
"feedStatus":null,
"defaultImage":{
"type":"AdAsset",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"assetId":<Auto Generated ID>,
"assetName":"<Auto Generated ID>",
"source":true,
"assetStatus":null,
"folderId":<Auto Generated ID>,
"size":4043,
"duration":0,
"bitRate":0,
"width":300,
"height":50,
"mimeType":"image/jpeg",
"mediaType":"IMAGE",
"thumbnailUrl":"<Auto Generated ID>"
},
"defaultImageClickthrough":{
"type":"MainClickthrough",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"url":"",
"targetWindowType":"NEW",
"showAddressBar":true,
"showMenuBar":true,
"closeAllAdParts":false
},
"additionalAssets":null,
"customInteractions":[
{
"type":"AdUserActionInteraction",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"assetId":null,
"name":"<Auto Generated ID>",
"reportingName":"<Auto Generated ID>",
"assetName":"<Auto Generated ID>",
"closeAdParts":false,
"redirectURL":"",
"includeInInteractionRate":true
}
],
"performAutoVideoTranscoding":false,
"adTranscodingStatus":"TRANSCODING_NOT_REQUIRED",
"variables":null,
"downloadMode":"POLITE",
"html5":{
"type":"AdAssetFolder",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"assetId":<Auto Generated ID>,
"assetName":"<Auto Generated ID>",
"source":true,
"assetStatus":null,
"folderId":null,
"size":26743,
"duration":null,
"bitRate":null,
"width":0,
"height":0,
"mimeType":null,
"mediaType":null,
"thumbnailUrl":null,
"assets":null
},
"createdByHTML5Factory":false,
"allowHTML5DynamicExpansion":false,
"adSmartVersionSchema":{
"type":"APIAdSmartVersionSchema",
"smartElements":[
]
},
"disableIncomplete":false,
"enableRetargeting":false,
"rotationType":"EvenDistribution",
"versionTargetingType":"TargetAudience",
"versionBasePath":"",
"initialLoadAsset":"DEFAULT_IMAGE",
"advancedRetargeting":null,
"panels":[
{
"type":"Panel",
"id":<Auto Generated ID>,
"clientRefId":null,
"relationsBag":null,
"uiPermissions":null,
"version":null,
"assetId":<Auto Generated ID>,
"assetName":"<Auto Generated ID>",
"source":true,
"assetStatus":"FAILED_INGEST",
"folderId":<Auto Generated ID>,
"size":1015,
"duration":0,
"bitRate":0,
"width":0,
"height":0,
"mimeType":"text/html",
"mediaType":"HTML",
"thumbnailUrl":"",
"name":"Panel",
"defaultPanel":true,
"positionX":0.0,
"positionY":0.0,
"positionType":"BANNER_RELATIVE",
"autoExpand":false,
"delayedExpansion":false,
"retraction":"NEVER",
"transparent":false,
"autoGeneratedPanel":true
}
],
"panelsSettings":{
"type":"BasePanelsSettings",
"panelFrequency":"UNLIMITED",
"panelFrequencyTimes":1,
"multiplePanels":true,
"autoExpandDefaultPanel":false,
"expandedPanelWidth":300,
"expandedPanelHeight":500,
"panelPixelOffsetsX":0,
"panelPixelOffsetsY":100
}
}
 
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk