PRODUCT
Follow

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

Standard 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 The 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, Unchangable 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 Unchangeable 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 iif 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 URL navigated to when click on the default image
banner Object (AdAsset Class) Optional The ad's banner
minFlashVersion Double Read-only Minimum flash version required to play the ad
mxpVersion String Read-only  
osVersion String Read-only  
asVersion String Read-only Minimum ActionScript version required to play the ad
flashIDE String Read-only  
variables Array of Object (Variable Class) Optional List of ad variables
html5 Object (AdAssetFolder Class) Optional Workspace used in the ad
createdByHTML5Factory Boolean Unchangable Indicates whether the ad was created using the HTML5 Ad Builder
downloadMode String (DownloadMode Enum) Optional (Mandatory if HTML5 was selected) 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
rotationType String (RotationType Enum)   Determines the rotation methods by which to serve the versions.
adSmartVersionSchema Object (AdSmartVersionSchema Class)   Dynamic element of the mass vesioned ad
versionTargetingType String (VersionTargetingType Enum)   Targeting type of the version
versionBasePath String   Path to version JSON file
disableIncomplete Boolean   0
enableRetargeting Boolean   Enable/Disable retargeting for mass versioned ad
advancedRetargeting Object (AdvancedRetargeting Class)   Conatins retargeting data for a mass versioned ad

JSON Example

{
"type":"StandardBannerAd",
"id":<Auto Generated ID>,
"clientRefId":"<Auto Generated ID>",
"relationsBag":null,
"version":<Auto Generated ID>,
"createdBy":<Auto Generated ID>,
"createdByName":"<Auto Generated ID>",
"createdByAccount":<Auto Generated ID>,
"createdByAccountName":"<Auto Generated ID>",
"createdOn":<Auto Generated ID>,
"lastUpdatedBy":<Auto Generated ID>,
"lastUpdatedByName":"<Auto Generated ID>",
"lastUpdatedByAccount":<Auto Generated ID>,
"lastUpdatedByAccountName":"<Auto Generated ID>",
"lastUpdateOn":<Auto Generated ID>,
"name":"<Auto Generated ID>",
"masterAdId":<Auto Generated ID>,
"changed":false,
"adStatus":"ATTACHED",
"enabled":true,
"adFormat":"STANDARD_BANNER_AD",
"adFormatId":<Auto Generated ID>,
"adFormatName":"Standard Banner",
"accountId":<Auto Generated ID>,
"accountName":"<Auto Generated ID>",
"placementId":null,
"placementName":null,
"siteId":null,
"siteName":null,
"adAssignmentData":{
"type":"AdAssignmentData",
"accountId":<Auto Generated ID>,
"accountName":"<Auto Generated ID>",
"advertiserId":<Auto Generated ID>,
"advertiserName":"<Auto Generated ID>",
"brandId":<Auto Generated ID>,
"brandName":"<Auto Generated ID>",
"campaignId":<Auto Generated ID>,
"campaignName":"<Auto Generated ID>"
},
"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":<Auto Generated ID>,
"overallSize":<Auto Generated ID>,
"initialSize":<Auto Generated ID>,
"width":320,
"height":50,
"dimensions":"320x50",
"templateScriptName":"<Auto Generated ID>",
"urlTokens":null,
"minAudioVersion":0.0,
"fourthPartyTag":"<Auto Generated ID>",
"adChoicesStatus":false,
"adChoicesLocation":null,
"qaStatus":"NOT_SUBMITTED",
"numberOfPlacementAds":<Auto Generated ID>,
"overallNumberOfPlacementAds":<Auto Generated ID>,
"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":4096,
"duration":0,
"bitRate":0,
"width":320,
"height":50,
"mimeType":"",
"mediaType":"IMAGE",
"thumbnailUrl":"<Auto Generated ID>"
},
"defaultImageClickthrough":{
"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
},
"banner":null,
"minFlashVersion":0.0,
"mxpVersion":null,
"osVersion":null,
"asVersion":null,
"flashIDE":null,
"variables":null,
"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":<Auto Generated ID>,
"duration":null,
"bitRate":null,
"width":0,
"height":0,
"mimeType":null,
"mediaType":null,
"thumbnailUrl":null,
"assets":null
},
"tooltip":"<Auto Generated ID>",
"createdByHTML5Factory":false,
"downloadMode":"INSTANT",
"initialLoadAsset":"PRELOAD_IMAGE",
"adSmartVersionSchema":{
"type":"APIAdSmartVersionSchema",
"smartElements":[
]
},
"disableIncomplete":false,
"enableRetargeting":false,
"rotationType":"EvenDistribution",
"versionTargetingType":"TargetAudience",
"versionBasePath":"<Auto Generated ID>",
"advancedRetargeting":null
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk