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 multiple versions of a specific ad. Can be filtered according to query parameters.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
from |
Starting index by which to fetch new version (for paging purposes). |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
|||||||||||||||||||||||||||||||||||||||
max |
Maximum number of versions to fetch (for each page). |
Long |
Required |
||||||||||||||||||||||||||||||||||||||||
q |
Filtering options for the request (see here). |
String |
Optional |
Example of query string: q={"1":{"RECENT":["1519203216427-1526889216427"]},"2":{"NAME":["smith"]}} NoteNote: The date is according to the Unix epoch timestamp. View values
|
|||||||||||||||||||||||||||||||||||||||
order |
Sort order ASC or DESC, required if sort field name is specified (see here). |
String |
Optional NoteNote: Required if a sort field name is specified. |
By default, the API response is ascending. |
GET https://adapi.sizmek.com/sas/dco?from=0&masterAdId=<AD_ID>&max=250&order=asc&sort=id
{ "metadata": { "total": 6 }, "debug": null, "error": null, "result": [{ "type": "AdSmartVersion", "id": 1082405200, "clientRefId": "0", "relationsBag": null, "version": 1486566765620428800, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486504800000, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1486566765619, "schema": { "type": "APIAdSmartVersionSchema", "id": 15237784289300, "smartElements": [{ "type": "AdSmartImageElement", "id": 15237784289300, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "c60/36/36/1rgc2otz1fhkws5", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": null, "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157200, "relationsBag": null, "subDeliveryGroupId": "3c90f932e9f457ff09239f06d7c8431a", "sdgNumericId": 1073803500, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 10007, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "TA", "mediaTargetingId": 1073761000, "datesRange": [], "targetAudienceMetaData": [] }, "defaultImage": { "type": "AdAsset", "id": null, "relationsBag": null, "assetId": null, "assetName": "", "source": true, "assetStatus": null, "folderId": null, "workspaceFolderId": null, "size": null, "duration": null, "bitRate": null, "width": 0, "height": 0, "mimeType": null, "mediaType": "Image", "format": null, "thumbnailUrl": "", "external": null }, "defaultImageClickthrough": null, "name": "Sizmek", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 146600, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }, { "type": "AdSmartVersion", "id": 1082405228, "clientRefId": "1", "relationsBag": null, "version": 1486566727743373312, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486566727741, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1486566727741, "schema": { "type": "APIAdSmartVersionSchema", "id": 15352605458400, "smartElements": [{ "type": "AdSmartImageElement", "id": 15352605458400, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "470/36/36/1rgc2oxind7dzjx", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "1082405200", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157200, "relationsBag": null, "subDeliveryGroupId": "3c90f932e9f457ff09239f06d7c8431a", "sdgNumericId": 1073803500, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 10007, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [] }, "defaultImage": { "type": "AdAsset", "id": null, "relationsBag": null, "assetId": null, "assetName": "", "source": true, "assetStatus": null, "folderId": null, "workspaceFolderId": null, "size": null, "duration": null, "bitRate": null, "width": 0, "height": 0, "mimeType": null, "mediaType": "Image", "format": null, "thumbnailUrl": "", "external": null }, "defaultImageClickthrough": null, "name": "Sizmek2", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 146600, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }, { "type": "AdSmartVersion", "id": 1082405200, "clientRefId": "2", "relationsBag": null, "version": 1486566727745273856, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486566727743, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1486566727743, "schema": { "type": "APIAdSmartVersionSchema", "id": 15352605458443, "smartElements": [{ "type": "AdSmartImageElement", "id": 15352605458400, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "ed0/36/36/1rgc2p129ax729p", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "1082405200", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157200, "relationsBag": null, "subDeliveryGroupId": "3c90f932e9f457ff09239f06d7c8431a", "sdgNumericId": 1073803500, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 10007, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [] }, "defaultImage": { "type": "AdAsset", "id": null, "relationsBag": null, "assetId": null, "assetName": "", "source": true, "assetStatus": null, "folderId": null, "workspaceFolderId": null, "size": null, "duration": null, "bitRate": null, "width": 0, "height": 0, "mimeType": null, "mediaType": "Image", "format": null, "thumbnailUrl": "", "external": null }, "defaultImageClickthrough": null, "name": "Sizmek3", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 146600, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }, { "type": "AdSmartVersion", "id": 1082405230, "clientRefId": "3", "relationsBag": null, "version": 1491306470749634560, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486566727744, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1491306470750, "schema": { "type": "APIAdSmartVersionSchema", "id": 15352605458400, "smartElements": [{ "type": "AdSmartImageElement", "id": 15352605458400, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "900/36/36/1rgc2p4lv8n04zh", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "1082405200", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157238, "relationsBag": null, "subDeliveryGroupId": "92934e3400f29e1424a90579897de900", "sdgNumericId": 1073814400, "targetAudienceId": 1073743400, "targetAudienceName": "123123", "targetAudienceExternalName": null, "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 10007, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [{ "type": "APITargetAudienceMetaData", "id": 1073743400, "targetAudienceName": "123123", "targetAudienceExternalName": null, "clientRefId": null }] }, "defaultImage": { "type": "AdAsset", "id": null, "relationsBag": null, "assetId": null, "assetName": "", "source": true, "assetStatus": null, "folderId": null, "workspaceFolderId": null, "size": null, "duration": null, "bitRate": null, "width": 0, "height": 0, "mimeType": null, "mediaType": "Image", "format": null, "thumbnailUrl": "", "external": null }, "defaultImageClickthrough": null, "name": "Sizmek3", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 146600, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }, { "type": "AdSmartVersion", "id": 1082405200, "clientRefId": "4", "relationsBag": null, "version": 1486566727766245300, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486566727700, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1486566727745, "schema": { "type": "APIAdSmartVersionSchema", "id": 15352605458400, "smartElements": [{ "type": "AdSmartImageElement", "id": 15352605458400, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "b50/36/36/1rgc2p85h6ct7p9", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "1082405200", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157238, "relationsBag": null, "subDeliveryGroupId": "3c90f932e9f457ff09239f06d7c8430a", "sdgNumericId": 1073803500, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 10007, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [] }, "defaultImage": { "type": "AdAsset", "id": null, "relationsBag": null, "assetId": null, "assetName": "", "source": true, "assetStatus": null, "folderId": null, "workspaceFolderId": null, "size": null, "duration": null, "bitRate": null, "width": 0, "height": 0, "mimeType": null, "mediaType": "Image", "format": null, "thumbnailUrl": "", "external": null }, "defaultImageClickthrough": null, "name": "Sizmek3", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 146673, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }, { "type": "AdSmartVersion", "id": 1082405200, "relationsBag": null, "version": 1486567037447307264, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1486567037445, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1486567037445, "schema": { "type": "APIAdSmartVersionSchema", "id": 15435820449811, "smartElements": [{ "type": "AdSmartImageElement", "id": 15435820449812, "svKey": "product_image", "value": { "type": "AdSmartElementSimpleStringValue", "value": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png", "stringValue": "https://secure-ds.serving-sys.com/BurstingScript/HTML5FactoryCommonTemplates/MediumRectangle/your_product_white.png" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1074157200, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "470/36/36/1rgc2pbp342sxdx", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "1082405200", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1074157200, "relationsBag": null, "subDeliveryGroupId": "b45445878f1a0926f4aba4672e9602ec", "sdgNumericId": 1073803500, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": 0, "endDate": 1924934749000, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [] }, "defaultImage": null, "defaultImageClickthrough": null, "name": "", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": null, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" }] }
Retrieves a specific ad version.
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the variable details. If there is no variable, the request returns an empty response.
{ "result": { "type": "AdSmartVersion", "id": 1185451900, "relationsBag": null "version": 1561974096944824300, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1561974096945, "lastUpdatedBy": 359500, "lastUpdatedByName": "TSmith", "lastUpdatedByAccount": 2, "lastUpdatedByAccountName": "Sizmek", "lastUpdateOn": 1561974096945, "schema": { "type": "APIAdSmartVersionSchema", "id": 57363372897000, "smartElements": [{ "type": "AdSmartTextElement", "id": 57363372897080, "svKey": "variationDRT", "value": { "type": "AdSmartElementSimpleStringValue", "value": "", "stringValue": "" }, "smartElementSource": "ConfigJS" }, { "type": "AdSmartTextElement", "id": 57363372897081, "svKey": "seriesDisplayName", "value": { "type": "AdSmartElementSimpleStringValue", "value": "Avalon", "stringValue": "Avalon" }, "smartElementSource": "ConfigJS" }, { "type": "AdSmartTextElement", "id": 57363372897000, "svKey": "clientCode", "value": { "type": "AdSmartElementSimpleStringValue", "value": "BOS10", "stringValue": "BOS10" }, "smartElementSource": "ConfigJS" }], "catalog": null }, "masterAdId": 1078885700, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "fd0/36/36/1xht328arrehzyd", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "Keyword Luxury|toyotaofbennington", "product": "None", "clickthrough": null, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1078885700, "relationsBag": null, "subDeliveryGroupId": "73ddb33fc9bb1c09f10d6065b944d996", "sdgNumericId": 1074636300, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": null, "endDate": null, "weight": 1.0, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [{ "type": "APIDateRange", "startDate": 0, "endDate": 1924934749000 }], "targetAudienceMetaData": [{ "type": "APITargetAudienceMetaData", "id": 1073772664, "targetAudienceName": "Keyword Luxury", "targetAudienceExternalName": "", "clientRefId": null }] }, "defaultImage": null, "defaultImageClickthrough": null, "name": "Keyword Luxury|toyotaofbennington", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": null, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "" } }
PUT https://adapi.sizmek.com/sas/dco
{ "entities": [{ "type": "AdSmartVersion", "id": 1185451900, "relationsBag": null, "version": 1575552256057999400, "createdBy": 359500, "createdByName": "TSmith", "createdByAccount": 2, "createdByAccountName": "Sizmek", "createdOn": 1561974096945, "lastUpdatedBy": 305900, "lastUpdatedByName": "RJones", "lastUpdatedByAccount": 3200, "lastUpdatedByAccountName": "Varu AllTypes", "lastUpdateOn": 1575552256058, "schema": { "type": "APIAdSmartVersionSchema", "id": 57363372897000, "smartElements": [{ "type": "AdSmartTextElement", "id": 57363372897000, "svKey": "clientCode", "value": { "type": "AdSmartElementSimpleStringValue", "value": "BOS10", "stringValue": "BOS10" }, "smartElementSource": "ConfigJS", "typeName": "Text Element", "smartValue": "BOS10" }, { "type": "AdSmartTextElement", "id": 57363372897081, "svKey": "seriesDisplayName", "value": { "type": "AdSmartElementSimpleStringValue", "value": "Avalon", "stringValue": "Avalon" }, "smartElementSource": "ConfigJS", "typeName": "Text Element", "smartValue": "Avalon" }, { "type": "AdSmartTextElement", "id": 57363372897080, "svKey": "variationDRT", "value": { "type": "AdSmartElementSimpleStringValue", "value": "", "stringValue": "" }, "smartElementSource": "ConfigJS", "typeName": "Text Element" }], "catalog": null }, "masterAdId": 1078885700, "defaultVersion": false, "active": true, "status": "Active", "preferred": false, "lockType": "None", "targetingType": null, "versionFileName": "cf0/36/36/1xht328axzyl4j4", "versionBasePath": "PROD/DCO", "accountId": 2, "externalId": "Keyword Luxury|toyotaofbennington", "product": "None", "clickthrough": { "type": "MainClickthrough", "id": null, "relationsBag": null, "url": "", "targetWindowType": null, "showAddressBar": false, "showMenuBar": false, "closeAllAdParts": false }, "thirdPartyImpressionTrackers": [], "thirdPartyClickTrackers": [], "targetingInfo": { "type": "AdSmartVersionTargetingInfo", "id": 1078885700, "relationsBag": null, "subDeliveryGroupId": "f6bc8840706426752ab8ed8307085300", "sdgNumericId": 1074975000, "targetAudienceId": -1, "targetAudienceName": "None", "targetAudienceExternalName": "None", "rotationType": "EvenDistribution", "versionTargetingType": null, "startDate": null, "endDate": null, "weight": 1, "mediaTargetingName": "None", "mediaTargetingId": -1, "datesRange": [], "targetAudienceMetaData": [{ "id": 1073772500, "targetAudienceExternalName": "", "targetAudienceName": "Keyword BMW X6", "type": "APITargetAudienceMetaData" }, { "id": 1073772314, "targetAudienceExternalName": "", "targetAudienceName": "Keyword AWD4", "type": "APITargetAudienceMetaData" }] }, "defaultImage": null, "defaultImageClickthrough": null, "name": "Keyword Luxury|toyotaofbennington", "advancedRetargeting": { "type": "AdvancedRetargeting", "branchItemClientIds": [], "advertiserId": 33014, "tags": [], "tagIds": [], "nodeType": "AdvancedRetargeting" }, "vastSmartElement": null, "vastVersion": false, "vastElementURLWithToken": "", "dimensions": "970x250", "masterAdName": "Demo Ad 123", "accountName": "Sizmek", "campaignId": 1073948900, "campaignName": "Demo Campaign" }] }
The following table lists the possible HTTP status codes in responses.
CODE |
STRING |
DESCRIPTION |
---|---|---|
200 OK |
Success |
Successful API execution |
500 |
Internal Error |
The following shows an example of an internal server error in a response body.
{ "metadata": null, "debug": null, "error": [{ "type": "APIErrorCollection", "id": 1258613552, "clientRefId": null, "errors": [{ "code": 60111, "innerMessage": "Deleting all versions is not allowed, versions of master ad:1079774412 will not be deleted", "propertyPath": null, "value": null, "entity": null, "params": ["1079774412"] }] }], "result": [] }
The following table lists the possible internal server errors for the ad version resource.
INTERNAL CODE |
STRING |
DESCRIPTION |
---|---|---|
60111 |
Deleting all versions is not allowed, versions of master ad %s will not be deleted. |
It is not possible to delete all ad versions because a DCO ad must contain at least one version. |
61117 |
Target Audience %s does not belong to the Master Ad account. |
A target audience assigned to an ad version must be from the same account. |
Comments