Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements, and tag managers will be disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the adAssetFolder Object

Parent Objects

adAssetFolder Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

assets

Array of asset objects.

adAsset Object

Read-only

assetId

ID of the asset to be used.

Long

Read-only

assetStatus

Status of the asset to be used.

String

Read-only
View values

  • PENDING_INGEST

  • PENDING_TRANSCODING

  • FAILED_INGEST

  • FAILED_TRANSCODING

  • READY

source

Internal.

Boolean

Internal

width

Width of the asset.

Integer

Read-only

height

Height of the asset.

Integer

Read-only

assetName

Name of the asset to be used.

String

Read-only

folderId

ID of the folder in which the asset resides.

Long

Read-only

workspaceFolderId

Not applicable.

Long

Read-only

size

Size (in KB) of the asset.

Long

Read-only

duration

Length of the asset (If applicable).

Long

Read-only

bitRate

Bit rate of the asset (If applicable).

Long

Read-only

mimeType

Label used to identify the type of data.

String

Read-only

mediaType

Media type for the asset.

String

Read-only
View values

  • Image

  • Video

  • JSON

  • Archive

  • Flash

  • HTML/HTML Folder

  • Audio

  • HLS_M308

format

Format of the asset, depending on the mediaType.

String

Read-only

Examples include jpg and mp4.

external

Determines if the asset is external.

Boolean

Internal

thumbnailUrl

URL of the asset thumbnail image.

String

Read-only

Object JSON Example

Example
"html5": {
        "type": "AdAssetFolder",
        "id": 1234567890,
        "relationsBag": null,
        "version": null,
        "assetId": 2345678901,
        "assetName": "HTML5 Full Screen Expandable 320x50_NMMDG (2) (2) (2) (2) (2) (2) (3)",
        "source": true,
        "assetStatus": null,
        "folderId": null,
        "workspaceFolderId": null,
        "size": 23075,
        "duration": null,
        "bitRate": null,
        "width": 0,
        "height": 0,
        "mimeType": null,
        "mediaType": null,
        "format": null,
        "thumbnailUrl": null,
        "external": null,
        "assets": [{
        "type": "APIAsset",
        "id": 1111111111,
        "relationsBag": null,
        "version": 1526292804560027600,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960436,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "JaneChapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804560,
        "assetId": 2222222222,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "IMAGE",
        "mimeType": "image/png",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/html5_full_screen_expandable.png",
        "fileName": "html5_full_screen_expandable.png",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": 1499155960426,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "html5_full_screen_expandable.png",
        "codeType": null,
        "title": "html5_full_screen_expandable.png",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "45884",
        "displayName": "html5_full_screen_expandable.png",
        "userId": "3333333333",
        "folderId": "4444444444"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 276,
        "format": "png",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 276
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": null,
        "jsContext": null,
        "extendedAdProperties": null,
        "imageContext": {
        "width": 148,
        "height": 115,
        "dataPrecision": null,
        "compressionType": null,
        "extendedProperties": null
        },
        "thumbnails": [{
        "id": 1,
        "width": 148,
        "height": 115,
        "master": null,
        "name": null,
        "imageFormat": "png",
        "url": "http://resources-prod-sizmdx.s3.amazonaws.com/PROD/html5/29694749096020737/html5_full_screen_expandable.png"
        }],
        "relatedProxies": null,
        "width": 148,
        "height": 115,
        "archiveManifest": [],
        "relativePathInWorkspace": "html5_full_screen_expandable.png",
        "workspaceFolderId": 5555555555,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 45884,
        "userId": 6666666666,
        "folderId": 7777777777,
        "displayName": "html5_full_screen_expandable.png",
        "isAutoPlay": false,
        "dimensions": "148x115"
        }, {
        "type": "APIAsset",
        "id": 8888888888,
        "relationsBag": null,
        "version": 1526292804554784800,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960450,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "JaneChapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804554,
        "assetId": 9999999999,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "JS",
        "mimeType": "application/x-javascript",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/config.js",
        "fileName": "config.js",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": null,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "config.js",
        "codeType": null,
        "title": "config.js",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "45884",
        "displayName": "config.js",
        "userId": "1212121212",
        "folderId": "2121212121"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 13161,
        "format": "js",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 2708
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": null,
        "jsContext": {
        "customInteractions": null,
        "autoPlayTranscodes": null,
        "smartElementContainer": {
        "svData": [{
        "svType": "image",
        "svKey": "image1",
        "value": "http://s3-eu-west-1.amazonaws.com/nusdigital/student_voice/images/470/original/puppy%20lab.jpeg"
        }]
        },
        "html5Manifest": null
        },
        "extendedAdProperties": null,
        "imageContext": null,
        "thumbnails": null,
        "relatedProxies": null,
        "width": null,
        "height": null,
        "archiveManifest": [],
        "relativePathInWorkspace": "config.js",
        "workspaceFolderId": 2323232323,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 45884,
        "userId": 3232323232,
        "folderId": 3434343434,
        "displayName": "config.js",
        "isAutoPlay": false,
        "dimensions": ""
        }, {
        "type": "APIAsset",
        "id": 2075560399,
        "relationsBag": null,
        "version": 1526292804556750800,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960495,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "JaneChapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804557,
        "assetId": 2075560399,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "IMAGE",
        "mimeType": "image/jpeg",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/puppy.jpg",
        "fileName": "puppy.jpg",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": 1499155960485,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "puppy.jpg",
        "codeType": null,
        "title": "puppy.jpg",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "30971",
        "displayName": "puppy.jpg",
        "userId": "454545",
        "folderId": "4343434343"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 4837,
        "format": "jpg",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 4837
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": null,
        "jsContext": null,
        "extendedAdProperties": null,
        "imageContext": {
        "width": 252,
        "height": 200,
        "dataPrecision": null,
        "compressionType": null,
        "extendedProperties": null
        },
        "thumbnails": [{
        "id": 1,
        "width": 252,
        "height": 200,
        "master": null,
        "name": null,
        "imageFormat": "jpg",
        "url": "http://resources-prod-sizmdx.s3.amazonaws.com/PROD/html5/29694749096020737/puppy.jpg"
        }],
        "relatedProxies": null,
        "width": 252,
        "height": 200,
        "archiveManifest": [],
        "relativePathInWorkspace": "puppy.jpg",
        "workspaceFolderId": 4545454545,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 30971,
        "userId": 545454,
        "folderId": 5656565656,
        "displayName": "puppy.jpg",
        "isAutoPlay": false,
        "dimensions": "252x200"
        }, {
        "type": "APIAsset",
        "id": 6565656565,     
        "relationsBag": null,
        "version": 1526292804559241200,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960465,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "Jane Chapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804559,
        "assetId": 6767676767,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "TEXT",
        "mimeType": "application/json",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/adDoc.json",
        "fileName": "adDoc.json",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": null,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "adDoc.json",
        "codeType": null,
        "title": "adDoc.json",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "45884",
        "displayName": "adDoc.json",
        "userId": "7676767676",
        "folderId": "7878787878"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 29059,
        "format": "json",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 3958
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": null,
        "jsContext": null,
        "extendedAdProperties": null,
        "imageContext": null,
        "thumbnails": null,
        "relatedProxies": null,
        "width": null,
        "height": null,
        "archiveManifest": [],
        "relativePathInWorkspace": "adDoc.json",
        "workspaceFolderId": 8787878787,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 45884,
        "userId": 8989898989,
        "folderId": 9898989898,
        "displayName": "adDoc.json",
        "isAutoPlay": false,
        "dimensions": ""
        }, {
        "type": "APIAsset",
        "id": 9090909090,     
        "relationsBag": null,
        "version": 1526292804561928200,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960479,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "JaneChapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804561,
        "assetId": 2075560398,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "HTML",
        "mimeType": "text/html",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/index.html",
        "fileName": "index.html",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": null,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "index.html",
        "codeType": null,
        "title": "index.html",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "45884",
        "displayName": "index.html",
        "userId": "1112223334",
        "folderId": "2223334445"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 12433,
        "format": "html",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 4060
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": {
        "customInteractions": [{
        "cname": "CustomInteraction",
        "classificationID": "1",
        "interactionSign": "1",
        "closeFlag": "0",
        "countAsClick": "0",
        "jumpURL": "",
        "editableType": "0",
        "type": "1"
        }],
        "includeEBLoader": false,
        "scriptSource": [{
        "source": "",
        "innerText": "(function () {\n            adkit = {\n                onReady: function (callback) {\n                    window.addEventListener('adkit-ready', callback);\n                }\n            };\n            var isAdkitLoaded = false;\n            var handler = function (event) {\n                if (!isAdkitLoaded && event.data) {\n                    var response = null;\n                    try{response = JSON.parse(event.data);}catch(e){}\n                    if (response &&\n                        response.type === 'ebGetEnvironment' &&\n                        response.data instanceof Object &&\n                        response.data.paths &&\n                        response.data.paths.cachedScript) {\n                        isAdkitLoaded = true;\n                        adkit.environment = response.data;\n                        var parent = document.getElementsByTagName('head')[0] || document.documentElement;\n                        var script = document.createElement('script');\n                        script.type = 'text/javascript';\n                        var source = response.data.paths.cachedScript + '/adkit/' + response.data.version + '/adkit.js';\n                        script.src = source.replace(/\\/\\/adkit/, '/adkit');\n                        parent.appendChild(script);\n                    }\n                }\n            };\n            if (!window.ebSafeFrame) {\n                window.addEventListener('message', handler, false);\n                parent.postMessage(JSON.stringify({ type: 'ebGetEnvironment' }), '*');\n            } else {\n                handler(ebSafeFrame.getAdKitData());\n            }\n        })();",
        "index": null
        }, {
        "source": "",
        "innerText": "window.hf_scripts = [{\"host\":\"cachedScript\",\"path\":\"AdBuilderScripts/jquery.min.js\"},{\"host\":\"cachedScript\",\"path\":\"AdBuilderScripts/jquery.mobile-events.min.js\"},{\"host\":\"cachedScript\",\"path\":\"AdBuilderScripts/CSSPlugin.min.js\"},{\"host\":\"cachedScript\",\"path\":\"AdBuilderScripts/EasePack.min.js\"},{\"host\":\"cachedScript\",\"path\":\"AdBuilderScripts/TweenLite.min.js\"}];",
        "index": null
        }, {
        "source": "",
        "innerText": "function hf_kickStart(){function a(a){function b(b){return\"rgba(\"+parseInt(\"0x\"+b.substr(1,2))+\",\"+parseInt(\"0x\"+b.substr(3,2))+\",\"+parseInt(\"0x\"+b.substr(5,2))+\",\"+parseInt(a.opacity)/100+\")\"}function c(){var c,d,e=parseInt(a.gradientPercent);100>=e?(c=0,d=e):(c=e-100,d=100),document.body.style.cssText+=\"overflow:hidden; background:\"+a.gradientFirstColor+\";background: linear-gradient(to top, \"+b(a.gradientFirstColor)+\" \"+c+\"%,\"+b(a.gradientSecondColor)+\" \"+d+\"%);background: -moz-linear-gradient(bottom, \"+b(a.gradientFirstColor)+\" \"+c+\"%,\"+b(a.gradientSecondColor)+\" \"+d+\"%);background: -webkit-linear-gradient(bottom, \"+b(a.gradientFirstColor)+\" \"+c+\"%,\"+b(a.gradientSecondColor)+\" \"+d+\"%);background: -o-linear-gradient(bottom, \"+b(a.gradientFirstColor)+\" \"+c+\"%,\"+b(a.gradientSecondColor)+\" \"+d+\"%);filter: progid:DXImageTransform.Microsoft.gradient( startColorstr=\"+a.gradientFirstColor+\", endColorstr=\"+a.gradientSecondColor+\",GradientType=0);\"}function d(a){document.body.style.cssText+=\"overflow:hidden; width:100%; height:100%; padding:0; margin:0; background-color: \"+b(a)+\";\"}function e(){var b=document.createElement(\"div\");b.style.cssText=\"z-index:-2147483638; position:absolute; top:0px; left:0px; padding:0px; margin:0px; width:100%;height:100%; opacity:\"+parseInt(a.opacity)/100+\"; background-image: url('\"+Utils.parseAsset(a.assets.bgImage)+\"');\",document.body.style.cssText+=\"overflow:hidden;\",document.body.insertBefore(b,document.body.firstChild)}function f(){var b=$(\"body\"),f=b.attr(\"bgColor\");switch(b.removeAttr(\"bgColor\"),a.fillType){case\"solidColor\":case\"solid\":d(a.solidColor);break;case\"gradientColor\":case\"gradient\":c();break;case\"image\":a.assets.bgImage?e():d(\"#FFFFFF\")}J.css(\"background-color\",f)}function g(){var b={normal:null,hover:null};return\"custom\"===a.closeBtnStyle&&a.assets.closeBtnImage?b.normal=Utils.parseAsset(a.assets.closeBtnImage):(b.normal=adkit.environment.paths.cachedScript+\"/HTML5FactoryFiles/ExpandFS/1_0_0/default_close.png\",b.hover=adkit.environment.paths.cachedScript+\"/HTML5FactoryFiles/ExpandFS/1_0_0/default_close_hover.png\"),b}function h(){var b=g(),c=document.createElement(\"img\");c.src=b.normal,c.onclick=function(){adkit.collapse(adkit.environment.adParts.name),$(window).trigger(\"collapseEvent\",{target:adkit.environment.adParts.name})},b.hover&&(c.onmouseenter=function(){c.src=b.hover},c.onmouseleave=function(){c.src=b.normal});var d=\"z-index:2147483638; position:absolute; padding:0px; margin:0px; opacity:1;\";switch(a.closeBtnPos){case\"topRight\":d+=\"top:10px; right:10px;\";break;case\"topLeft\":d+=\"top:10px; left:10px;\";break;case\"bottomLeft\":d+=\"bottom:10px; left:10px;\";break;case\"bottomRight\":d+=\"bottom:10px; right:10px;\"}c.style.cssText=d,document.body.appendChild(c)}function i(){f(),a.showCloseBtn&&h()}i()}function b(a){\"FactoryPreview\"===adkit.environment.mode&&(adkit.getAdInfo().clickThrough.url=Utils.parseURL(adkit.getAdInfo().clickThrough.url)),adkit.clickThrough(),G()}function c(a){Utils.stopPropagation(a),adkit.userSwipe()}function d(a,b){Utils.stopPropagation(a),b&&adkit.customInteraction(b)}function e(a,b){Utils.stopPropagation(a);var c=b.url?b.url:void 0,d=c?b.ctObj:void 0;b.name&&(\"FactoryPreview\"===adkit.environment.mode?GotoURLActionHandler.prototype.gotoURL.call(b.caller,b.params):adkit.clickThrough(b.name,c,d),G())}function f(a,b){Utils.stopPropagation(a),h(b)}function g(a,b){Utils.stopPropagation(a),h(b)}function h(a){var b=function(b){var c=i(b);c&&c.forEach(function(b){return b.div.id===a?void b.pause():void 0})};b(\"adkit-video\"),b(\"adkit-media\"),b(\"adkit-video360\"),b(\"adkit-dailymotion\"),b(\"adkit-youtube\")}function i(a){return adkit.getComponentsByType(a)}function j(a){a.useCustomClose=hf_kickStart.disableMRAIDCloseButton}function k(a,b){Utils.stopPropagation(a);var c=$.extend({panelName:b?b.target:\"\",animate:b?b.animate:\"\",actionType:b?b.actionType:\"\"},b?b.expandTo:\"\");j(c),G(),adkit.expand(c)}function l(a,b){Utils.stopPropagation(a);var c={panelName:b.target,pushdown:!0,animate:b.animate,actionType:b?b.actionType:\"\"};j(c),G(),adkit.expand(c)}function m(a,b){Utils.stopPropagation(a);var c={panelName:b.target,expandToMax:!0,actionType:b?b.actionType:\"\",userData:{id:\"adBuilderFullScreenExpand\",data:b}};j(c),G(),adkit.expand(c)}function n(a,b){Utils.stopPropagation(a);var c=adkit.getAdInfo();if(\"SingleExpandable\"===c.adType){var d=c.adPart.data.expansionParams,e={top:parseInt(d.yOffset),left:parseInt(d.xOffset),right:parseInt(d.xOffset)+parseInt(d.width),bottom:parseInt(d.yOffset)+parseInt(d.height)};F(e)}adkit.collapse({panelName:b?b.target:\"\",animate:b?b.animate:\"\",actionType:b?b.actionType:\"\"})}function o(a){Utils.stopPropagation(a),adkit.collapse(a)}function p(a){J.trigger(a)}function q(a){a.percentage>=50&&50>K?(K=a.percentage,J.trigger(\"visible\")):a.percentage<50&&K>=50&&(K=a.percentage,J.trigger(\"notVisible\"))}function r(){J.trigger(\"adLoad\")}function s(a){r()}function t(a){J.trigger(\"adEnded\")}function u(a){J.trigger(\"skipEnabled\")}function v(a){J.trigger(\"closeEnabled\")}function w(a){J.trigger(\"play\")}function x(a){J.trigger(\"ended\")}function y(a){J.trigger(\"pause\")}function z(a){J.trigger(\"error\")}function A(a){J.trigger(\"timeupdate\",a.data.currentTime)}function B(a){J.trigger(\"durationChange\",a.data.duration)}function C(a,b){return!E(a,D(b)).intersect}function D(a){return document.getElementById(a).getBoundingClientRect()}function E(a,b){var c={};if(c.intersect=!(a.right<b.left||b.right<a.left||a.bottom<b.top||b.bottom<a.top),c.intersect){var d={};d.left=Math.max(a.left,b.left),d.top=Math.max(a.top,b.top),d.right=Math.min(a.right,b.right),d.bottom=Math.min(a.bottom,b.bottom),c.rect=d}return c}function F(a){var b=function(b){var c=i(b);c&&c.forEach(function(b){C(a,b.div.id)&&b.pause()})};b(\"adkit-video\"),b(\"adkit-youtube\"),b(\"adkit-media\"),b(\"adkit-video360\"),b(\"adkit-dailymotion\")}function G(){var a=function(a){var b=i(a);b&&b.forEach(function(a){a.pause()})};a(\"adkit-video\"),a(\"adkit-video360\"),a(\"adkit-youtube\"),a(\"adkit-media\"),a(\"adkit-dailymotion\")}\"undefined\"!=typeof runAA&&runAA();var H=adkit.getAdInfo(),I=\"InStream\"===H.adType,J=$(\"#adkit-container\"),K=0;window.ActionParams&&ActionParams.setAssetsHelper({createAssetsArray:function(){return[]}}),adkit.environment.userData&&\"adBuilderFullScreenExpand\"===adkit.environment.userData.id&&a(adkit.environment.userData.data),$(window).on(\"clickThroughEvent\",b),$(window).on(\"customInteractionEvent\",d),$(window).on(\"customClickThroughEvent\",e),$(window).on(\"elementHidden\",f),$(window).on(\"elementFadeOut\",g),$(window).on(\"expandEvent\",k),$(window).on(\"expandPushdownEvent\",l),$(window).on(\"expandFullScreenEvent\",m),$(window).on(\"collapseEvent\",n),$(window).on(\"closeAllAdPartsEvent\",o),$(window).on(\"swipe\",c),$(window).on(\"shake\",p),I&&(adkit.vpaid.onAdStart(s),adkit.vpaid.onAdEnd(t),adkit.vpaid.onSkipEnabled(u),adkit.vpaid.onCloseEnabled(v),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.PLAY,w),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.ENDED,x),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.PAUSE,y),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.ERROR,z),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.TIME_UPDATE,A),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.DURATION_CHANGE,B)),adkit.onExpand(function(){J.trigger(\"expandInterEvent\")}),adkit.onCollapse(function(){J.trigger(\"collapseInterEvent\")}),\"undefined\"==typeof InteractionsMgr?adkit.draw():(InteractionsMgr.init(),adkit.draw(),InteractionsMgr.saveStageState()),adkit.onVisibilityChanged(q),I||r()}window.Utils=window.Utils||{},Utils.fixURL=function(a){return 0!==a.indexOf(\"http\")?\"http:\nhf_kickStart.disableMRAIDCloseButton = false;",
        "index": null
        }, {
        "source": "",
        "innerText": "function onInit(params) { if (false) {\n    EB.userActionCounter('CustomInteraction');\n}}",
        "index": null
        }],
        "expansionParams": {
        "x": null,
        "y": null,
        "w": null,
        "h": null
        },
        "eyeblasterBlocks": null,
        "clickTag": "",
        "modifiedData": null,
        "includeAdKit": false
        },
        "jsContext": null,
        "extendedAdProperties": null,
        "imageContext": null,
        "thumbnails": null,
        "relatedProxies": null,
        "width": null,
        "height": null,
        "archiveManifest": [],
        "relativePathInWorkspace": "index.html",
        "workspaceFolderId": 3334445556,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 45884,
        "userId": 4445556667,
        "folderId": 5556667778,
        "displayName": "index.html",
        "isAutoPlay": false,
        "dimensions": ""
        }, {
        "type": "APIAsset",
        "id": 6667778889,     
        "relationsBag": null,
        "version": 1526292804558520300,
        "createdBy": 458579,
        "createdByName": "John Smith",
        "createdByAccount": 30971,
        "createdByAccountName": "MyAccount",
        "createdOn": 1499155960420,
        "lastUpdatedBy": 291929,
        "lastUpdatedByName": "JaneChapman",
        "lastUpdatedByAccount": 30971,
        "lastUpdatedByAccountName": "MyAccount",
        "lastUpdateOn": 1526292804558,
        "assetId": 7778889990,
        "parentAssetId": null,
        "parentSourceSystem": null,
        "assetType": "source",
        "mediaType": "IMAGE",
        "mimeType": "image/png",
        "storagePath": null,
        "publishHostName": "http://resources-prod-sizmdx.s3.amazonaws.com/",
        "publishPath": "PROD/html5/29694749096020737/logo.png",
        "fileName": "logo.png",
        "status": "Available",
        "mpsVariantId": null,
        "mpsJobId": null,
        "createUserId": null,
        "modifyUserId": null,
        "createDateTime": 1499155960412,
        "modifyDateTime": null,
        "ingestDateTime": null,
        "assetData": null,
        "currentVersion": null,
        "versionNumber": 0,
        "previousVersionAssetID": null,
        "assetCode": "logo.png",
        "codeType": null,
        "title": "logo.png",
        "metaSchemaId": null,
        "sourceSystemAssetId": null,
        "sourceSystem": null,
        "businessMetadata": {
        "accountId": "45884",
        "displayName": "logo.png",
        "userId": "1234123412",
        "folderId": "2345234523"
        },
        "previousVersion": null,
        "formatContext": {
        "audioStreamCount": null,
        "bitRate": null,
        "decodingFailed": null,
        "duration": null,
        "fileSize": 7236,
        "format": "png",
        "streamCount": null,
        "videoStreamCount": null,
        "compressedFileSize": 7236
        },
        "audioStreamContext": null,
        "videoStreamContext": null,
        "swfContext": null,
        "htmlContext": null,
        "jsContext": null,
        "extendedAdProperties": null,
        "imageContext": {
        "width": 200,
        "height": 53,
        "dataPrecision": null,
        "compressionType": null,
        "extendedProperties": null
        },
        "thumbnails": [{
        "id": 1,
        "width": 200,
        "height": 53,
        "master": null,
        "name": null,
        "imageFormat": "png",
        "url": "http://resources-prod-sizmdx.s3.amazonaws.com/PROD/html5/29694749096020737/logo.png"
        }],
        "relatedProxies": null,
        "width": 200,
        "height": 53,
        "archiveManifest": [],
        "relativePathInWorkspace": "logo.png",
        "workspaceFolderId": 4567456745,
        "html5Manifest": null,
        "isExternal": false,
        "isRevisionAsset": false,
        "sourceUrl": null,
        "parentFolderName": null,
        "accountId": 45884,
        "userId": 5678567856,
        "folderId": 6789678967,
        "displayName": "logo.png",
        "isAutoPlay": false,
        "dimensions": "200x53"
        }],
        "archiveManifest": null
        },

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example
"relationsBag": {
        "parents": {
                "account": {
                        "id": 16674,
                        "name": "[TEST] migrated account",
                        "internal": true
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
        },
        "children": {
                "advertisers": {
                        "count": 0
                },
                "brands": {
                        "count": 1
                },
                "campaigns": {
                        "count": 231
                },
                "users": {
                        "count": 0
                }
        },
        "creativeAccountContact": false
},

Parents Object

Parents Object Definition

Name

Description

Type

Required

Notes

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1072241834,
 "name": "testing account",
 "internal": false
 }

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1073741822,
 "name": "AAA"
 }

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741833,
 "name": "BBB"
 }

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741831,
 "name": "ccc"
 }

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741853,
 "name": "ddd"
 }
Object JSON Example
Example
"parents": {
        "account": {
                "id": 1072241834,
                "name": "testing account",
                "internal": false
        },
        "advertiser": {
                "id": 1073741822,
                "name": "AAA"
        },
        "brand": {
                "id": 1073741833,
                "name": "BBB"
        },
        "campaign": null,
        "site": null
},

Children Object

Children Object Definition

Name

Description

Type

Required

Notes

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only
Object JSON Example
Example
"children": {
        "advertisers": {
                "count": 0
        },
        "brands": {
                "count": 1
        },
        "campaigns": {
                "count": 231
        },
        "users": {
                "count": 0
        }
}

adAsset Object

Related Entities

Endpoints Using the adAsset Object

Parent Objects

adAsset Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

type

Type of entity.

String

Required

AdAsset

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

assetId

ID of the asset to be used.

Long

Read-only

assetStatus

Status of the asset to be used.

String

Read-only
View values

  • PENDING_INGEST

  • PENDING_TRANSCODING

  • FAILED_INGEST

  • FAILED_TRANSCODING

  • READY

width

Width of the asset.

Integer

Read-only

Width is in pixels.

height

Height of the asset.

Integer

Read-only

Height is in pixels.

assetName

Name of the asset to be used.

String

Read-only

source

Internal.

Boolean

Internal

folderId

ID of the folder in which the asset resides.

Long

Read-only

workspaceFolderId

ID of the Workspace folder in which the asset is located.

Long

Read-only

size

Size of the asset.

Long

Read-only

Size is in bytes.

duration

Length of the asset (If applicable).

Long

Read-only

Duration is in milliseconds.

bitRate

Bit rate of the asset (If applicable).

Long

Read-only

bitRate is bits per second.

mimeType

Label used to identify the type of data.

String

Read-only

mediaType

Media type for the asset.

String

Read-only
View values

  • Image

  • Video

  • JSON

  • Archive

  • Flash

  • HTML/HTML Folder

  • Audio

  • HLS_M308

format

Format of the asset, depending on the mediaType.

String

Read-only

Examples include jpg and mp4.

external

Determines if the asset is external.

Boolean

Internal

thumbnailUrl

URL of the asset thumbnail image.

String

Read-only

Object JSON Example

Example
  "...,
    "defaultImage": {
        "type": "AdAsset",
        "id": 12345665789,
        "relationsBag": null,
        "version": null,
        "assetId": 1234566789,
        "assetName": "CRT_CreativeQApositiveImage.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1234355678,
        "workspaceFolderId": 0,
        "size": 36347,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "image/jpeg",
        "mediaType": "IMAGE",
        "format": null,
        "thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/DEV1/asset/12345667899/IMAGE/23423444/CRT_CreativeQApositiveImage_29856856971149325.jpg",
        "external": false
    },
    ...,
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments