|
HTTP Method |
URI |
Description |
|---|---|---|
|
/ads/{id} |
Retrieves a specific ad by ID. |
|
|
/ads/getByIds |
Retrieves ads by IDs. |
|
|
/ads/ |
Returns all ads according to specific parameters. NoteNote: Tracking only placement ads will not be displayed in this list (only ads with creative assets). |
|
|
/assets/assetsOrFolders |
Returns all assets according to specific parameters. |
|
|
/assets/folders/{id} |
Retrieves a specific asset folder details by folder ID. |
|
|
/ads/ |
Creates and saves a new ad. |
|
|
/ads/Campaign/{campaign id}/saveAndAssign/ |
Saves and assigns an ad to a campaign. |
|
|
/ads/assignMasterAd/ |
Assigns a master ad to a campaign, advertiser, or brand. |
|
|
/ads/unassignMasterAd/ |
Unassigns a master ad from a campaign. |
|
|
/ads/duplicate/ |
Duplicates ads according to a specific number of copies. |
|
|
/ads/validateAdNameUniqueness/ |
Validates the uniqueness of the name of the ad. |
|
|
/ads/calculateAdProperties/ |
Calculates the various sizes of the ad. |
|
|
/ads/{id} |
Deletes an ad from the system. |
|
|
/ads/delete |
Deletes ads from the system. |
|
|
/assets/files/{folder id} |
Upload an asset to a folder. |
|
|
/assets/folders |
Create an asset folder. |
|
|
/assets/folders/{folder id} |
Update an asset folder. |
|
|
/assets/external/{folder id} |
Upload external assets. |
|
|
/ads/{id} |
Updates an existing ad. |
|
|
/ads/ |
Updates existing ads. |
|
|
/ads/generateFromManifest/ |
Retrieves an ad based on an HTML5 Workspace. |
Important
Important:
-
For PUT calls, do the following:
-
For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.
-
You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:
{ "result": { "type": "Advertiser", ... } }You should make the following modifications, including your specific modifications, to the json object that you submit for the request.
{ "entities": [{ "type": "Advertiser", ... }] }
-
-
For POST calls, do the following:
-
Include the fields marked as Required, as indicated in the corresponding Object article.
-
Format the JSON object as follows:
{ "entities": [{ "type": "Advertiser", ... }] }
-
Retrieves a specific ad by ID.
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the ad's details.
Example
{
"metadata":null,
"debug":null,
"error":null,
"result":{
"type":"StandardBannerAd",
"id":1234567890,
"relationsBag":null,
"version":1234567891234567890,
"createdBy":1234567890,
"createdByName":"User",
"createdByAccount":1234567890,
"createdByAccountName":"Account",
"createdOn":1234567890000,
"lastUpdatedBy":1234567890,
"lastUpdatedByName":"User",
"lastUpdatedByAccount":1234567890,
"lastUpdatedByAccountName":"Account",
"lastUpdateOn":12345678912345,
"name":"fgdfdgffhd5",
"masterAdId":0,
"changed":false,
"adStatus":"ASSIGNED",
"enabled":true,
"adFormat":"STANDARD_BANNER_AD",
"adFormatId":42,
"adFormatName":"Standard Banner",
"accountId":1234567890,
"accountName":"Account",
"placementId":null,
"placementName":null,
"placementType":null,
"siteId":null,
"siteName":null,
"adAssignmentData":{
"type":"AdAssignmentData",
"accountId":1234567890,
"accountName":"Account",
"advertiserId":1234567890,
…
},
"mainClickthrough":{
"type":"MainClickthrough",
"id":123456789123456,
"relationsBag":null,
"url":"",
…
},
"adURLs":[
{
"type":"ThirdPartyURL",
"id":1233456786,
"relationsBag":null,
"url":"ddfdbf",
…
}
],
"pricingSize":170025,
"overallSize":170025,
"initialSize":170025,
"width":600,
"height":400,
"dimensions":"600x400",
"templateScriptName":"StdBanner",
"urlTokens":null,
"minAudioVersion":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,
"enableTimeBasedServing":false,
"servingTimeZoneType":null,
"videoAudioAdAssetData":[
],
"priorityPolicy":"Server",
"adFeatures":[
],
"defaultImage":{
"type":"AdAsset",
"id":12345676892134,
"relationsBag":null,
"assetId":1234567890,
…
},
"defaultImageClickthrough":{
"type":"MainClickthrough",
"id":123456678990123,
"relationsBag":null,
"url":"",
…
},
"banner":null,
"minFlashVersion":0,
"mxpVersion":null,
"osVersion":null,
"asVersion":null,
"flashIDE":null,
"variables":null,
"html5":null,
"tooltip":"",
"authoringTool":"WORKSPACE",
"downloadMode":"INSTANT",
"initialLoadAsset":"PRELOAD_IMAGE",
"forceClickthrough":false,
"adSmartVersionSchema":{
"type":"APIAdSmartVersionSchema",
"id":null,
"smartElements":[
],
"catalog":null …
},
"disableIncomplete":false,
"enableRetargeting":false,
"rotationType":"EvenDistribution",
"versionTargetingType":"TargetAudience",
"versionBasePath":"UAT/DCO",
"advancedRetargeting":{
"type":"AdvancedRetargeting",
"branchItemClientIds":[
],
"advertiserId":null,
"tags":[
],
…
},
"automaticOptimizationData":null,
"native":false,
"containsNonWorkspaceAssets":true
}
}
Retrieves a list of ads according to IDs.
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the list of ads and their details.
Example
{
"metadata": null,
"debug": null,
"error": null,
"result": [
{
"type": "StandardBannerAd",
"id": 1234567890,
"relationsBag": null,
"version": 12345678912345,
"createdBy": 1234567890,
"createdByName": "User",
"createdByAccount": 1234566780,
"createdByAccountName": "Account",
"createdOn": 12345678912345,
"lastUpdatedBy": 1234567890,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1234567890,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 123456789123456,
"name": "00a488493e1349268aef21079cf3658c (3) (5) (1) (1) (1) (2) (1)",
"masterAdId": 0,
"changed": false,
"adStatus": "PUBLISHED",
"enabled": true,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard Banner",
"accountId": 1234567890,
"accountName": "AdBuilderAutomation",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": 12345678901234567890,
"accountName": "SanityAccount",
"advertiserId": 1073741825,
"advertiserName": "SanityAdvertiser",
"brandId": 1234567890,
"brandName": "SanityBrand",
"campaignId": 1234567890,
"campaignName": "SanityAdvanceCampaign"
},
"mainClickthrough": {
"type": "MainClickthrough",
"id": 1234567891234,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false
},
"adURLs": [
{
"type": "ThirdPartyURL",
"id": 123123123123123,
"relationsBag": null,
"url": "https://com",
"urlType": "ON_AD_DOWNLOAD",
"enabled": false,
"urlSource": "AD",
"externalId": "1",
"uniqueIdentifier": "ON_AD_DOWNLOAD_1",
"customScriptId": null,
"disableServing": false
},
{
"type": "ThirdPartyURL",
"id": 456456456456456,
"relationsBag": null,
"url": "https://www.acb.comצצ",
"urlType": "CLICK_TRACKING",
"enabled": false,
"urlSource": "AD",
"externalId": "1",
"uniqueIdentifier": "CLICK_TRACKING_1",
"customScriptId": null,
"disableServing": false
},
{
"type": "ThirdPartyURL",
"id": 789789789789,
"relationsBag": null,
"url": "https://adada.com",
"urlType": "PRELOAD",
"enabled": false,
"urlSource": "AD",
"externalId": "1",
"uniqueIdentifier": "PRELOAD_1",
"customScriptId": null,
"disableServing": false
}
],
"pricingSize": 6447,
"overallSize": 6447,
"initialSize": 6447,
"width": 300,
"height": 250,
"dimensions": "300x250",
"templateScriptName": "Html5Banner",
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"qaStatus": "NOT_SUBMITTED",
"numberOfPlacementAds": 3,
"overallNumberOfPlacementAds": 3,
"servingMethod": null,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [],
"priorityPolicy": "Server",
"adFeatures": [],
"defaultImage": {
"type": "AdAsset",
"id": 789789789789789,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "Builder_img1.jpg",
"source": true,
"assetStatus": null,
"folderId": 1234567890,
"workspaceFolderId": 1234567890,
"size": 1639,
"duration": null,
"bitRate": null,
"width": 279,
"height": 221,
"mimeType": "image/jpeg",
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/1234581808301813/Builder_img1.jpg",
"external": false
},
"defaultImageClickthrough": {
"type": "MainClickthrough",
"id": 1234567890,
"relationsBag": null,
"url": "",
"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": 345345345345345,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "00a488493e1349268aef21079cf3658c_LE225 (4) (6) (2) (2) (2) (3) (2)",
"source": true,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": 6447,
"duration": null,
"bitRate": null,
"width": 0,
"height": 0,
"mimeType": null,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"assets": null
},
"tooltip": "",
"authoringTool": "AD_BUILDER",
"downloadMode": "INSTANT",
"initialLoadAsset": null,
"forceClickthrough": false,
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": "EvenDistribution",
"versionTargetingType": "TargetAudience",
"versionBasePath": "UAT/DCO",
"advancedRetargeting": {
"type": "AdvancedRetargeting",
"branchItemClientIds": [],
"advertiserId": null,
"tags": [],
"tagIds": [],
"nodeType": "AdvancedRetargeting"
},
"automaticOptimizationData": null,
"native": false,
"containsNonWorkspaceAssets": false
},
{
"type": "InStreamInteractiveAd",
"id": 1234567890,
"clientRefId": "c55f5b18-13a3-9c0c-84be-577bd3bebb38",
"relationsBag": null,
"version": 123123123123123123,
"createdBy": 1234567890,
"createdByName": "User",
"createdByAccount": 1073741800,
"createdByAccountName": "Account",
"createdOn": 2342342342342,
"lastUpdatedBy": 1234567890,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1234567890",
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 12345678901234,
"name": "001",
"masterAdId": 0,
"changed": false,
"adStatus": "NEW",
"enabled": true,
"adFormat": "INSTREAM_INTERACTIVE_AD",
"adFormatId": 64,
"adFormatName": "In-Stream Video - Interactive",
"accountId": 1234567890,
"accountName": "Account",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": "",
"advertiserId": null,
"advertiserName": "",
"brandId": null,
"brandName": "",
"campaignId": null,
"campaignName": ""
},
"mainClickthrough": {
"type": "MainClickthrough",
"id": 1234567890123,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false
},
"adURLs": null,
"pricingSize": 4256394,
"overallSize": 5841859,
"initialSize": 4251078,
"width": 542,
"height": 550,
"dimensions": "542x550",
"templateScriptName": "InStreamInteractive",
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"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,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [
{
"type": "APIVideoAudioAdAssetData",
"id": 1234567890,
"name": "001.mp4",
"assetType": "VIDEO"
},
{
"type": "APIVideoAudioAdAssetData",
"id": 1234567890,
"name": "AssetForReplaceTranscoding_DO_NOT_TOUCH.mp4",
"assetType": "VIDEO"
}
],
"priorityPolicy": "Server",
"adFeatures": [
{
"id": 345345345345345,
"featureType": "VIDEO"
}
],
"templateData": {
"type": "TemplateData",
"id": 45645645645645,
"relationsBag": null,
"templateId": 1,
"vastVariables": [
{
"type": "VastVariable",
"id": 1,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VastVersion",
"value": "2.0",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 2,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ShellFileName",
"value": "VASTLoader.swf",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 3,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VPAIDShellFileName",
"value": "VPAIDBase.swf",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 4,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VPAIDShellJSFileName",
"value": "VPAIDAPI.js",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 5,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_MMAdVisibilityExtension",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 6,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeImpressionPCP",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 7,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeSessionId",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 8,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_CacheBustingToken",
"value": "[%random%]",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 9,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_EscapeSpecialChars",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 10,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_disableElementLevelTracking",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 11,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeScalable",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 12,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VideoSync",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 13,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ClickPrepend",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 14,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_adBreakout",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 15,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_addStreamingFileTypePrefix",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 16,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ctpause",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 17,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_pvideo",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 18,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_impressionOnVideoStart",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 19,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "standardAdRemaining",
"value": "",
"editLevel": "AD",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 20,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "reportPageURL",
"value": "true",
"editLevel": "AD",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 21,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "overlayZIndex",
"value": "",
"editLevel": "AD",
"source": "CUSTOM"
}
]
},
"linears": [
{
"type": "Linear",
"id": 1234356578789,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "001.mp4",
"source": true,
"assetStatus": null,
"folderId": 1234567890,
"workspaceFolderId": 1234567890,
"size": 4251078,
"duration": 10112,
"bitRate": 3363194,
"width": 542,
"height": 550,
"mimeType": "video/mp4",
"mediaType": "VIDEO",
"format": null,
"thumbnailUrl": "http://ds.serving-sys-dev4.com/resources/UAT/thumbnail/1234567890/23423427/123435567028674.png",
"external": false,
"variants": null,
"transcodeJobID": null,
"googleRegistryId": null,
"sequence": 0,
"vpaid": true
},
{
"type": "Linear",
"id": 500,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "AssetForReplaceTranscoding_DO_NOT_TOUCH.mp4",
"source": true,
"assetStatus": "READY",
"folderId": -1,
"workspaceFolderId": 0,
"size": 1585465,
"duration": 30528,
"bitRate": 415478,
"width": 480,
"height": 270,
"mimeType": "video/mp4",
"mediaType": "VIDEO",
"format": null,
"thumbnailUrl": "http://ds.serving-sys-int.com/resources/UAT/thumbnail/1234567890/12340127/12345678028788827.png",
"external": false,
"variants": null,
"transcodeJobID": null,
"googleRegistryId": null,
"sequence": 0,
"vpaid": true
}
],
"linearSettings": {
"type": "LinearSettings",
"id": 7897897897897,
"relationsBag": null,
"fileDuration": 31.0,
"scalable": true,
"maintainAspectRatio": true,
"clickthrough": null,
"skipEnabled": false,
"skipDelay": 0.0
},
"nonLinears": null,
"companions": null,
"advancedCompanions": null,
"deliveryType": "PROGRESSIVE",
"additionalAssets": [
{
"type": "AdditionalAsset",
"id": 4769473413171,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "backup.jpg",
"source": true,
"assetStatus": "READY",
"folderId": 1234567890,
"workspaceFolderId": 1234567890,
"size": 5316,
"duration": null,
"bitRate": null,
"width": 300,
"height": 250,
"mimeType": "image/jpeg",
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/1234567890/12340923/1234848745/48503923632212345/images/backup.jpg",
"external": false,
"variants": null,
"transcodeJobID": null,
"googleRegistryId": null,
"name": "1"
}
],
"authoringTool": "WORKSPACE",
"minFlashVersion": 0.0,
"performAutoVideoTranscoding": true,
"adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
"mxpVersion": null,
"osVersion": null,
"asVersion": null,
"flashIDE": null,
"customInteractions": null,
"enhanced": false,
"vpaid": null,
"variables": null,
"viewabilityAndVerification": "NONE",
"rotationType": "EvenDistribution",
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"versionTargetingType": "TargetAudience",
"versionBasePath": "UAT/DCO",
"disableIncomplete": false,
"enableRetargeting": false,
"advancedRetargeting": null,
"automaticOptimizationData": null,
"vastSmartElement": null,
"vastmassVersioning": false,
"vastElementURLWithToken": "",
"native": false,
"containsNonWorkspaceAssets": true
},
{
"type": "InStreamInteractiveAd",
"id": 1234567890,
"relationsBag": null,
"version": 345345345345345,
"createdBy": 1234567890,
"createdByName": "User",
"createdByAccount": 1234567890,
"createdByAccountName": "Account",
"createdOn": 1568888810083,
"lastUpdatedBy": 1073741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1073741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1588883810121,
"name": "**M",
"masterAdId": 0,
"changed": false,
"adStatus": "ASSIGNED",
"enabled": true,
"adFormat": "INSTREAM_INTERACTIVE_AD",
"adFormatId": 64,
"adFormatName": "In-Stream Video - Interactive",
"accountId": 1233741826,
"accountName": "Account",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": 1233750230,
"accountName": "Account",
"advertiserId": 1234769094,
"advertiserName": "test",
"brandId": 1233734520,
"brandName": "test",
"campaignId": 1233345671,
"campaignName": "camp23066019"
},
"mainClickthrough": {
"type": "MainClickthrough",
"id": 31060567884904,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false
},
"adURLs": null,
"pricingSize": 134627,
"overallSize": 134627,
"initialSize": 134627,
"width": 500,
"height": 450,
"dimensions": "500x450",
"templateScriptName": "InStreamInteractive",
"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,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [],
"priorityPolicy": "Server",
"adFeatures": [],
"templateData": {
"type": "TemplateData",
"id": 123456768912343,
"clientRefId": "48aa0829-069c-d346-1f8b-e8a351a30891",
"relationsBag": null,
"templateId": 1,
"vastVariables": [
{
"type": "VastVariable",
"id": 1,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VastVersion",
"value": "2.0",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 2,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ShellFileName",
"value": "VASTLoader.swf",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 3,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VPAIDShellFileName",
"value": "VPAIDBase.swf",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 4,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VPAIDShellJSFileName",
"value": "VPAIDAPI.js",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 5,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_MMAdVisibilityExtension",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 6,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeImpressionPCP",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 7,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeSessionId",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 8,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_CacheBustingToken",
"value": "[%random%]",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 9,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_EscapeSpecialChars",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 10,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_disableElementLevelTracking",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 11,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_IncludeScalable",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 12,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_VideoSync",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 13,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ClickPrepend",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 14,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_adBreakout",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 15,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_addStreamingFileTypePrefix",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 16,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_ctpause",
"value": "false",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 17,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_pvideo",
"value": "true",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 18,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "Base_impressionOnVideoStart",
"value": "",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 19,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "standardAdRemaining",
"value": "",
"editLevel": "AD",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 20,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "reportPageURL",
"value": "true",
"editLevel": "AD",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": 21,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "overlayZIndex",
"value": "",
"editLevel": "AD",
"source": "CUSTOM"
}
]
},
"linears": [
{
"type": "Linear",
"id": 262,
"relationsBag": null,
"assetId": 1234567890,
"assetName": "Image_WorkspaceWithAssets.png",
"source": true,
"assetStatus": "READY",
"folderId": 1234567890,
"workspaceFolderId": 1234567890,
"size": 134627,
"duration": null,
"bitRate": null,
"width": 500,
"height": 450,
"mimeType": "image/png",
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/12340679043203904/Image_WorkspaceWithAssets.png",
"external": false,
"variants": null,
"transcodeJobID": null,
"googleRegistryId": null,
"sequence": 0,
"vpaid": true
}
],
"linearSettings": {
"type": "LinearSettings",
"id": 1234567891234,
"relationsBag": null,
"fileDuration": 15.0,
"scalable": true,
"maintainAspectRatio": true,
"clickthrough": null,
"skipEnabled": false,
"skipDelay": 0.0
},
"nonLinears": null,
"companions": null,
"advancedCompanions": null,
"deliveryType": "PROGRESSIVE",
"additionalAssets": null,
"authoringTool": "WORKSPACE",
"minFlashVersion": 0.0,
"performAutoVideoTranscoding": true,
"adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
"mxpVersion": null,
"osVersion": null,
"asVersion": null,
"flashIDE": null,
"customInteractions": null,
"enhanced": false,
"vpaid": null,
"variables": null,
"viewabilityAndVerification": "NONE",
"rotationType": "EvenDistribution",
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"versionTargetingType": "TargetAudience",
"versionBasePath": "UAT/DCO",
"disableIncomplete": false,
"enableRetargeting": false,
"advancedRetargeting": null,
"automaticOptimizationData": null,
"vastSmartElement": null,
"vastmassVersioning": false,
"vastElementURLWithToken": "",
"native": false,
"containsNonWorkspaceAssets": true
}
]
}
Retrieves all ads according to specific parameters.
|
Name |
description |
type |
required |
notes |
|---|---|---|---|---|
|
ID |
List of IDs to fetch. |
Long |
Required |
|
|
from |
Starting index by which to fetch new campaigns for paging purposes. |
Long |
Required |
Getting multiple entities requires using from and max query parameters. Please see Query and sorting options page for limit. |
|
max |
Maximum number of campaigns to fetch for each page. |
Long |
Required |
|
|
sortOrder |
Sort order ASC or DESC; required if sort field name is specified. |
String |
Optional |
|
|
enrich |
Add various data to the ad entity. |
Integer |
Optional |
|
|
q |
Filtering options for the request. (See here). |
JSON Object |
Optional |
View parameters
|
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the list of ads and their details.
Example
{
"metadata": {
"total": 3453482
},
"debug": null,
"error": null,
"result": [{
"type": "HTML5ExpandableBannerAd",
"id": 1234567890,
"relationsBag": null,
"uiPermissions": [{
"id": 3333741800,
"name": "DuplicateAd"
}, {
"id": 1233741800,
…], "version": 1239285434996031488, "createdBy": 1233741800, "createdByName": "User", "createdByAccount": 1233741800, "createdByAccountName": "Account", "createdOn": 1239285434300, "lastUpdatedBy": 1233741800, "lastUpdatedByName": "User", "lastUpdatedByAccount": 1233741800, "lastUpdatedByAccountName": "Account", "lastUpdateOn": 1239285434996, "name": "PlatformAdForEMYl6Jo6", "masterAdId": 0, "changed": true, "adStatus": "ASSIGNED", "enabled": true, "adFormat": "HTML5_EXPANDABLE_BANNER_AD", "adFormatId": 43, "adFormatName": "HTML5 Expandable
Banner ","
accountId ":1234441800,"
accountName ":"
SanityAccount ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233745500,"
accountName ":"
SanityAccount ","
advertiserId ":1233746600,…},"
mainClickthrough ":null,"
adURLs ":[{"
type ":"
ThirdPartyURL ","
id ":1083771800,"
relationsBag ":null,"
url ":"
sdcsdcsdcdsc ",…],"
pricingSize ":60998,"
overallSize ":60998,"
initialSize ":36347,"
width ":300,"
height ":250,"
dimensions ":"
300 x250 ","
templateScriptName ":"
Html5ExpBanner ","
urlTokens ":"
Zb63kphovx ","
minAudioVersion ":0.1238528427108988,"
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,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[],"
defaultImage ":{"
type ":"
AdAsset ","
id ":12377148888573,"
relationsBag ":null,"
assetId ":234003732,…},"
defaultImageClickthrough ":null,"
additionalAssets ":null,"
customInteractions ":[{"
type ":"
AdUserActionInteraction ","
id ":21377155558928,"
relationsBag ":null,"
assetId ":2133896292,…],"
performAutoVideoTranscoding ":false,"
adTranscodingStatus ":"
TRANSCODING_NOT_REQUIRED ","
variables ":null,"
downloadMode ":"
INSTANT ","
html5 ":{"
type ":"
AdAssetFolder ","
id ":12377148864574,"
relationsBag ":null,"
assetId ":2133666017,…},"
authoringTool ":null,"
allowHTML5DynamicExpansion ":false,"
adSmartVersionSchema ":{"
type ":"
APIAdSmartVersionSchema ","
id ":null,"
smartElements ":[],"
catalog ":null…},"
disableIncomplete ":false,"
enableRetargeting ":false,"
rotationType ":"
EvenDistribution ","
versionTargetingType ":"
TargetAudience ","
versionBasePath ":"
UAT / DCO ","
initialLoadAsset ":"
DEFAULT_IMAGE ","
advancedRetargeting ":null,"
automaticOptimizationData ":null,"
panels ":[{"
type ":"
Panel ","
id ":12377177774500,"
relationsBag ":null,"
assetId ":1233844200,…],"
panelsSettings ":{"
type ":"
PanelsSettings ","
panelFrequency ":"
ONCE_IN_CAMPAIGN ","
panelFrequencyTimes ":1,"
multiplePanels ":true,…},"
native ":false,"
containsNonWorkspaceAssets ":true},{"
type ":"
HTML5RichMediaBannerAd ","
id ":1235338505,"
relationsBag ":null,"
uiPermissions ":[{"
id ":1233221800,"
name ":"
DuplicateAd "},{"
id ":1233741811,…],"
version ":2339285429266022400,"
createdBy ":1233741800,"
createdByName ":"
User ","
createdByAccount ":1233741826,"
createdByAccountName ":"
Account ","
createdOn ":1239285428713,"
lastUpdatedBy ":1233741831,"
lastUpdatedByName ":"
User ","
lastUpdatedByAccount ":1233741826,"
lastUpdatedByAccountName ":"
Account ","
lastUpdateOn ":1239285429267,"
name ":"
HTML5RichMediaBannerAdwYfF00j7 ","
masterAdId ":0,"
changed ":true,"
adStatus ":"
ASSIGNED ","
enabled ":true,"
adFormat ":"
HTML5_RICH_MEDIA_BANNER_AD ","
adFormatId ":38,"
adFormatName ":"
HTML5
Rich Media
Banner ","
accountId ":1233741800,"
accountName ":"
SanityAccount ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233741800,"
accountName ":"
SanityAccount ","
advertiserId ":null,…},"
mainClickthrough ":null,"
adURLs ":null,"
pricingSize ":116087,"
overallSize ":116087,"
initialSize ":79740,"
width ":300,"
height ":250,"
dimensions ":"
300 x250 ","
templateScriptName ":"
Html5PoliteBanner ","
urlTokens ":"
PGXbVTuwN7 ","
minAudioVersion ":0.1239230812345606,"
fourthPartyTag ":"
","
adChoicesStatus ":false,"
adChoicesLocation ":"
TOP_RIGHT ","
qaStatus ":"
NOT_SUBMITTED ","
numberOfPlacementAds ":0,"
overallNumberOfPlacementAds ":0,"
servingMethod ":null,"
analyticsData ":null,"
analyticsSettings ":null,"
customFields ":null,"
massVersioning ":true,"
usedAsTemplate ":false,"
unSavedTemplateAd ":false,"
adTemplateId ":null,"
feedEnabled ":null,"
feedStatus ":null,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[{"
id ":12351275542446100,"
featureType ":"
DCO "}],"
defaultImage ":{"
type ":"
AdAsset ","
id ":12375538251800,"
relationsBag ":null,"
assetId ":1234003700,…},"
defaultImageClickthrough ":null,"
html5 ":{"
type ":"
AdAssetFolder ","
id ":51275538251800,"
relationsBag ":null,"
assetId ":1233790100,…},"
additionalAssets ":null,"
customInteractions ":null,"
authoringTool ":null,"
performAutoVideoTranscoding ":true,"
adTranscodingStatus ":"
TRANSCODING_NOT_REQUIRED ","
variables ":null,"
adSmartVersionSchema ":{"
type ":"
APIAdSmartVersionSchema ","
id ":null,"
smartElements ":[{"
type ":"
AdSmartTextElement ",…},"
disableIncomplete ":false,"
enableRetargeting ":false,"
rotationType ":"
EvenDistribution ","
versionTargetingType ":"
TargetAudience ","
versionBasePath ":"
UAT / DCO ","
automaticOptimizationData ":null,"
initialLoadAsset ":"
DEFAULT_IMAGE ","
downloadMode ":"
INSTANT ","
advancedRetargeting ":{"
type ":"
AdvancedRetargeting ","
branchItemClientIds ":[],"
advertiserId ":null,"
tags ":[],…},"
native ":false,"
containsNonWorkspaceAssets ":true},{"
type ":"
HTML5ExpandableBannerAd ","
id ":1235748511,"
relationsBag ":null,"
uiPermissions ":[{"
id ":1233741881,"
name ":"
DuplicateAd "},{"
id ":1233741848,…],"
version ":1239281937057775616,"
createdBy ":1233741821,"
createdByName ":"
User ","
createdByAccount ":1233741836,"
createdByAccountName ":"
Account ","
createdOn ":1239281936364,"
lastUpdatedBy ":1233741831,"
lastUpdatedByName ":"
User ","
lastUpdatedByAccount ":1233741826,"
lastUpdatedByAccountName ":"
Account ","
lastUpdateOn ":1239281937056,"
name ":"
PlatformAdForEM8fTU2s ","
masterAdId ":0,"
changed ":true,"
adStatus ":"
ASSIGNED ","
enabled ":true,"
adFormat ":"
HTML5_EXPANDABLE_BANNER_AD ","
adFormatId ":43,"
adFormatName ":"
HTML5
Expandable
Banner ","
accountId ":1233741800,"
accountName ":"
SanityAccount ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233741824,"
accountName ":"
SanityAccount ","
advertiserId ":1233741825,…},"
mainClickthrough ":null,"
adURLs ":[{"
type ":"
ThirdPartyURL ","
id ":1233741825,"
relationsBag ":null,"
url ":"
sdcsdcsdcdsc ",…],"
pricingSize ":60998,"
overallSize ":60998,"
initialSize ":36347,"
width ":300,"
height ":250,"
dimensions ":"
300 x250 ","
templateScriptName ":"
Html5ExpBanner ","
urlTokens ":"
rwKOgeucWX ","
minAudioVersion ":0.1237071112283258,"
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,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[],"
defaultImage ":{"
type ":"
AdAsset ","
id ":12338161639434,"
relationsBag ":null,"
assetId ":1234005345,…},"
defaultImageClickthrough ":null,"
additionalAssets ":null,"
customInteractions ":[{"
type ":"
AdUserActionInteraction ","
id ":12348165833876,"
relationsBag ":null,"
assetId ":1233896245,…],"
performAutoVideoTranscoding ":false,"
adTranscodingStatus ":"
TRANSCODING_NOT_REQUIRED ","
variables ":null,"
downloadMode ":"
INSTANT ","
html5 ":{"
type ":"
AdAssetFolder ","
id ":12338161639485,"
relationsBag ":null,"
assetId ":123822095,…},"
authoringTool ":null,"
allowHTML5DynamicExpansion ":false,"
adSmartVersionSchema ":{"
type ":"
APIAdSmartVersionSchema ","
id ":null,"
smartElements ":[],"
catalog ":null…},"
disableIncomplete ":false,"
enableRetargeting ":false,"
rotationType ":"
EvenDistribution ","
versionTargetingType ":"
TargetAudience ","
versionBasePath ":"
UAT / DCO ","
initialLoadAsset ":"
PRELOAD_IMAGE ","
advancedRetargeting ":null,"
automaticOptimizationData ":null,"
panels ":[{"
type ":"
Panel ","
id ":12338430074022,"
relationsBag ":null,"
assetId ":1234896479,…],"
panelsSettings ":{"
type ":"
PanelsSettings ","
panelFrequency ":"
ONCE_IN_CAMPAIGN ","
panelFrequencyTimes ":1,"
multiplePanels ":true,…},"
native ":false,"
containsNonWorkspaceAssets ":true}]}
Retrieves all assets according to specific parameters.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
Asset.Names |
List of asset names to fetch when fetching for assets. |
String |
Required |
Separate multiple asset names with comma, i.e. Video1.mp4,Video2.mp4 |
|
AssetFolder.parentId |
Folder ID to begin search. Enter -1 to search the root folder. |
Long |
Required |
|
|
assetSort |
Asset sort criteria. |
String |
Optional |
View values: displayName – sort by name. |
|
recursiveSearch |
Search sub folders. |
Boolean |
Optional |
View value: true, false. |
|
from |
Starting index by which to fetch new assets for paging purposes. |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
|
max |
Maximum number of assets to fetch for each page. |
Long |
Required |
|
|
sortOrder |
Sort order ASC or DESC; required if sort field name is specified. |
String |
Optional |
View values: asc, desc. |
Retrieves a specific asset folder details by folder ID.
GET (Extracting specific entity) - https://adapi.sizmek.com/sas/assets/folders/{id}
GET (All the entities, i.e.) - https://adapi.sizmek.com/sas/assets/folders?from=0&max=200
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the ad's details.
Example
{ "metadata": { "total": 1, "types": null }, "debug": null, "error": null, "result": { "type": "AssetFolder", "id": 1075352519, "relationsBag": null, "version": 1597831479203790848, "createdBy": 266562, "createdByName": "TESTER USER", "createdByAccount": 2, "createdByAccountName": "Testing", "createdOn": 1597622070014, "lastUpdatedBy": 266562, "lastUpdatedByName": "TESTER USER", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Testing", "lastUpdateOn": 1597831479203, "folderType": "HTML5", "name": "300x250_dco_adkit_test", "parentId": 1074441067, "rootParentId": null, "folders": null, "files": null, "sourceType": "DEFAULT", "publishHostName": "http://cf-s3-prod.sizmdx.com/resources/", "publishPath": "PROD/html5/2/20200816/1075352519/56126543017027255/", "folderPath": "2/20200816/1075352519/56126543017027255/", "workspaceAssets": null, "workspaceAssetIds": [ 2081607314, 2081607315, 2081607318, 2081607319, 2081607316, 2081607317, 2081607322, 2081607323, 2081607320, 2081607321, 2081607326, 2081607327, 2081607324, 2081607325, 2081607346, 2081607347, 2081607344, 2081607345, 2081607350, 2081607348, 2081607349, 2081607330, 2081607331, 2081607328, 2081607329, 2081607334, 2081607335, 2081607332, 2081607333, 2081607338, 2081607339, 2081607336, 2081607337, 2081607342, 2081607343, 2081607340, 2081607341 ], "relativePathInWorkspace": "/", "parentFolderName": null, "accountId": 2, "userId": 266562, "hasFolders": null }}
Creates or saves a new ad. The ad creation process is dynamic according to the ad format you select. Different parameters are available depending on the type of ad.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
Body |
Body request containing ad to create. |
Long |
Required |
POST https://adapi.sizmek.com/sas/ads/
Example
{
"entities": [
{
"type": "InStreamInteractiveAd",
"id": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "InStreamInteractiveAd4rz1OTYv",
"masterAdId": null,
"changed": true,
"adStatus": "NEW",
"enabled": true,
"adFormat": "INSTREAM_INTERACTIVE_AD",
"adFormatId": null,
"adFormatName": null,
"accountId": 1233741827,
"accountName": "TYDXYzpL4h",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": null,
"advertiserId": null,
"advertiserName": null,
"brandId": null,
"brandName": null,
"campaignId": null,
"campaignName": null
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 9437310465532,
"overallSize": 9437312166125,
"initialSize": 9437310558199,
"width": 0,
"height": 0,
"templateScriptName": "Banner",
"urlTokens": "DaRVWeKmwv",
"minAudioVersion": 0.4564199388541522,
"fourthPartyTag": "PZVGY2xciO",
"adChoicesStatus": false,
"adChoicesLocation": "TOP_RIGHT",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"adFeatures": null,
"templateData": {
"type": "TemplateData",
"id": null,
"relationsBag": null,
"version": null,
"templateId": null,
"vastVariables": [
{
"type": "VastVariable",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "_FFSZ0xJG0",
"value": "Hz_taCSZyt",
"editLevel": "AD",
"source": "BASE"
},
{
"type": "VastVariable",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "PacdDBCt4K",
"value": "WY1dTr9puh",
"editLevel": "SITE_RULES",
"source": "CUSTOM"
},
{
"type": "VastVariable",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "hr2IAT8_mg",
"value": "tYCOaTb4jp",
"editLevel": "SITE_RULES",
"source": "BASE"
},
{
"type": "VastVariable",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "zTejLmTr5o",
"value": "VqnSIUw5Uj",
"editLevel": "SITE_RULES",
"source": "BASE"
},
{
"type": "VastVariable",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "ZS3ldTiqLI",
"value": "oZ4lm2mV7s",
"editLevel": "SITE_RULES",
"source": "BASE"
}
]
},
"linears": [
{
"type": "Linear",
"id": 1,
"relationsBag": null,
"version": null,
"assetId": 2073741845,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"variants": null,
"transcodeJobID": null,
"sequence": 0,
"vpaid": false
}
],
"linearSettings": {
"type": "LinearSettings",
"id": null,
"relationsBag": null,
"version": null,
"fileDuration": 15,
"scalable": true,
"maintainAspectRatio": true,
"clickthrough": null,
"skipEnabled": false,
"skipDelay": 0.671437085664399
},
"nonLinears": null,
"companions": null,
"advancedCompanions": null,
"deliveryType": "STREAMING",
"additionalAssets": null,
"authoringTool": null,
"minFlashVersion": 8,
"performAutoVideoTranscoding": false,
"adTranscodingStatus": "TRANSCODING_NOT_REQUIRED",
"mxpVersion": "NOXbO039DI",
"osVersion": "dhPv7w6JgQ",
"asVersion": "T5CmN3U7qg",
"flashIDE": "MEb4wSPdSp",
"customInteractions": null,
"enhanced": false,
"variables": [
null,
null,
null,
null,
null
],
"rotationType": null,
"adSmartVersionSchema": null,
"versionTargetingType": null,
"versionBasePath": "",
"disableIncomplete": false,
"enableRetargeting": false,
"advancedRetargeting": null,
"automaticOptimizationData": null,
"vastSmartElement": {
"type": "AdSmartVideoElement",
"id": null,
"svKey": "WmVCNOrxOa",
"value": null,
"smartElementSource": "ConfigJS"
},
"html5": null,
"vastmassVersioning": false,
"containsNonWorkspaceAssets": true,
"native": false
}
]
}
Saves and assigns an ad to a specific campaign.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
assignedEntityType |
Entity to which the ad will be assigned. |
String |
Required |
|
|
assigneeId |
ID of the assigned entity. |
List <Long> |
Required |
|
|
useManifest |
Determines if an ad can be created from an ad manifest. |
Boolean |
Optional |
There can only be one ad created from each manifest. |
|
enrich |
Add various data to the ad entity. |
Integer |
Optional |
POST https://adapi.sizmek.com/sas/ads/Campaign/124323424/saveAndAssign?assigneeId=123214&assignedEntityType=Ad&useManifest=false&enrich=1
Example
{
"entities": [
{
"type": "EnhancedStandardBannerAd",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "PublishTagTestAds_InBanner_AdvanceCampaign12JL7P4",
"masterAdId": null,
"changed": true,
"adStatus": "NEW",
"enabled": true,
"adFormat": "ENHANCED_STANDARD_BANNER_AD",
"adFormatId": null,
"adFormatName": null,
"accountId": 1233741827,
"accountName": "NZHanVoBil",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": null,
"advertiserId": null,
"advertiserName": null,
"brandId": null,
"brandName": null,
"campaignId": null,
"campaignName": null
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 9522611478540,
"overallSize": 9522612123018,
"initialSize": 9522611548136,
"width": 0,
"height": 0,
"templateScriptName": "Tracking",
"urlTokens": "A4cKPPcu9R",
"minAudioVersion": 0.9911730607071018,
"fourthPartyTag": "RVQili69Jm",
"adChoicesStatus": false,
"adChoicesLocation": "BOTTOM_RIGHT",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"adFeatures": null,
"defaultImage": {
"type": "AdAsset",
"id": null,
"relationsBag": null,
"version": null,
"assetId": 1233742859,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null
},
"defaultImageClickthrough": null,
"banner": null,
"minFlashVersion": 0.9536057649800871,
"mxpVersion": "kx3qxG8aQJ",
"osVersion": "uU9_q8FmGi",
"asVersion": "sQKeCZpBVW",
"flashIDE": "mtEWTc8I0b",
"variables": [
null,
null,
null,
null,
null
],
"playOnlyUponTrigger": true,
"downloadMode": "INSTANT",
"customInteractions": null,
"preloadBanner": null,
"containsNonWorkspaceAssets": true,
"native": false,
"adSmartVersionSchema": null,
"rotationType": null,
"versionBasePath": null,
"advancedRetargeting": null,
"enableRetargeting": false,
"disableIncomplete": false,
"versionTargetingType": null
}
]
}
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated ad resource.
Example
"result": [{
"type": "HTML5RichMediaBannerAd",
"id": 1233812738,
"relationsBag": null,
"version": 1239184084055687168,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1239184084054,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 2133741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1239184084054,
"name": "HTML5RichMediaBannerAdDs2kb54r",
"masterAdId": 0,
"changed": true,
"adStatus": "ASSIGNED",
"enabled": true,
"adFormat": "HTML5_RICH_MEDIA_BANNER_AD",
"adFormatId": 38,
"adFormatName": "HTML5 Rich Media Banner ",
" accountId ": 1233741827,
" accountName ": " SanityAccount ",
" placementId ": null,
" placementName ": null,
" placementType ": null,
" siteId ": null,
" siteName ": null,
" adAssignmentData ": {
" type ": " AdAssignmentData ",
" accountId ": 1233741827,
" accountName ": " SanityAccount ",
" advertiserId ": 1233741825,
" advertiserName ": " SanityAdvertiser ",
" brandId ": 1233741826,
" brandName ": " SanityBrand ",
" campaignId ": 1233741825,
" campaignName ": " SanityCampaign "
},
" mainClickthrough ": null,
" adURLs ": null,
" pricingSize ": 54989,
" overallSize ": 54989,
" initialSize ": 36347,
" width ": 300,
" height ": 250,
" dimensions ": " 300 x250 ",
" templateScriptName ": " Html5PoliteBanner ",
" urlTokens ": " X4xQVhXsUU ",
" minAudioVersion ": 0.32576547438208114,
" fourthPartyTag ": " ",
" adChoicesStatus ": false,
" adChoicesLocation ": " BOTTOM_LEFT ",
" 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,
" enableTimeBasedServing ": false,
" servingTimeZoneType ": null,
" videoAudioAdAssetData ": [],
" priorityPolicy ": " Server ",
" adFeatures ": [],
" defaultImage ": {
" type ": " AdAsset ",
" id ": 12370950109184,
" relationsBag ": null,
" assetId ": 1233778013,
" assetName ": " CRT_QAPositiveImage.jpg ",
" source ": true,
" assetStatus ": null,
" folderId ": -1,
" 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/CI/source/1073741826/IMAGE/20190201143226858/CRT_QAPositiveImage.jpg",
"external": false
},
"defaultImageClickthrough": null,
"html5": {
"type": "AdAssetFolder",
"id": 12370950109185,
"relationsBag": null,
"assetId": 1233761310,
"assetName": "CRT_workspaceWithPanel (5) ",
" source ": true,
" assetStatus ": null,
" folderId ": null,
" workspaceFolderId ": null,
" size ": 18642,
" duration ": null,
" bitRate ": null,
" width ": 0,
" height ": 0,
" mimeType ": null,
" mediaType ": null,
" format ": null,
" thumbnailUrl ": null,
" external ": null,
" assets ": [{
" type ": " APIAsset ",
" id ": 1233782465,
" relationsBag ": null,
" version ": 1239184084213235712,
" createdBy ": 1233741831,
" createdByName ": " User ",
" createdByAccount ": 133741826,
" createdByAccountName ": " Account ",
" createdOn ": 1239180208566,
" lastUpdatedBy ": 1234741831,
" lastUpdatedByName ": " User ",
" lastUpdatedByAccount ": 1233741826,
" lastUpdatedByAccountName ": " Account ",
" lastUpdateOn ": 1239184084211,
" assetId ": 1233782465,
" parentAssetId ": null,
" parentSourceSystem ": null,
" assetType ": " source ",
" mediaType ": " IMAGE ",
" mimeType ": " image / gif ",
" storagePath ": null,
" publishHostName ": " http: //resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "CI/html5/12323030494283228/assets/defaultImage400x400.gif",
"fileName": "defaultImage400x400.gif",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 1239180208566,
"modifyDateTime": null,
"ingestDateTime": null,
"assetData": null,
"currentVersion": null,
"versionNumber": 0,
"previousVersionAssetID": null,
"assetCode": "defaultImage400x400.gif",
"codeType": null,
"title": "defaultImage400x400.gif",
"metaSchemaId": null,
"sourceSystemAssetId": null,
"sourceSystem": null,
"businessMetadata": {},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 3398,
"format": "gif",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 3398
},
"audioStreamContext": null,
"videoStreamContext": null,
"swfContext": null,
"htmlContext": null,
"jsContext": null,
"extendedAdProperties": null,
"imageContext": {
"width": 401,
"height": 401,
"dataPrecision": null,
"compressionType": null,
"extendedProperties": null
},
"thumbnails": [{
"id": 1,
"width": 401,
"height": 401,
"master": null,
"name": null,
"imageFormat": "gif",
"url": "http://resources-dev-sizmdx.s3.amazonaws.com/CI/html5/12323030494283228/assets/defaultImage400x400.gif"
}],
"relatedProxies": null,
"width": 401,
"height": 401,
"archiveManifest": [],
"relativePathInWorkspace": "assets/defaultImage400x400.gif",
"workspaceFolderId": 1233761300,
"html5Manifest": null,
"isExternal": false,
"isRevisionAsset": false,
"sourceUrl": null,
"parentFolderName": null,
"accountId": 1233741800,
"userId": 1233741800,
"folderId": 1233761300,
"displayName": "defaultImage400x400.gif",
"isAutoPlay": false
}, {
"type": "APIAsset",
"id": 2073782400,
"relationsBag": null,
"version": 1239184084210548736,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1239180208568,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 2349184084209,
"assetId": 2343782400,
"parentAssetId": null,
"parentSourceSystem": null,
"assetType": "source",
"mediaType": "HTML",
"mimeType": "text/html",
"storagePath": null,
"publishHostName": "http://resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "CI/html5/23423030494283228/assets/panel1.html",
"fileName": "panel1.html",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 2349180208568,
"modifyDateTime": null,
"ingestDateTime": null,
"assetData": null,
"currentVersion": null,
"versionNumber": 0,
"previousVersionAssetID": null,
"assetCode": "panel1.html",
"codeType": null,
"title": "panel1.html",
"metaSchemaId": null,
"sourceSystemAssetId": null,
"sourceSystem": null,
"businessMetadata": {},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 1414,
"format": "html",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 656
},
"audioStreamContext": null,
"videoStreamContext": null,
"swfContext": null,
"htmlContext": {
"customInteractions": [{
"cname": "CICTR",
"classificationID": "1",
"interactionSign": "1",
"closeFlag": "0",
"countAsClick": "1",
"jumpURL": "",
"editableType": "0",
"type": "4"
}],
"includeEBLoader": true,
"scriptSource": [{
"source": "http://ds.serving-sys-int.com/BurstingScript/EBLoader.js",
"innerText": "",
"index": 127
}, {
"source": "",
"innerText": "document.write(\"<img id = 'myImg' width = '300' height = '250' / > \");",
"index": null
}, {
"source": "",
"innerText": "function CICTR() { \ n EB.clickthrough(\"CICTR\",\ "
http: //www.google.com\");\n }\ n function MainCTR() { \ n EB.clickthrough(\"\",\ "\");\n }\n function Collapse1() {\n EB.collapse();\n }\n var img = document.getElementById('myImg');\ n\ n function onInit(obj) { \ n\ n var img = document.getElementById('myImg');\ n img.setAttribute('src', EB.getAssetUrl('9.jpg'));\ n }\ n if (!EB.isInitialized()) { \ n EB.addEventListener(EBG.EventName.EB_INITIALIZED, onInit);\ n }\ n else { \ n onInit();\ 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 ":" assets / panel1.html "," workspaceFolderId ":2343761310," html5Manifest ":null," isExternal ":false," isRevisionAsset ":false," sourceUrl ":null," parentFolderName ":null," accountId ":2343741800," userId ":1073741800," folderId ":2343761300," displayName ":" panel1.html "," isAutoPlay ":false},{" type ":" APIAsset "," id ":1233782463," relationsBag ":null," version ":2349184084201963520," createdBy ":2343741831," createdByName ":" User "," createdByAccount ":2343741826," createdByAccountName ":" Account "," createdOn ":2349180208564," lastUpdatedBy ":1233741831," lastUpdatedByName ":" User "," lastUpdatedByAccount ":1233741826," lastUpdatedByAccountName ":" Account "," lastUpdateOn ":1239184084191," assetId ":1234782463," parentAssetId ":null," parentSourceSystem ":null," assetType ":" source "," mediaType ":" IMAGE "," mimeType ":" image / jpeg "," storagePath ":null," publishHostName ":" http: //resources-dev-sizmdx.s3.amazonaws.com/","publishPath":"CI/html5/12323030494283228/assets/11.jpg","fileName":"11.jpg","status":"Available","mpsVariantId":null,"mpsJobId":null,"createUserId":null,"modifyUserId":null,"createDateTime":1549180208564,"modifyDateTime":null,"ingestDateTime":null,"assetData":null,"currentVersion":null,"versionNumber":0,"previousVersionAssetID":null,"assetCode":"11.jpg","codeType":null,"title":"11.jpg","metaSchemaId":null,"sourceSystemAssetId":null,"sourceSystem":null,"businessMetadata":{},"previousVersion":null,"formatContext":{"audioStreamCount":null,"bitRate":null,"decodingFailed":null,"duration":null,"fileSize":5996,"format":"jpg","streamCount":null,"videoStreamCount":null,"compressedFileSize":5996},"audioStreamContext":null,"videoStreamContext":null,"swfContext":null,"htmlContext":null,"jsContext":null,"extendedAdProperties":null,"imageContext":{"width":258,"height":195,"dataPrecision":null,"compressionType":null,"extendedProperties":null},"thumbnails":[{"id":1,"width":258,"height":195,"master":null,"name":null,"imageFormat":"jpg","url":"http://resources-dev-sizmdx.s3.amazonaws.com/CI/html5/43123030494283228/assets/11.jpg"}],"relatedProxies":null,"width":258,"height":195,"archiveManifest":[],"relativePathInWorkspace":"assets/11.jpg","workspaceFolderId":1073761300,"html5Manifest":null,"isExternal":false,"isRevisionAsset":false,"sourceUrl":null,"parentFolderName":null,"accountId":1073741800,"userId":1073741800,"folderId":1073761300,"displayName":"11.jpg","isAutoPlay":false},{"type":"APIAsset","id":1233782400,"relationsBag":null,"version":1549181234215005184,"createdBy":1073741800,"createdByName":"User","createdByAccount":1233741800,"createdByAccountName":"Account","createdOn":1239180208565,"lastUpdatedBy":1233741800,"lastUpdatedByName":"User","lastUpdatedByAccount":1233741800,"lastUpdatedByAccountName":"Account","lastUpdateOn":1239184084213,"assetId":1233782400,"parentAssetId":null,"parentSourceSystem":null,"assetType":"source","mediaType":"IMAGE","mimeType":"image/jpeg","storagePath":null,"publishHostName":"http://resources-dev-sizmdx.s3.amazonaws.com/","publishPath":"CI/html5/12323030494283228/assets/9.jpg","fileName":"9.jpg","status":"Available","mpsVariantId":null,"mpsJobId":null,"createUserId":null,"modifyUserId":null,"createDateTime":1549180208565,"modifyDateTime":null,"ingestDateTime":null,"assetData":null,"currentVersion":null,"versionNumber":0,"previousVersionAssetID":null,"assetCode":"9.jpg","codeType":null,"title":"9.jpg","metaSchemaId":null,"sourceSystemAssetId":null,"sourceSystem":null,"businessMetadata":{},"previousVersion":null,"formatContext":{"audioStreamCount":null,"bitRate":null,"decodingFailed":null,"duration":null,"fileSize":7920,"format":"jpg","streamCount":null,"videoStreamCount":null,"compressedFileSize":7920},"audioStreamContext":null,"videoStreamContext":null,"swfContext":null,"htmlContext":null,"jsContext":null,"extendedAdProperties":null,"imageContext":{"width":260,"height":194,"dataPrecision":null,"compressionType":null,"extendedProperties":null},"thumbnails":[{"id":1,"width":260,"height":194,"master":null,"name":null,"imageFormat":"jpg","url":"http://resources-dev-sizmdx.s3.amazonaws.com/CI/html5/12323030494283228/assets/9.jpg"}],"relatedProxies":null,"width":260,"height":194,"archiveManifest":[],"relativePathInWorkspace":"assets/9.jpg","workspaceFolderId":1233761300,"html5Manifest":null,"isExternal":false,"isRevisionAsset":false,"sourceUrl":null,"parentFolderName":null,"accountId":1233741800,"userId":1233741800,"folderId":1233761300,"displayName":"9.jpg","isAutoPlay":false},{"type":"APIAsset","id":1233782400,"relationsBag":null,"version":1549184084204978176,"createdBy":1233741800,"createdByName":"User","createdByAccount":1233741800,"createdByAccountName":"Account","createdOn":1549180208563,"lastUpdatedBy":1233741800,"lastUpdatedByName":"User","lastUpdatedByAccount":1233741800,"lastUpdatedByAccountName":"Account","lastUpdateOn":1549184084202,"assetId":1233782400,"parentAssetId":null,"parentSourceSystem":null,"assetType":"source","mediaType":"HTML","mimeType":"text/html","storagePath":null,"publishHostName":"http://resources-dev-sizmdx.s3.amazonaws.com/","publishPath":"CI/html5/12323030494283228/index.html","fileName":"index.html","status":"Available","mpsVariantId":null,"mpsJobId":null,"createUserId":null,"modifyUserId":null,"createDateTime":1549180208563,"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":{},"previousVersion":null,"formatContext":{"audioStreamCount":null,"bitRate":null,"decodingFailed":null,"duration":null,"fileSize":1456,"format":"html","streamCount":null,"videoStreamCount":null,"compressedFileSize":672},"audioStreamContext":null,"videoStreamContext":null,"swfContext":null,"htmlContext":{"customInteractions":[{"cname":"CICTR","classificationID":"1","interactionSign":"1","closeFlag":"0","countAsClick":"1","jumpURL":"","editableType":"0","type":"4"}],"includeEBLoader":true,"scriptSource":[{"source":"http://ds.serving-sys-int.com/BurstingScript/EBLoader.js","innerText":"","index":209},{"source":"","innerText":"function CICTR() { \ n EB.clickthrough(\"CICTR\",\ "http://www.google.com\");\n }\ n function MainCTR() { \ n EB.clickthrough(\"\",\ "\");\n }\n function Expand() {\n EB.expand();\n }\n if (!EB.isInitialized()) { \ n EB.addEventListener(EBG.EventName.EB_INITIALIZED, onInit);\ n }\ n else { \ n onInit();\ n }\ n\ n var paramObj;\ n\ n var expanded = false;\ n var firstTime = true;\ n var img = document.getElementById('myImg');\ n\ n\ n function onInit(obj) { \ n var img = document.getElementById('myImg');\ n img.setAttribute('src', EB.getAssetUrl('assets/11.jpg'));\ 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 ":1233761310," html5Manifest ":null," isExternal ":false," isRevisionAsset ":false," sourceUrl ":null," parentFolderName ":null," accountId ":1233741800," userId ":1073741800," folderId ":1233761300," displayName ":" index.html "," isAutoPlay ":false}]}," additionalAssets ":null," customInteractions ":[{" type ":" AdClickthroughInteraction "," id ":12370951157761," relationsBag ":null," assetId ":2073782462," name ":" CICTR "," reportingName ":" CICTR "," assetName ":" index.html "," reportingNameId ":123441868053692," closeAdParts ":false," redirectURL ":" "}]," authoringTool ":null," performAutoVideoTranscoding ":true," adTranscodingStatus ":" TRANSCODING_NOT_REQUIRED "," variables ":null," adSmartVersionSchema ":{" type ":" APIAdSmartVersionSchema "," id ":null," smartElements ":[]," catalog ":null}," disableIncomplete ":false," enableRetargeting ":false," rotationType ":" EvenDistribution "," versionTargetingType ":" TargetAudience "," versionBasePath ":" CI / DCO "," automaticOptimizationData ":null," initialLoadAsset ":" DEFAULT_IMAGE "," downloadMode ":" INSTANT "," advancedRetargeting ":null," native ":false," containsNonWorkspaceAssets ":true}]}
Assigns a master ad to a campaign, advertiser, or brand.
POST https://adapi.sizmek.com/sas/ads/assignMasterAd/
A successful request returns the HTTP 200 OK status code with the updated results in the response body.
Example
{
"metadata": null,
"debug": null,
"error": [],
"result": [{
"type": "StandardBannerAd",
"id": 1235747600,
"relationsBag": null,
"version": 1239188418368765952,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1239183197679,
"lastUpdatedBy": 1073741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1239188418369,
"name": "fgdfdgffhd5",
"masterAdId": 0,
"changed": false,
"adStatus": "ASSIGNED",
"enabled": true,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard
Banner ","
accountId ":1233741826,"
accountName ":"
Account ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233741834,"
accountName ":"
Prisma
API testing account ","
advertiserId ":1233741830,"
advertiserName ":"
GAP ","
brandId ":1233741833,"
brandName ":"
GLOVES ","
campaignId ":1083753540,"
campaignName ":"
0129 _SJB_JAN_201811 "},"
mainClickthrough ":{"
type ":"
MainClickthrough ","
id ":12333110004337,"
relationsBag ":null,"
url ":"
","
targetWindowType ":"
NEW ","
showAddressBar ":true,"
showMenuBar ":true,"
closeAllAdParts ":false},"
adURLs ":[{"
type ":"
ThirdPartyURL ","
id ":1233741866,"
relationsBag ":null,"
url ":"
ddfdbf ","
urlType ":"
CLICK_TRACKING ","
enabled ":false,"
urlSource ":"
CAMPAIGN ","
externalId ":null,"
uniqueIdentifier ":"
CLICK_TRACKING_null ","
customScriptId ":null,"
disableServing ":false}],"
pricingSize ":170025,"
overallSize ":170025,"
initialSize ":170025,"
width ":600,"
height ":400,"
dimensions ":"
600 x400 ","
templateScriptName ":"
StdBanner ","
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,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[],"
defaultImage ":{"
type ":"
AdAsset ","
id ":12333110004338,"
relationsBag ":null,"
assetId ":1234116832,"
assetName ":"
0 - 5 - 12 k.jpg ","
source ":true,"
assetStatus ":null,"
folderId ":1233823916,"
workspaceFolderId ":1233823910,"
size ":170025,"
duration ":null,"
bitRate ":null,"
width ":600,"
height ":400,"
mimeType ":"
image / jpeg ","
mediaType ":"
IMAGE ","
format ":null,"
thumbnailUrl ":"
http: //resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/1073741826/20180130/1073823910/34567026393481220/MAIN_PANEL/images/progressive-preview/0-5-12k.jpg","external":false},"defaultImageClickthrough":{"type":"MainClickthrough","id":23833110004300,"relationsBag":null,"url":"","targetWindowType":"NEW","showAddressBar":true,"showMenuBar":true,"closeAllAdParts":false},"banner":null,"minFlashVersion":0.0,"mxpVersion":null,"osVersion":null,"asVersion":null,"flashIDE":null,"variables":null,"html5":null,"tooltip":"","authoringTool":"WORKSPACE","downloadMode":"INSTANT","initialLoadAsset":"PRELOAD_IMAGE","forceClickthrough":false,"adSmartVersionSchema":{"type":"APIAdSmartVersionSchema","id":null,"smartElements":[],"catalog":null},"disableIncomplete":false,"enableRetargeting":false,"rotationType":"EvenDistribution","versionTargetingType":"TargetAudience","versionBasePath":"UAT/DCO","advancedRetargeting":{"type":"AdvancedRetargeting","branchItemClientIds":[],"advertiserId":null,"tags":[],"tagIds":[],"nodeType":"AdvancedRetargeting"},"automaticOptimizationData":null,"native":false,"containsNonWorkspaceAssets":true}]}
Unassigns a master ad from a campaign.
POST https://adapi.sizmek.com/sas/ads/unassignMasterAd/
Duplicates ads according to a specific number of copies.
POST https://adapi.sizmek.com/sas/ads/duplicate
Validates the uniqueness of the ad name.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
suggestUniqueName |
Determines if the app should suggest names that are not yet taken. |
Boolean |
Optional |
Default value is false. |
POST https://adapi.sizmek.com/sas/ads/validateAdNameUniqueness/
Example
{
"entities": [
{
"type": "EnhancedStandardBannerAd",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "PublishTagTestAds_InBanner_AdvanceCampaign12JL7P4",
"masterAdId": null,
"changed": true,
"adStatus": "NEW",
"enabled": true,
"adFormat": "ENHANCED_STANDARD_BANNER_AD",
"adFormatId": null,
"adFormatName": null,
"accountId": 1233741800,
"accountName": "NZHanVoBil",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": null,
"advertiserId": null,
"advertiserName": null,
"brandId": null,
"brandName": null,
"campaignId": null,
"campaignName": null
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 9522611478540,
"overallSize": 9522612123018,
"initialSize": 9522611548136,
"width": 0,
"height": 0,
"templateScriptName": "Tracking",
"urlTokens": "A4cKPPcu9R",
"minAudioVersion": 0.9911730607071018,
"fourthPartyTag": "RVQili69Jm",
"adChoicesStatus": false,
"adChoicesLocation": "BOTTOM_RIGHT",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"adFeatures": null,
"defaultImage": {
"type": "AdAsset",
"id": null,
"relationsBag": null,
"version": null,
"assetId": 1233742800,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null
},
"defaultImageClickthrough": null,
"banner": null,
"minFlashVersion": 0.9536057649800871,
"mxpVersion": "kx3qxG8aQJ",
"osVersion": "uU9_q8FmGi",
"asVersion": "sQKeCZpBVW",
"flashIDE": "mtEWTc8I0b",
"variables": [
null,
null,
null,
null,
null
],
"playOnlyUponTrigger": true,
"downloadMode": "INSTANT",
"customInteractions": null,
"preloadBanner": null,
"containsNonWorkspaceAssets": true,
"native": false,
"adSmartVersionSchema": null,
"rotationType": null,
"versionBasePath": null,
"advancedRetargeting": null,
"enableRetargeting": false,
"disableIncomplete": false,
"versionTargetingType": null
}
]
}
Calculates the various sizes of the ad, for example, overall size or pricing size.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing ad body to create. |
JSON |
Required |
POST https://adapi.sizmek.com/sas/ads/calculateAdProperties/
Example
{
"entities": [
{
"type": "EnhancedStandardBannerAd",
"id": null,
"relationsBag": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "PublishTagTestAds_InBanner_AdvanceCampaign12JL7P4",
"masterAdId": null,
"changed": true,
"adStatus": "NEW",
"enabled": true,
"adFormat": "ENHANCED_STANDARD_BANNER_AD",
"adFormatId": null,
"adFormatName": null,
"accountId": 1233741800,
"accountName": "Account",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": null,
"advertiserId": null,
"advertiserName": null,
"brandId": null,
"brandName": null,
"campaignId": null,
"campaignName": null
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 9522611478540,
"overallSize": 9522612123018,
"initialSize": 9522611548136,
"width": 0,
"height": 0,
"templateScriptName": "Tracking",
"urlTokens": "A4cKPPcu9R",
"minAudioVersion": 0.9911730607071018,
"fourthPartyTag": "RVQili69Jm",
"adChoicesStatus": false,
"adChoicesLocation": "BOTTOM_RIGHT",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"adFeatures": null,
"defaultImage": {
"type": "AdAsset",
"id": null,
"relationsBag": null,
"version": null,
"assetId": 1233742800,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null
},
"defaultImageClickthrough": null,
"banner": null,
"minFlashVersion": 0.9536057649800871,
"mxpVersion": "kx3qxG8aQJ",
"osVersion": "uU9_q8FmGi",
"asVersion": "sQKeCZpBVW",
"flashIDE": "mtEWTc8I0b",
"variables": [
null,
null,
null,
null,
null
],
"playOnlyUponTrigger": true,
"downloadMode": "INSTANT",
"customInteractions": null,
"preloadBanner": null,
"containsNonWorkspaceAssets": true,
"native": false,
"adSmartVersionSchema": null,
"rotationType": null,
"versionBasePath": null,
"advancedRetargeting": null,
"enableRetargeting": false,
"disableIncomplete": false,
"versionTargetingType": null
}
]
}
A successful request returns the HTTP 200 OK status code with the updated results in the response body.
Example
{
"metadata": null,
"debug": null,
"error": null,
"result": [{
"type": "StandardBannerAd",
"id": 1235747600,
"relationsBag": null,
"version": 1239194555752513500,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1239183197679,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1239194555752,
"name": "fgdfdgffhd5b",
"masterAdId": 0,
"changed": false,
"adStatus": "ASSIGNED",
"enabled": true,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard
Banner ","
accountId ":1233741826,"
accountName ":"
Account ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233741834,"
accountName ":"
Prisma
API testing
account ","
advertiserId ":1233741830,"
advertiserName ":"
GAP ","
brandId ":1233741833,"
brandName ":"
GLOVES ","
campaignId ":1233753540,"
campaignName ":"
0129 _SJB_JAN_201811 "},"
mainClickthrough ":{"
type ":"
MainClickthrough ","
id ":23833110004337,"
relationsBag ":null,"
url ":"
","
targetWindowType ":"
NEW ","
showAddressBar ":true,"
showMenuBar ":true,"
closeAllAdParts ":false},"
adURLs ":[{"
type ":"
ThirdPartyURL ","
id ":1083741866,"
relationsBag ":null,"
url ":"
ddfdbf ","
urlType ":"
CLICK_TRACKING ","
enabled ":false,"
urlSource ":"
CAMPAIGN ","
externalId ":"
1 ","
uniqueIdentifier ":"
CLICK_TRACKING_1 ","
customScriptId ":null,"
disableServing ":false}],"
pricingSize ":168343,"
overallSize ":168343,"
initialSize ":168343,"
width ":0,"
height ":0,"
dimensions ":"
0x0 ","
templateScriptName ":"
StdBanner ","
urlTokens ":null,"
minAudioVersion ":0.0,"
fourthPartyTag ":"
","
adChoicesStatus ":false,"
adChoicesLocation ":"
TOP_RIGHT ","
qaStatus ":"
NOT_SUBMITTED ","
numberOfPlacementAds ":0,"
overallNumberOfPlacementAds ":0,"
servingMethod ":null,"
analyticsData ":{"
impressions ":null,"
clicks ":null,"
lastUpdated ":null,"
ctr ":null,"
actualStartDate ":null},"
analyticsSettings ":null,"
customFields ":null,"
massVersioning ":false,"
usedAsTemplate ":false,"
unSavedTemplateAd ":false,"
adTemplateId ":null,"
feedEnabled ":null,"
feedStatus ":null,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[],"
defaultImage ":{"
type ":"
AdAsset ","
id ":null,"
relationsBag ":null,"
assetId ":2074116834,"
assetName ":"
26 - 35 - 24 k.jpg ","
source ":false,"
assetStatus ":null,"
folderId ":1233823916,"
workspaceFolderId ":null,"
size ":168343,"
duration ":null,"
bitRate ":null,"
width ":24000,"
height ":168,"
mimeType ":null,"
mediaType ":"
IMAGE ","
format ":null,"
thumbnailUrl ":"
http: //resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/1073741826/20180130/1073823910/34567026393481220/MAIN_PANEL/images/progressive-preview/26-35-24k.jpg","external":false},"defaultImageClickthrough":{"type":"MainClickthrough","id":23833110004300,"relationsBag":null,"url":"","targetWindowType":"NEW","showAddressBar":true,"showMenuBar":true,"closeAllAdParts":false},"banner":{"type":"AdAsset","id":-1,"relationsBag":null,"assetId":-1,"assetName":null,"source":false,"assetStatus":null,"folderId":null,"workspaceFolderId":null,"size":0,"duration":null,"bitRate":null,"width":0,"height":0,"mimeType":null,"mediaType":null,"format":null,"thumbnailUrl":null,"external":null},"minFlashVersion":0.0,"mxpVersion":null,"osVersion":null,"asVersion":null,"flashIDE":null,"variables":null,"html5":null,"tooltip":"","authoringTool":"WORKSPACE","downloadMode":"INSTANT","initialLoadAsset":"PRELOAD_IMAGE","forceClickthrough":false,"adSmartVersionSchema":{"type":"APIAdSmartVersionSchema","id":null,"smartElements":[],"catalog":null},"disableIncomplete":false,"enableRetargeting":false,"rotationType":"EvenDistribution","versionTargetingType":"TargetAudience","versionBasePath":"UAT/DCO","advancedRetargeting":{"type":"AdvancedRetargeting","branchItemClientIds":[],"advertiserId":null,"tags":[],"tagIds":[],"nodeType":"AdvancedRetargeting"},"automaticOptimizationData":null,"native":false,"containsNonWorkspaceAssets":true}]}
Deletes an ad according to a specific ID.
Deletes multiple ads according to specific IDs. You cannot delete ads that are live.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing ads to delete |
Long |
Required |
Upload an asset to an asset folder.
Content-Type must be multipart/form-data.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Folder ID |
The folder to upload the asset to. |
Long |
Required |
|
|
Body |
Request containing asset to upload. |
Binary |
Required |
Create an asset folder.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing folder to create. |
Long |
Required |
POST https://adapi.sizmek.com/sas/assets/folders
Deletes multiple ads according to specific IDs. You cannot delete ads that are live.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing ads to delete |
Long |
Required |
PUT https://adapi.sizmek.com/sas/assets/folder/{folder id}
Example
{
"entities": [
{
"type": "AssetFolder",
"id": 123456700,
"relationsBag": null,
"version": 1591001574304055300,
"createdBy": 234567800,
"createdByName": "User",
"createdByAccount": 345678900,
"createdByAccountName": "Account",
"createdOn": 1591001574269,
"lastUpdatedBy": 456789000,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 567890100,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1591001574269,
"folderType": "DEFAULT",
"name": "test1",
"parentId": -1,
"rootParentId": 1,
"folders": null,
"files": null,
"sourceType": "DEFAULT",
"publishHostName": null,
"publishPath": null,
"folderPath": null,
"workspaceAssets": null,
"workspaceAssetIds": null,
"relativePathInWorkspace": null,
"parentFolderName": null,
"accountId": 2222222222,
"userId": 3333333333,
"hasFolders": null,
"httpStatusCode": 200,
"route": "assets/folders",
"reqParams": null,
"fromServer": true,
"parentResource": null,
"restangularCollection": false
}
]
}
Upload external assets.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing external assets to upload. |
Long |
Required |
POST https://adapi.sizmek.com/sas/assets/external/{folder id}
Updates the properties of an existing ad.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
id |
ID of ad to fetch. |
Long |
Required |
|
|
Body |
Body request containing ad to update. |
Body |
Required |
|
|
isOverride |
Determines whether to override the placement's ads with changes from the master ad (if the master ad is the one being updated). |
Boolean |
Optional |
|
|
useManifest |
Determines whether to update the ad using ad manifest. |
Boolean |
Optional |
Default value is false. |
|
enrich |
Add various data to the ad entity. |
Integer |
Optional |
PUT https://adapi.sizmek.com/sas/ads/{ID}
Example
{
"entities": [{
"type": "StandardBannerAd",
"id": 1235082900,
"relationsBag": null,
"version": 1231917330021220400,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1236566692600,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231917330016,
"name": "123488493e134926jjjj8aef21079cf3658c (3) (5) (1) (1) (1) (2) (1)",
"masterAdId": 1234573800,
"changed": true,
"adStatus": "NEW",
"enabled": false,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard Banner",
"accountId": 1234741900,
"accountName": "AdBuilderAutomation",
"placementId": 1075360400,
"placementName": "placement_test1_e123303b-2d01-4dda-9bb5-fbb397bbd244",
"placementType": "IN_BANNER",
"siteId": 1073766300,
"siteName": "sitePackageTest597c6",
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": 1233741800,
"accountName": "SanityAccount",
"advertiserId": 1233741800,
"advertiserName": "SanityAdvertiser",
"brandId": 1233741800,
"brandName": "SanityBrand",
"campaignId": 1233741800,
"campaignName": "SanityAdvanceCampaign"
},
"mainClickthrough": {
"type": "MainClickthrough",
"id": 12398182865500,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false,
"Type": "Main Clickthrough",
"iconPanel": [{
"template": "creative/entities/ad/views/sections/clickThrough/clickthroghUrlsExpansion.html",
"showControl": true,
"cssClass": "overrideHide"
}],
"showChild": false,
"targetWindowTypeslookup": [{
"id": "NEW",
"value": "New Window",
"name": "New Window"
}, {
"id": "TOP",
"value": "Top",
"name": "Top"
}, {
"id": "CURRENT",
"value": "Current Frame",
"name": "Current Frame"
}]
},
"adURLs": [],
"pricingSize": 6447,
"overallSize": 6447,
"initialSize": 6447,
"width": 300,
"height": 250,
"dimensions": "300x250",
"templateScriptName": "Html5Banner",
"urlTokens": null,
"minAudioVersion": 0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"qaStatus": "NOT_SUBMITTED",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"servingMethod": null,
"analyticsData": null,
"analyticsSettings": null,
"customFields": {
"type": "CustomFields"
},
"massVersioning": false,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [],
"priorityPolicy": "Server",
"adFeatures": [],
"defaultImage": {
"type": "AdAsset",
"id": 12398182865500,
"relationsBag": null,
"assetId": 1233968900,
"assetName": "Builder_img1.jpg",
"source": true,
"assetStatus": null,
"folderId": 1233791000,
"workspaceFolderId": 1233791000,
"size": 1639,
"duration": null,
"bitRate": null,
"width": 279,
"height": 221,
"mimeType": "image/jpeg",
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/12330581808301813/Builder_img1.jpg",
"external": false,
"dimensions": "279x221"
},
"defaultImageClickthrough": {
"type": "MainClickthrough",
"id": 12398182865500,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false,
"Type": "Default Image Clickthrough",
"iconPanel": [{
"template": "creative/entities/ad/views/sections/clickThrough/clickthroghUrlsExpansion.html",
"showControl": true,
"cssClass": "overrideHide"
}],
"showChild": false,
"targetWindowTypeslookup": [{
"id": "NEW",
"value": "New Window",
"name": "New Window"
}, {
"id": "TOP",
"value": "Top",
"name": "Top"
}, {
"id": "CURRENT",
"value": "Current Frame",
"name": "Current Frame"
}]
},
"banner": null,
"minFlashVersion": 0,
"mxpVersion": null,
"osVersion": null,
"asVersion": null,
"flashIDE": null,
"variables": [],
"html5": {
"type": "AdAssetFolder",
"id": 12398182865500,
"relationsBag": null,
"assetId": 1233791000,
"assetName": "00a412393e1349268aef21079cf3658c_LE225 (4) (6) (2) (2) (2) (3) (2)",
"source": true,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": 6447,
"duration": null,
"bitRate": null,
"width": 0,
"height": 0,
"mimeType": null,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"assets": null,
"archiveManifest": null
},
"tooltip": "",
"authoringTool": "AD_BUILDER",
"downloadMode": "INSTANT",
"initialLoadAsset": null,
"forceClickthrough": false,
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": "EvenDistribution",
"versionTargetingType": "TargetAudience",
"versionBasePath": "UAT/DCO",
"advancedRetargeting": {
"type": "AdvancedRetargeting",
"branchItemClientIds": [],
"advertiserId": null,
"tags": [],
"tagIds": [],
"nodeType": "AdvancedRetargeting"
},
"automaticOptimizationData": null,
"native": false,
"containsNonWorkspaceAssets": false,
"httpStatusCode": 200,
"adStatusName": "New"
}]
}
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated ad resource.
Example
{
"metadata": null,
"debug": null,
"error": [],
"result": [{
"type": "StandardBannerAd",
"id": 1235082900,
"relationsBag": null,
"version": 1231917466173046784,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1236566692654,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 12373741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231917466172,
"name": "00a481233e134926jjjj8aef21079cf3658c (3) (5) (1) (1) (1) (2) (1)",
"masterAdId": 1234573800,
"changed": true,
"adStatus": "NEW",
"enabled": false,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard Banner",
"accountId": 1233741900,
"accountName": "AdBuilderAutomation",
"placementId": 1235360400,
"placementName": "placement_test1_e123303b-2d01-4dda-9bb5-fbb397bbd244",
"placementType": "IN_BANNER",
"siteId": 1073766300,
"siteName": "sitePackageTest597c6",
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": 1233741800,
"accountName": "SanityAccount",
"advertiserId": 1233741800,
"advertiserName": "SanityAdvertiser",
"brandId": 1233741800,
"brandName": "SanityBrand",
"campaignId": 1233741800,
"campaignName": "SanityAdvanceCampaign"
},
"mainClickthrough": {
"type": "MainClickthrough",
"id": 30598182865500,
"relationsBag": null,
"url": "",
"targetWindowType": "NEW",
"showAddressBar": true,
"showMenuBar": true,
"closeAllAdParts": false
},
"adURLs": null,
"pricingSize": 6447,
"overallSize": 6447,
"initialSize": 6447,
"width": 300,
"height": 250,
"dimensions": "300x250",
"templateScriptName": "Html5Banner",
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"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,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [],
"priorityPolicy": "Server",
"adFeatures": [],
"defaultImage": {
"type": "AdAsset",
"id": 30598182865500,
"relationsBag": null,
"assetId": 2073968900,
"assetName": "Builder_img1.jpg",
"source": true,
"assetStatus": null,
"folderId": 1073791000,
"workspaceFolderId": 1073791000,
"size": 1639,
"duration": null,
"bitRate": null,
"width": 279,
"height": 221,
"mimeType": "image/jpeg",
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/24830581808301813/Builder_img1.jpg",
"external": false
},
"defaultImageClickthrough": {
"type": "MainClickthrough",
"id": 30598182865500,
"relationsBag": null,
"url": "",
"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": 30598182865500,
"relationsBag": null,
"assetId": 1073791000,
"assetName": "00a488493e1349268aef21079cf3658c_LE225 (4) (6) (2) (2) (2) (3) (2)",
"source": true,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": 6447,
"duration": null,
"bitRate": null,
"width": 0,
"height": 0,
"mimeType": null,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"assets": [{
"type": "APIAsset",
"id": 2073968900,
"relationsBag": null,
"version": 1571917329967284224,
"createdBy": 1073741800,
"createdByName": "User",
"createdByAccount": 107374182600,
"createdByAccountName": "Account",
"createdOn": 1481035525597,
"lastUpdatedBy": 1073741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1073741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1571917329963,
"assetId": 2073968900,
"parentAssetId": null,
"parentSourceSystem": null,
"assetType": "source",
"mediaType": "HTML",
"mimeType": "text/html",
"storagePath": null,
"publishHostName": "http://resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "UAT/html5/24830581808301813/index.html",
"fileName": "index.html",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 1481035525591,
"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": "1073741900",
"displayName": "index.html",
"userId": "1073741800",
"folderId": "1073791000"
},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 11443,
"format": "html",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 3805
},
"audioStreamContext": null,
"videoStreamContext": null,
"swfContext": null,
"htmlContext": {
"customInteractions": null,
"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\"}];",
"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\":d(a.solidColor);break;case\"gradientColor\":c();break;case\"image\":a.assets.bgImage?e():d(\"#FFFFFF\")}D.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()}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))}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-youtube\")}function i(a){return adkit.getComponentsByType(a)}function j(a,b){Utils.stopPropagation(a);var c=$.extend({panelName:b?b.target:\"\",animate:b?b.animate:\"\",actionType:b?b.actionType:\"\"},b?b.expandTo:\"\");adkit.expand(c)}function k(a,b){Utils.stopPropagation(a),adkit.expand({panelName:b.target,pushdown:!0,animate:b.animate,actionType:b?b.actionType:\"\"})}function l(a,b){Utils.stopPropagation(a),adkit.expand({panelName:b.target,expandToMax:!0,actionType:b?b.actionType:\"\",userData:{id:\"adBuilderFullScreenExpand\",data:b}})}function m(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)};B(e)}adkit.collapse({panelName:b?b.target:\"\",animate:b?b.animate:\"\",actionType:b?b.actionType:\"\"})}function n(a){Utils.stopPropagation(a),adkit.collapse(a)}function o(a){D.trigger(a)}function p(a){a.percentage>=50&&50>E?(E=a.percentage,D.trigger(\"visible\")):a.percentage<50&&E>=50&&(E=a.percentage,D.trigger(\"notVisible\"))}function q(a){D.trigger(\"adLoad\")}function r(a){D.trigger(\"adEnded\")}function s(a){D.trigger(\"skipEnabled\")}function t(a){D.trigger(\"closeEnabled\")}function u(a){D.trigger(\"play\")}function v(a){D.trigger(\"ended\")}function w(a){D.trigger(\"pause\")}function x(a){D.trigger(\"error\")}function y(a,b){return!A(a,z(b)).intersect}function z(a){return document.getElementById(a).getBoundingClientRect()}function A(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 B(a){var b=function(b){var c=i(b);c&&c.forEach(function(b){y(a,b.div.id)&&b.pause()})};b(\"adkit-video\"),b(\"adkit-youtube\")}\"undefined\"!=typeof runAA&&runAA();var C=adkit.getAdInfo(),D=$(\"#adkit-container\"),E=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\",j),$(window).on(\"expandPushdownEvent\",k),$(window).on(\"expandFullScreenEvent\",l),$(window).on(\"collapseEvent\",m),$(window).on(\"closeAllAdPartsEvent\",n),$(window).on(\"swipe\",c),$(window).on(\"shake\",o),\"undefined\"==typeof InteractionsMgr?adkit.draw():(InteractionsMgr.init(),adkit.draw(),InteractionsMgr.saveStageState()),\"InStream\"===C.adType?(adkit.vpaid.onAdStart(q),adkit.vpaid.onAdEnd(r),adkit.vpaid.onSkipEnabled(s),adkit.vpaid.onCloseEnabled(t),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.PLAY,u),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.ENDED,v),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.PAUSE,w),adkit.vpaid.onVideoEvents(adkit.vpaid.VIDEO_EVENTS.ERROR,x)):D.trigger(\"adLoad\"),adkit.onVisibilityChanged(p),adkit.onExpand(function(){D.trigger(\"expandInterEvent\")}),adkit.onCollapse(function(){D.trigger(\"collapseInterEvent\")})}window.Utils=window.Utils||{},Utils.fixURL=function(a){return 0!==a.indexOf(\"http\")?\"http://\"+a:a},Utils.parseURL=function(a){var b=a;return b&&0!==b.indexOf(\"http\")&&0!==b.indexOf(\"https\")&&0!==b.indexOf(\"//\")?b=\"http://\"+b:b&&0!==b.indexOf(\"http\")&&0!==b.indexOf(\"https\")&&0===b.indexOf(\"//\")&&(b=\"http:\"+b),b},Utils.stopPropagation=function(a){a||(a=window.event),a.cancelBubble?a.cancelBubble=!0:a.stopPropagation()},Utils.getInternetExplorerVersion=function(){var a=-1;if(\"Microsoft Internet Explorer\"==navigator.appName){var b=navigator.userAgent,c=new RegExp(\"MSIE ([0-9]{1,}[.0-9]{0,})\");null!=c.exec(b)&&(a=parseFloat(RegExp.$1))}return a},Utils.getIntersection=function(a,b){var c={};return c.intersect=!(a.right<b.left||b.right<a.left||a.bottom<b.top||b.bottom<a.top),c.intersect&&(c.rect={left:Math.max(a.left,b.left),top:Math.max(a.top,b.top),right:Math.min(a.right,b.right),bottom:Math.min(a.bottom,b.bottom)}),c},Utils.isIOS=function(){return navigator.userAgent.match(/(iPad|iPhone|iPod)/g)?!0:!1},Utils.getScript=function(a,b){var c=document.createElement(\"script\");c.type=\"text/javascript\",c.readyState?c.onreadystatechange=function(){(\"loaded\"==c.readyState||\"complete\"==c.readyState)&&(c.onreadystatechange=null,b())}:c.onload=function(){b()},c.src=a;var d=document.getElementsByTagName(\"head\")[0]||document.documentElement;d.appendChild(c)},Utils.loadScripts=function(){function a(){var e=c[b],f=d[e.host]+e.path;Utils.getScript(f,function(){++b>=c.length?hf_kickStart():a()})}if(\"FactoryPreview\"===adkit.environment.mode)return void hf_kickStart();var b=0,c=window.hf_scripts,d=adkit.environment.paths;a()},Utils.parseAsset=function(a){return\"string\"==typeof a&&0==a.search(/^https?:\\/\\//)?a:a==parseInt(a)?EB.getAssetUrl(\"\",a):EB.getAssetUrl(a)},Utils.ifValidAsset=function(a,b){return a.indexOf(b.slice(b.lastIndexOf(\".\")+1))},adkit.onReady(Utils.loadScripts);",
"index": null
}, {
"source": "",
"innerText": "function onInit(params) { if (false) {\n \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": 1233791000,
"html5Manifest": null,
"isExternal": false,
"isRevisionAsset": false,
"sourceUrl": null,
"servingPath": "https://secure-ds.serving-sys-int.com/resources/UAT/html5/12330581808301813/index.html",
"parentFolderName": null,
"accountId": 1233741900,
"userId": 1233741800,
"folderId": 1233791000,
"displayName": "index.html",
"isAutoPlay": false
}, {
"type": "APIAsset",
"id": 1233968900,
"relationsBag": null,
"version": 1231917329968332800,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1231035525606,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231917329964,
"assetId": 1233968900,
"parentAssetId": null,
"parentSourceSystem": null,
"assetType": "source",
"mediaType": "JS",
"mimeType": "application/x-javascript",
"storagePath": null,
"publishHostName": "http://resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "UAT/html5/12340581808301813/config.js",
"fileName": "config.js",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 1231035525600,
"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": "1073741900",
"displayName": "config.js",
"userId": "1233741800",
"folderId": "1233791000"
},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 533,
"format": "js",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 337
},
"audioStreamContext": null,
"videoStreamContext": null,
"swfContext": null,
"htmlContext": null,
"jsContext": {
"customInteractions": null,
"autoPlayTranscodes": null,
"smartElementContainer": null,
"html5Manifest": null
},
"extendedAdProperties": null,
"imageContext": null,
"thumbnails": null,
"relatedProxies": null,
"width": null,
"height": null,
"archiveManifest": [],
"relativePathInWorkspace": "config.js",
"workspaceFolderId": 1233791000,
"html5Manifest": null,
"isExternal": false,
"isRevisionAsset": false,
"sourceUrl": null,
"servingPath": "https://secure-ds.serving-sys-int.com/resources/UAT/html5/24830581808301813/config.js",
"parentFolderName": null,
"accountId": 1233741900,
"userId": 1233741800,
"folderId": 1233791000,
"displayName": "config.js",
"isAutoPlay": false
}, {
"type": "APIAsset",
"id": 2073968900,
"relationsBag": null,
"version": 1231917329966497792,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1231035525621,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231917329962,
"assetId": 1233968900,
"parentAssetId": null,
"parentSourceSystem": null,
"assetType": "source",
"mediaType": "IMAGE",
"mimeType": "image/jpeg",
"storagePath": null,
"publishHostName": "http://resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "UAT/html5/12330581808301813/Builder_img1.jpg",
"fileName": "Builder_img1.jpg",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 1231035525616,
"modifyDateTime": null,
"ingestDateTime": null,
"assetData": null,
"currentVersion": null,
"versionNumber": 0,
"previousVersionAssetID": null,
"assetCode": "Builder_img1.jpg",
"codeType": null,
"title": "Builder_img1.jpg",
"metaSchemaId": null,
"sourceSystemAssetId": null,
"sourceSystem": null,
"businessMetadata": {
"accountId": "1233741900",
"displayName": "Builder_img1.jpg",
"userId": "1233741800",
"folderId": "1233791000"
},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 1639,
"format": "jpg",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 1639
},
"audioStreamContext": null,
"videoStreamContext": null,
"swfContext": null,
"htmlContext": null,
"jsContext": null,
"extendedAdProperties": null,
"imageContext": {
"width": 279,
"height": 221,
"dataPrecision": null,
"compressionType": null,
"extendedProperties": null
},
"thumbnails": [{
"id": 1,
"width": 279,
"height": 221,
"master": null,
"name": null,
"imageFormat": "jpg",
"url": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/html5/12330581808301813/Builder_img1.jpg"
}],
"relatedProxies": null,
"width": 279,
"height": 221,
"archiveManifest": [],
"relativePathInWorkspace": "/Builder_img1.jpg",
"workspaceFolderId": 1233791000,
"html5Manifest": null,
"isExternal": false,
"isRevisionAsset": false,
"sourceUrl": null,
"servingPath": "https://secure-ds.serving-sys-int.com/resources/UAT/html5/24830581808301813/Builder_img1.jpg",
"parentFolderName": null,
"accountId": 1233741900,
"userId": 1233741800,
"folderId": 1233791000,
"displayName": "Builder_img1.jpg",
"isAutoPlay": false
}, {
"type": "APIAsset",
"id": 2133968900,
"relationsBag": null,
"version": 1233917329965383680,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1231035525614,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231917329961,
"assetId": 1233968900,
"parentAssetId": null,
"parentSourceSystem": null,
"assetType": "source",
"mediaType": "TEXT",
"mimeType": "application/json",
"storagePath": null,
"publishHostName": "http://resources-dev-sizmdx.s3.amazonaws.com/",
"publishPath": "UAT/html5/12330581808301813/adDoc.json",
"fileName": "adDoc.json",
"status": "Available",
"mpsVariantId": null,
"mpsJobId": null,
"createUserId": null,
"modifyUserId": null,
"createDateTime": 1231035525608,
"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": "1233741900",
"displayName": "adDoc.json",
"userId": "1233741800",
"folderId": "1233791000"
},
"previousVersion": null,
"formatContext": {
"audioStreamCount": null,
"bitRate": null,
"decodingFailed": null,
"duration": null,
"fileSize": 1728,
"format": "json",
"streamCount": null,
"videoStreamCount": null,
"compressedFileSize": 666
},
"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": 1233791000,
"html5Manifest": null,
"isExternal": false,
"isRevisionAsset": false,
"sourceUrl": null,
"servingPath": "https://secure-ds.serving-sys-int.com/resources/UAT/html5/12330581808301813/adDoc.json",
"parentFolderName": null,
"accountId": 1233741900,
"userId": 1233741800,
"folderId": 1233791000,
"displayName": "adDoc.json",
"isAutoPlay": false
}]
},
"tooltip": "",
"authoringTool": "AD_BUILDER",
"downloadMode": "INSTANT",
"initialLoadAsset": null,
"forceClickthrough": false,
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": "EvenDistribution",
"versionTargetingType": "TargetAudience",
"versionBasePath": "UAT/DCO",
"advancedRetargeting": {
"type": "AdvancedRetargeting",
"branchItemClientIds": [],
"advertiserId": null,
"tags": [],
"tagIds": [],
"nodeType": "AdvancedRetargeting"
},
"automaticOptimizationData": null,
"native": false,
"containsNonWorkspaceAssets": false
}]
}
Update all ads.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
isOverride |
Determines whether to override the placement's ads with changes from the master ad (if the master ad is the one being updated). |
Boolean |
Optional |
|
|
useManifest |
Determines whether to update the ad using ad manifest. |
Boolean |
Optional |
Default value is false. |
|
enrich |
Add various data to the ad entity. |
Integer |
Optional |
PUT https://adapi.sizmek.com/sas/ads?isOverride=false/True
Example
{
"entities": [
{
"type": "StandardBannerAd",
"id": 1233741800,
"clientRefId": null,
"relationsBag": null,
"version": 1231832788603633664,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 1233741800,
"createdByAccountName": "Account",
"createdOn": 1231643829499,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1231832788602,
"name": "SanityStandardBannerAd",
"masterAdId": 0,
"changed": false,
"adStatus": "NEW",
"enabled": true,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard Banner",
"accountId": 1233741800,
"accountName": "Account",
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": "",
"advertiserId": null,
"advertiserName": "",
"brandId": null,
"brandName": "",
"campaignId": null,
"campaignName": ""
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 36347,
"overallSize": 36347,
"initialSize": 36347,
"width": 300,
"height": 250,
"templateScriptName": "StdBanner",
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": "BOTTOM_LEFT",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"feedStatus": null,
"adFeatures": [
],
"videoAudioAdAssetData": [
],
"defaultImage": {
"type": "AdAsset",
"id": 12363093534700,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"assetId": 2073741800,
"assetName": "oldAsset-d79f9f8a-d366-45b0-a2e8-1234ec459644",
"assetStatus": null,
"folderId": 1233741800,
"workspaceFolderId": 0,
"size": 36347,
"duration": null,
"width": 300,
"height": 250,
"mediaType": "IMAGE",
"format": null,
"thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/CI/asset/1073741826/IMAGE/12391021/CRT_QAPositiveImage_12353055578390537.jpg",
"external": false,
"source": true
},
"defaultImageClickthrough": null,
"banner": null,
"minFlashVersion": 0.0,
"mxpVersion": null,
"osVersion": null,
"asVersion": null,
"flashIDE": null,
"variables": null,
"html5": null,
"tooltip": null,
"authoringTool": null,
"downloadMode": "INSTANT",
"initialLoadAsset": "PRELOAD_IMAGE",
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [
],
"catalog": null
},
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": "EvenDistribution",
"versionTargetingType": "TargetAudience",
"versionBasePath": "CI/DCO",
"advancedRetargeting": null,
"automaticOptimizationData": null,
"native": false,
"containsNonWorkspaceAssets": true
}
]
}
Example
{
"metadata": null,
"debug": null,
"error": [],
"result": [{
"type": "StandardBannerAd",
"id": 1235747300,
"relationsBag": null,
"version": 1239196439758438400,
"createdBy": 1233741800,
"createdByName": "User",
"createdByAccount": 123741800,
"createdByAccountName": "Account",
"createdOn": 1239170641244,
"lastUpdatedBy": 1233741800,
"lastUpdatedByName": "User",
"lastUpdatedByAccount": 1233741800,
"lastUpdatedByAccountName": "Account",
"lastUpdateOn": 1239196439758,
"name": "StandardBannerAsd0OkX8DAjW4",
"masterAdId": 0,
"changed": true,
"adStatus": "PUBLISHED",
"enabled": true,
"adFormat": "STANDARD_BANNER_AD",
"adFormatId": 42,
"adFormatName": "Standard
Banner ","
accountId ":1233741800,"
accountName ":"
SanityAccount ","
placementId ":null,"
placementName ":null,"
placementType ":null,"
siteId ":null,"
siteName ":null,"
adAssignmentData ":{"
type ":"
AdAssignmentData ","
accountId ":1233741800,"
accountName ":"
SanityAccount ","
advertiserId ":1233741800,"
advertiserName ":"
SanityAdvertiser ","
brandId ":1233741800,"
brandName ":"
SanityBrand ","
campaignId ":1233741800,"
campaignName ":"
SanityCampaign "},"
mainClickthrough ":{"
type ":"
MainClickthrough ","
id ":12351114250875,"
relationsBag ":null,"
url ":"
","
targetWindowType ":"
NEW ","
showAddressBar ":true,"
showMenuBar ":true,"
closeAllAdParts ":false},"
adURLs ":[{"
type ":"
ThirdPartyURL ","
id ":1233741825,"
relationsBag ":null,"
url ":"
sdcsdcsdcdsc ","
urlType ":"
CLICK_TRACKING ","
enabled ":false,"
urlSource ":"
CAMPAIGN ","
externalId ":"
1 ","
uniqueIdentifier ":"
CLICK_TRACKING_1 ","
customScriptId ":null,"
disableServing ":false}],"
pricingSize ":36347,"
overallSize ":36347,"
initialSize ":36347,"
width ":300,"
height ":250,"
dimensions ":"
300 x250 ","
templateScriptName ":"
StdBanner ","
urlTokens ":"
PQq1dl7OCF ","
minAudioVersion ":0.7186959559073236,"
fourthPartyTag ":"
","
adChoicesStatus ":false,"
adChoicesLocation ":"
BOTTOM_LEFT ","
qaStatus ":"
NOT_SUBMITTED ","
numberOfPlacementAds ":7,"
overallNumberOfPlacementAds ":7,"
servingMethod ":null,"
analyticsData ":{"
impressions ":5,"
clicks ":0,"
lastUpdated ":1239170996000,"
ctr ":0.0,"
actualStartDate ":null},"
analyticsSettings ":null,"
customFields ":null,"
massVersioning ":false,"
usedAsTemplate ":false,"
unSavedTemplateAd ":false,"
adTemplateId ":null,"
feedEnabled ":null,"
feedStatus ":null,"
enableTimeBasedServing ":false,"
servingTimeZoneType ":null,"
videoAudioAdAssetData ":[],"
priorityPolicy ":"
Server ","
adFeatures ":[],"
defaultImage ":{"
type ":"
AdAsset ","
id ":12362633371200,"
relationsBag ":null,"
assetId ":1234004000,"
assetName ":"
CRT_QApositiveImage.jpg ","
source ":true,"
assetStatus ":null,"
folderId ":-1,"
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/UAT/source/1073741826/IMAGE/1236122711525958/CRT_QApositiveImage.jpg","external":false},"defaultImageClickthrough":{"type":"MainClickthrough","id":27051114250800,"relationsBag":null,"url":"","targetWindowType":"NEW","showAddressBar":true,"showMenuBar":true,"closeAllAdParts":false},"banner":null,"minFlashVersion":0.0,"mxpVersion":"v3J2egDDz7","osVersion":"8r3Q6SBJPf","asVersion":"lUIsUA80QN","flashIDE":"Q4Pvw6aOOy","variables":null,"html5":null,"tooltip":"ByOoZbLbGH","authoringTool":null,"downloadMode":"INSTANT","initialLoadAsset":"PRELOAD_IMAGE","forceClickthrough":false,"adSmartVersionSchema":{"type":"APIAdSmartVersionSchema","id":null,"smartElements":[],"catalog":null},"disableIncomplete":false,"enableRetargeting":false,"rotationType":"EvenDistribution","versionTargetingType":"TargetAudience","versionBasePath":"UAT/DCO","advancedRetargeting":null,"automaticOptimizationData":null,"native":false,"containsNonWorkspaceAssets":true}]}
Creates and returns an ad based on a manifest.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
Body |
Request containing ad to create. |
JSON |
Required |
POST https://adapi.sizmek.com/sas/ads/generateFromManifest/
Example
{
"entities": [
{
"type": "HTML5ExpandableBannerAd",
"id": null,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "tempName",
"masterAdId": null,
"changed": false,
"adStatus": "NEW",
"enabled": false,
"adFormat": "HTML5_EXPANDABLE_BANNER_AD",
"adFormatId": 1233742800,
"adFormatName": null,
"accountId": 1233741800,
"accountName": null,
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": null,
"advertiserId": null,
"advertiserName": null,
"brandId": null,
"brandName": null,
"campaignId": null,
"campaignName": null
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 0,
"overallSize": 0,
"initialSize": 0,
"width": 0,
"height": 0,
"templateScriptName": null,
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"analyticsData": null,
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"servingMethod": null,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"feedStatus": null,
"adFeatures": null,
"videoAudioAdAssetData": null,
"defaultImage": {
"type": "AdAsset",
"id": null,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"assetId": 2073750700,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"source": false
},
"defaultImageClickthrough": null,
"additionalAssets": null,
"customInteractions": null,
"performAutoVideoTranscoding": false,
"adTranscodingStatus": null,
"variables": [
{
"type": "Variable",
"id": 12396960174000,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"key": "mmkey1",
"dataType": "STRING",
"displayName": "llFzliv7cV",
"description": "o5ezGcdtUm",
"defaultValue": "String",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 12396960174000,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"key": "mmkey2",
"dataType": "INTEGER",
"displayName": "CApsbt7bL3",
"description": "5pYVAOODRh",
"defaultValue": "5",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 12396960174000,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"key": "mmkey3",
"dataType": "FLOAT",
"displayName": "HPCTyQ1Kwe",
"description": "7KVy4xoUYC",
"defaultValue": "4.2",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 26596960174000,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"key": "mmkey4",
"dataType": "BOOLEAN",
"displayName": "Qm2sRe8tyL",
"description": "iCSt3Q8xNc",
"defaultValue": "true",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
}
],
"html5": {
"type": "AdAssetFolder",
"id": null,
"clientRefId": null,
"relationsBag": null,
"uiPermissions": null,
"version": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"assetId": 1233741800,
"assetName": null,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"width": 0,
"height": 0,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"source": false
},
"authoringTool": null,
"allowHTML5DynamicExpansion": false,
"adSmartVersionSchema": null,
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": null,
"versionTargetingType": null,
"initialLoadAsset": "PRELOAD_IMAGE",
"versionBasePath": "",
"advancedRetargeting": null,
"automaticOptimizationData": null,
"panels": null,
"panelsSettings": {
"type": "PanelsSettings",
"panelFrequency": "ONCE_IN_CAMPAIGN",
"panelFrequencyTimes": 1,
"multiplePanels": true,
"autoExpandDefaultPanel": false,
"defaultPanelAutoExpansion": null,
"preloadPanels": false,
"hides": null,
"panelPixelOffsetsX": 0,
"expandedPanelHeight": 0,
"panelPixelOffsetsY": 0,
"expandedPanelWidth": 0
},
"downloadMode": "INSTANT",
"native": false,
"containsNonWorkspaceAssets": true
}
]
}
Example
{
"metadata": null,
"debug": null,
"error": [],
"result": [
{
"type": "HTML5ExpandableBannerAd",
"id": 0,
"relationsBag": null,
"createdBy": null,
"createdByName": null,
"createdByAccount": null,
"createdByAccountName": null,
"createdOn": null,
"lastUpdatedBy": null,
"lastUpdatedByName": null,
"lastUpdatedByAccount": null,
"lastUpdatedByAccountName": null,
"lastUpdateOn": null,
"name": "tempName",
"masterAdId": 0,
"changed": false,
"adStatus": "NEW",
"enabled": false,
"adFormat": "HTML5_EXPANDABLE_BANNER_AD",
"adFormatId": 1073742821,
"adFormatName": null,
"accountId": 1233741827,
"accountName": null,
"placementId": null,
"placementName": null,
"placementType": null,
"siteId": null,
"siteName": null,
"adAssignmentData": {
"type": "AdAssignmentData",
"accountId": null,
"accountName": "",
"advertiserId": null,
"advertiserName": "",
"brandId": null,
"brandName": "",
"campaignId": null,
"campaignName": ""
},
"mainClickthrough": null,
"adURLs": null,
"pricingSize": 0,
"overallSize": 0,
"initialSize": 0,
"width": 0,
"height": 0,
"dimensions": "0x0",
"templateScriptName": null,
"urlTokens": null,
"minAudioVersion": 0.0,
"fourthPartyTag": "",
"adChoicesStatus": false,
"adChoicesLocation": null,
"qaStatus": "NOT_SUBMITTED",
"numberOfPlacementAds": 0,
"overallNumberOfPlacementAds": 0,
"servingMethod": null,
"analyticsData": {
"impressions": null,
"clicks": null,
"lastUpdated": null,
"ctr": null,
"actualStartDate": null
},
"analyticsSettings": null,
"customFields": null,
"massVersioning": false,
"usedAsTemplate": false,
"unSavedTemplateAd": false,
"adTemplateId": null,
"feedEnabled": null,
"feedStatus": null,
"enableTimeBasedServing": false,
"servingTimeZoneType": null,
"videoAudioAdAssetData": [],
"priorityPolicy": "Server",
"adFeatures": [],
"defaultImage": {
"type": "AdAsset",
"id": null,
"relationsBag": null,
"assetId": 1233750700,
"assetName": null,
"source": false,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": null,
"duration": null,
"bitRate": null,
"width": 0,
"height": 0,
"mimeType": null,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null
},
"defaultImageClickthrough": null,
"additionalAssets": null,
"customInteractions": null,
"performAutoVideoTranscoding": false,
"adTranscodingStatus": null,
"variables": [
{
"type": "Variable",
"id": 12396960174000,
"relationsBag": null,
"key": "mmkey1",
"dataType": "STRING",
"displayName": "llFzliv7cV",
"description": "o5ezGcdtUm",
"defaultValue": "String",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 26596960174081,
"relationsBag": null,
"key": "mmkey2",
"dataType": "INTEGER",
"displayName": "CApsbt7bL3",
"description": "5pYVAOODRh",
"defaultValue": "5",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 12396960174000,
"relationsBag": null,
"key": "mmkey3",
"dataType": "FLOAT",
"displayName": "HPCTyQ1Kwe",
"description": "7KVy4xoUYC",
"defaultValue": "4.2",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
},
{
"type": "Variable",
"id": 26596960174000,
"relationsBag": null,
"key": "mmkey4",
"dataType": "BOOLEAN",
"displayName": "Qm2sRe8tyL",
"description": "iCSt3Q8xNc",
"defaultValue": "true",
"mandatory": true,
"showInAdPage": true,
"variableSource": "CUSTOM_AD_FORMAT"
}
],
"downloadMode": "INSTANT",
"html5": {
"type": "AdAssetFolder",
"id": null,
"relationsBag": null,
"assetId": 1233741800,
"assetName": null,
"source": false,
"assetStatus": null,
"folderId": null,
"workspaceFolderId": null,
"size": 0,
"duration": null,
"bitRate": null,
"width": 0,
"height": 0,
"mimeType": null,
"mediaType": null,
"format": null,
"thumbnailUrl": null,
"external": null,
"assets": null
},
"authoringTool": null,
"allowHTML5DynamicExpansion": false,
"adSmartVersionSchema": {
"type": "APIAdSmartVersionSchema",
"id": null,
"smartElements": [],
"catalog": null
},
"disableIncomplete": false,
"enableRetargeting": false,
"rotationType": "EvenDistribution",
"versionTargetingType": "TargetAudience",
"versionBasePath": "",
"initialLoadAsset": "PRELOAD_IMAGE",
"advancedRetargeting": null,
"automaticOptimizationData": null,
"panels": null,
"panelsSettings": {
"type": "PanelsSettings",
"panelFrequency": "ONCE_IN_CAMPAIGN",
"panelFrequencyTimes": 1,
"multiplePanels": true,
"defaultPanelAutoExpansion": "USE_AD_CREATIVE_SETTINGS",
"preloadPanels": false,
"expandedPanelWidth": 0,
"expandedPanelHeight": 0,
"panelPixelOffsetsX": 0,
"panelPixelOffsetsY": 0
},
"native": false,
"containsNonWorkspaceAssets": true
}
]
}
The following table lists the possible HTTP status codes in responses.
|
Error Code |
String |
Notes |
|---|---|---|
|
50001 |
Failed to save ads {id} - {id}. |
|
|
50002 |
Failed to retrieve ads {id} - {id}. |
|
|
50003 |
Failed to retrieve ads {id} - {id}. |
|
|
50004 |
Failed to retrieve all ads - {id}. |
|
|
50005 |
Failed to retrieve all ads in campaign ID {id}. |
|
|
50006 |
Failed to retrieve all ads in account ID {id}. |
|
|
50007 |
Failed to delete ad {id}. |
|
|
50008 |
Failed to update ads {id} - {id}. |
|
|
50009 |
Failed to copy ads {id} - {id}. |
|
|
50010 |
Failed to assign master ads {id} to {id} - {id}. |
|
|
50011 |
Failed to unassign master ads {id} - {id}. |
|
|
50012 |
Failed to attach master ad {id} to placements {id} - {id}. |
|
|
50013 |
Failed to retrieve placement ads for master ad {id}. |
|
|
50014 |
Failed to retrieve placement ads according to placement ID {id}. |
|
|
50015 |
Failed to retrieve and change status {id} of placement ads attached to master ad {id}. |
|
|
50016 |
Failed to retrieve Account with ads in campaign ID {0} and account ID {1}. |
|
|
50017 |
Failed to save master ads {id} - {id}. |
|
|
50018 |
Failed to calculate ad size for ad {id}. |
|
|
50019 |
Failed to detach tracking ad from placement: {id} |
|
|
50019 |
Master ad ID {id} with placement ID {id} does not have placement ads - {id}. |
(Both listed in automation as 50019.) |
|
50020 |
Failed to assign master ads to campaign {0} - {1}. |
|
|
50021 |
Failed to unassign master ads from campaign {0} - {1}. |
|
|
50022 |
Failed to merge custom interactions between request and database. |
|
|
50023 |
Failed to determine if the ad could be updated. |
|
|
50024 |
Failed to detach master ad {0} from placements {1} - {2}. |
|
|
50025 |
Failed to update asset. |
|
|
50026 |
Failed to delete asset. |
|
|
50027 |
Failed to validate ad. |
|
|
50028 |
Failed to save ad QA requests: {0} - {1}. |
|
|
50029 |
Failed to delete ad QA request: {0}. |
|
|
50030 |
Failed to update ad QA request: {0} - {1} |
|
|
50031 |
The asset video auto-transcoding job failed. |
|
|
50032 |
Failed to determine the number of placement ads attached to the master ad ID {0}. |
|
|
50033 |
The assigned entity type should be either an Account Advertiser Campaign or Brand. |
|
|
50034 |
Failed to change ad assignment. Ad {id} has placement ads. |
|
|
50035 |
Failed to change ad assignment. Ad {id} name used in campaign. |
|
|
50036 |
Failed to change ad assignment. Ad {id} does not exist. |
|
|
50037 |
Failed to change ad assignment. Ad {id} name. |
|
|
50038 |
No placement ads of the master ad ID {id} in placement ID {id} was found. |
|
|
50039 |
Failed to change ad assignment. Ad {id} is already {string}. |
|
|
50040 |
Failed to publish ad. Ad %s does not exist. |
|
|
50041 |
Failed to publish ad. Master ad {id} cannot by published. |
|
|
50042 |
Failed to publish ad. Ad {id} not attached. |
|
|
50043 |
Failed to {0} ad. Ad {1} does not exist. |
|
|
50044 |
Failed to calculate ad dimensions for ad {0} {1}. |
|
|
50045 |
Failed to generate the default panel using asset for ad {0} - {1}. |
|
|
50046 |
Failed to encode tag for ad {0}. |
|
|
50047 |
Failed to find the main HTML file in the Workspace. |
|
|
50048 |
Failed to create test page. |
|
|
50050 |
Ads {0} not found. |
|
|
50051 |
Campaigns {0} not found. |
|
|
50052 |
Accounts {0} not found. |
|
|
50053 |
Assets {0} not found. |
|
|
50054 |
Placements {0} not found. |
|
|
50055 |
Failed to determine Orch Type. Missing Orch Types Enum value for {0}. |
|
|
50056 |
PrimaryCreativeAgency(s) {0} not found. |
|
|
50057 |
AssetFolders {0} not found. |
|
|
50075 |
Failed to determine Orch Type. Missing Orch Types Enum value for {0}. |
|
|
50076 |
Ad QA requests {0} not found. |
|
|
50077 |
Ad formats {0} not found. |
|
|
50078 |
Failed to get the latest ad QA infos for ids: {id}. |
|
|
50079 |
Ad QA info(s) {0} not found. |
|
|
50080 |
Failed to save ad QA info {id} - {id}. |
|
|
50081 |
failed to delete ad QA info: {id}. |
|
|
50082 |
Failed to update ad QA info {id} - {id}. |
|
|
50083 |
Missing campaign manager account ID on ad assignment data of ad {id}. |
|
|
50084 |
Failed to duplicate ad: {0}. |
|
|
50085 |
Duplicating placement ad {0} is not allowed. |
|
|
50086 |
Ad {0} does not contain asset {1}. |
|
|
50087 |
Ad templates {0} not found. |
|
|
50088 |
No ad templates were found. |
|
|
50089 |
Ads {id} and {id} for QA must have the same advertiser and media agency. |
|
|
50090 |
Failed to change the ad assignment. Ad {0} is attached to a delivery group {1}. |
|
|
51001 |
Missing ad name. |
|
|
51018 |
The panel name is not unique {0}. |
|
|
51019 |
The additional asset name is not unique {0}. |
|
|
51020 |
The additional asset is a duplicate {0}. |
|
|
51021 |
Placement ID is missing. |
|
|
51022 |
Additional asset size exceeds the limit of {0}. Please replace the asset. |
|
|
51023 |
The ad size exceeds the size limit. Please consider removing some assets from ad. |
|
|
51024 |
Null value in {string}. |
|
|
51025 |
Panel size exceeds the limit of {0}. Please replace it. |
|
|
51026 |
The default image size exceeds the limit of {id}. Please replace it. |
|
|
51027 |
The Preload banner size exceeds the limit of {id}. Please replace it. |
|
|
51028 |
The Rich Media banner size exceeds the limit of {id}. Please replace it. |
|
|
51029 |
The HTML5 Workspace size exceeds the limit of {id}. Please replace it. |
|
|
51030 |
Panel file type {id} not allowed. Please replace it. |
|
|
51031 |
Additional asset file type {id} not allowed. Please replace it. |
|
|
51032 |
Default image file type {id} not allowed. Please replace it. |
|
|
51033 |
Preload banner file type {id} not allowed. Please replace it. |
|
|
51034 |
The HTML5 Workspace file type {id} not allowed. Please replace it. |
|
|
51035 |
The Rich Media banner file type {id} not allowed. Please replace it. |
|
|
51036 |
Property {id} cannot be changed in the {string} operation. |
|
|
51037 |
Update is denied. Select only ads with the same format type. |
|
|
51038 |
Update is denied. Selected ads include both master and placement ads. |
|
|
51039 |
The panel name exceeds the limit of {0} characters. |
|
|
51040 |
The additional asset name exceeds the limit of {0} characters. |
|
|
51041 |
Ad {0} is not applicable to placement {1}. |
|
|
51042 |
The AdFormat field does not match the Ad Entity type. |
|
|
51043 |
The tooltip is limited to 250 characters. |
|
|
51044 |
The number of panels exceeds the limit. Please remove some panels. |
|
|
51045 |
The number of custom interactions exceeds the limit. Please remove some custom interactions. |
|
|
51047 |
The name {name} is already used in ad ({id}). |
|
|
51048 |
The '{name}' name is used in Campaign (Ad {id}). |
|
|
51049 |
You cannot edit the placement ad name. |
|
|
51050 |
{0} |
|
|
51051 |
Assets must be set as linears or non-linears. |
|
|
51052 |
You cannot change the placement ID for ad {id}. |
|
|
51053 |
You cannot modify the data for ad {id}. |
|
|
51054 |
The placement ID property must be null for master ad - ad {id}. |
|
|
51055 |
The {id} placement ad must contain a placement ID. |
|
|
51056 |
Cannot change the master ad ID for placement ad - ad {id}. |
|
|
51057 |
Cannot change the ad format for ad {id}. |
|
|
51058 |
Failed to delete ad {id}. Only master ads can be deleted. |
|
|
51059 |
Failed to delete ad {id}. Ad is attached to a placement. |
|
|
51060 |
Failed to delete ad {id}. Tracking pixel ads cannot be deleted. |
|
|
51061 |
Changing the status for ad {0} is denied. |
|
|
51062 |
Failed to {0} ad. MasterAd cannot be {1}. |
|
|
51063 |
Failed to delete ad due to impressions {0} - ({1} impressions). |
|
|
51064 |
The 1st party ad ID cannot be null or empty when generate multiple tags is false - placement ID {0}. |
|
|
51065 |
The placement {0} contains duplicate 1st party ad IDs. |
|
|
51066 |
The 1st party ad ID token cannot be null or empty when generate multiple tags is false - placement ID {0}. |
|
|
51067 |
The linears do not contain actual linear objects. |
|
|
51068 |
AS3 is required when creating Flash ads. |
|
|
51069 |
The In-Stream ad contains an incorrect asset type. |
|
|
51070 |
The In-Stream Interactive linears contain too many HTML5 assets. |
|
|
51071 |
The linear exceeds the size limit of {0}. Please replace it. |
|
|
51073 |
The non-linear size exceeds the size limit of {0}. Please replace it. |
|
|
51074 |
The companion size exceeds the limit of {0}. Please replace it. |
|
|
51075 |
The name '{0}' is already used in this Save Request (Ad {1}). |
|
|
51076 |
Linear duration setting should be an integer. |
|
|
51077 |
Linear duration setting should be greater than 0. |
|
|
51078 |
Ad {0} cannot be deleted. It is currently assigned to multiple delivery groups {1}. |
|
|
51079 |
An incorrect asset type has been assigned to your In-Stream companion. |
|
|
51080 |
An incorrect asset type has been assigned to your In-Stream non-linears. |
|
|
51081 |
In-Stream ads can have only one event of the type {0}. |
|
|
51082 |
Additional Asset Name cannot be null or empty. |
|
|
51083 |
Creation date or Creator ID cannot not be changed. |
|
|
51084 |
Advanced Companion of type {0} is not a supported format (Ad ID {1}). |
|
|
51085 |
Advanced Companion {0} does not exist. |
|
|
51092 |
You cannot change the site ID for ad {0}. |
|
|
52001 |
User not permitted to perform action. |
|
|
52002 |
User not permitted to perform {0} on entity {1} with ID {2}. |
|
|
52003 |
Failed to apply data ownership to {0} with ID {1}. |
|
|
53001 |
Failed to create AdConfig for ad {0} - {1}. |
|
|
53002 |
Failed to update AdConfig for ad {0}. |
|
|
53003 |
Failed to save AdConfig for ad {0}. |
|
|
53004 |
Failed to delete AdConfig for ad {0}. |
|
|
53005 |
Failed to retrieve AdConfig for ad {0}. |
|
|
53006 |
Failed to find an In-Stream template for {0}. |
|
|
53007 |
Failed to retrieve VAST variables for XSLT file. |
|
|
53008 |
Failed to retrieve the following In-Stream template parameters {0}. |
|
|
53009 |
Failed to save the In-Stream template due to unsupported characters. |
|
|
53050 |
AdConfig {0} not found. |
|
|
54001 |
{0} custom interactions were added and {0} were deleted because custom interactions are included in assets. |
|
|
54002 |
Asset video auto-transcoding failed due to {0}. |
|
|
54003 |
Asset video auto-transcoding failed for ad {0} due to {1}. |
|
|
55001 |
The default panel cannot be set by the user. |
|
|
55002 |
Failed to run specific format logic for ad {0} - {1}. |
|
|
55003 |
You can only set a single default panel for the ad. |
|
|
55004 |
A default panel was not set. |
|
|
55005 |
Asset {0} is cannot be used in more than one panel. |
|
|
55006 |
The format name is already being used. Please enter a new format name. |
|
|
55007 |
Name {0} is already in use by custom ad format{1}. Please use a different name. |
|
|
55008 |
Ad format data is missing from the ad. |
|
|
55009 |
Custom ad format id %s does not exist. |
|
|
55010 |
Failed to run custom ad format validation for ad {0} - {1}. |
|
|
55011 |
Ad format id {0} does not belong to the specified base ad format {1}. |
|
|
55012 |
Changing enhanced option from {0} to {1} for ad %s is not allowed. |
|
|
55013 |
The Enhanced In-Stream ad format does not support an SWF asset with interactions. Please use the In-Stream interactive ad format. |
|
|
55014 |
Failed to validate custom ad format. |
|
|
55015 |
Base ad format cannot be changed. |
|
|
55016 |
Format name cannot be changed. |
|
|
55017 |
Formats that are available to all platform accounts cannot be selected for specific accounts. |
|
|
55018 |
Failed to apply data ownership. |
|
|
55019 |
The number of scripts exceeds the maximum limit of 5. Please remove some scripts. |
|
|
55020 |
Failed to run custom ad format logic for ad {0} - {1}. |
|
|
55021 |
Variable with key {0} is defined more than once. |
|
|
55022 |
Only the default value for a variable can be changed. |
|
|
55023 |
Variable key {0} is not compliant with JavaScript requirements. |
|
|
55024 |
Variable with key {0} has a default value ({1}) that is not of type {2}. |
|
|
55025 |
Variable with key {0} default value cannot be empty when the mandatory property is set to 'true'. |
|
|
55026 |
The Mandatory Field parameter for Variable key {0} is selected therefore the Show in Ad UI parameter must also be selected. |
|
|
55027 |
Please enter a default value for Variable Key {0}. |
|
|
55028 |
'id' is not in the custom ad format range. |
|
|
55029 |
Custom ad format with id {0} already exists. |
|
|
55030 |
The In-Stream template ID {0} does not exist. |
|
|
55031 |
A Standard Banner ad cannot include video assets. Please remove the asset and update the Workspace or select a different format. |
|
|
55032 |
The ad {0} can not be attached because it is not assigned to a campaign. |
|
|
55033 |
Ad {0} must have panel settings. |
|
|
55034 |
Ad {0} must have a workspace defined to support polite loading. |
|
|
55035 |
Ad {0} must have an initial asset selected in order to support polite loading. |
|
|
55036 |
Ad {0} must have Download mode selected in order to support instant/polite loading |
|
|
55038 |
Event {0} cannot be defined more than once. |
|
|
55039 |
Event {0} cannot be defined for this ad format. |
|
|
55040 |
Ad template with ID %s already exists. |
|
|
55041 |
Templates marked as available to all accounts cannot have assigned accounts. |
|
|
55042 |
Failed to validate this ad template. |
|
|
55043 |
Number of applicable authoring tools cannot be 0. Please add at least one. |
|
|
55044 |
The internal ad data ID does not match the template ID. |
|
|
55045 |
The user-defined ID is supported only for migrated custom ad formats. |
|
|
55046 |
Accounts Availability and Applicable Accounts mismatch. |
|
|
55047 |
Accounts Availability does not support this option. |
|
|
55048 |
The provided ad format and the ad format set in the Manifest file do not match. |
|
|
55049 |
Safety check failure. |
|
|
55050 |
Asset {0} cannot be deleted since it is being used by ad {1}. |
|
|
55051 |
Workspace {0} cannot be deleted since it is being used by ad {1}. |
|
|
55053 |
Asset {0} is not part of the HTML5 workspace used in this ad. |
|
|
56001 |
Failed to save custom ad format {0} - {1}. |
|
|
56002 |
Failed to retrieve all custom ad formats - {0}. |
|
|
56003 |
Failed to update custom ad format {0} - {1}. |
|
|
56004 |
Failed to delete custom ad format {0}. |
|
|
56006 |
HTML5 folder {0} not contain the index.html file. |
|
|
56007 |
Failed to initialize ad events combinations. |
|
|
56008 |
Ad event {0} exceeds instance count limit of {1}. |
|
|
56009 |
Ad event {0} was not passed to the placement ad because it does not meet the include/exclude site condition. |
|
|
56010 |
Failed to publish detach message for placement {0}. |
|
|
56011 |
Failed to publish ad {0}. |
|
|
56014 |
Failed to get ad template {0}. |
|
|
56015 |
Failed to get all ad templates - {0}. |
|
|
56016 |
Failed to get ad templates {0} - {1}. |
|
|
56017 |
Failed to save ad template {0} - {1}. |
|
|
56018 |
Failed to update ad template {0} - {1}. |
|
|
56020 |
Failed to get the templates assets folder. |
|
|
56021 |
Failed to create a folder for the template assets. |
|
|
56023 |
Failed to propagate Manifest file data into the ad. |
|
|
56024 |
Failed to find the Manifest file in the selected Workspace. |
|
|
56025 |
Failed to propagate basic ad properties configured in the Manifest file. |
|
|
56026 |
Failed to propagate polite loading ad properties configured in the Manifest file. |
|
|
56027 |
Failed to propagate panels settings configured in the Manifest file. |
|
|
56028 |
Failed to propagate custom interactions configured in the Manifest File. |
|
|
56029 |
Failed to propagate default image configured in the Manifest File. |
|
|
56030 |
No ads were found that meet the search criteria. |
|
|
56031 |
Failed to get ads by asset IDs {0}. |
|
|
56032 |
Failed to get ads by workspace IDs {0}. |
Comments