Flash Creative Feature REST API

This API exposes operations to allow management of Flash Creative features within the Cxense Advertising platform.

This API can be accessed by users with the appropriate permissions to manage Flash Creative features and supports the following combination of operations on Flash Creative feature domain objects:

Object	Supported operations
Flash Creative feature list	GET
Flash Creative feature	POST, GET, PUT and DELETE

Retrieving the list of Flash Creative features saved against a Campaign or Ad

The GET operation is supported for listing existing Flash Creative features.

GET

Retrieve all of the Flash Creative features saved at or below the Campaign or Ad with the given parentId. One call using the id of a Campaign will return all of the Flash Creative features stored against the Campaign and all of Ads in a single response.

https://{cxadbaseurl}/api/secure/flashCreatives/{parentId}

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
parentId the id of either a Campaign or Ad for which the Flash Creative features are to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/flashCreatives/0000000000039306

This XML example shows the contents returned from a typical GET call:

<?xml version="1.0"?>
<cx:flashCreatives xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:flashCreative>
    <cx:featureId>000000000000d053</cx:featureId>
    <cx:templateId>000000000000e160</cx:templateId>
    <cx:description>Test Flash Creative Feature</cx:description>
    <cx:destinationUrl>http://www.test.com/destination</cx:destinationUrl>
    <cx:flash fileName="300x250-v6.swf">
      <cx:resourceUrl>http://cdn.example.com/55767538ec70f34a0f9fb80f49d54f5edcea35dbb1dc8b77de49aea92f1c14e4.swf</cx:resourceUrl>
    </cx:flash>
    <cx:image fileName="300x250.gif" contentType="image/gif">
      <cx:resourceUrl>http://cdn.example.com/a962fdcf71cbcaf319a196f7a239a783adba43dd8022c3df975974311c9a53a0.gif</cx:resourceUrl>
    </cx:image>
  </cx:flashCreative>
  <cx:flashCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:featureId>000000000000e164</cx:featureId>
    <cx:templateId>000000000000e160</cx:templateId>
    <cx:description>Another Flash Creative Feature</cx:description>
    <cx:destinationUrl>http://www.example.com/dest</cx:destinationUrl>
    <cx:flash fileName="300x250-v7.swf">
      <cx:resourceUrl>http://cdn.example.com/a962fdcf71cbcaf319a196f7a239a783adba43dd8022c3df975974311c9a53a0.swf</cx:resourceUrl>
    </cx:flash>
    <cx:image fileName="300x250.png" contentType="image/png">
      <cx:resourceUrl>http://cdn.example.com/13a6d17125ee9dcaccb69216881301a89a6fdb45b32263078070f8fbce6501c7.png</cx:resourceUrl>
    </cx:image>
  </cx:flashCreative>
</cx:flashCreatives>

Individual Flash Creative features

The POST, GET, PUT and DELETE operations are supported for management of individual Flash Creative features.

POST

Create a new Flash Creative feature under the Campaign or Ad with the given parentId.

https://{cxadbaseurl}/api/secure/flashCreative/{parentId}

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
parentId the id of either a Campaign or Ad under which the new Flash Creative feature is to be created

This XML example shows the contents required to be supplied for a POST call:

<?xml version="1.0"?>
<cx:createFlashCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>000000000000e548</cx:templateId>
  <cx:description>new-creative</cx:description>
  <cx:destinationUrl>http://new-destination-url.com/testing</cx:destinationUrl>
  <cx:flash fileName="300x250-30fps-v7.swf">
    <cx:flashData>
      [Base64 encoded flash file contents]
    </cx:flashData>
  </cx:flash>
  <cx:image fileName="300x250.jpg" contentType="image/jpeg">
    <cx:imageData>
      [Base64 encoded image file contents]
    </cx:imageData>
  </cx:image>
</cx:createFlashCreative>

Please refer to the example-flash-creative-post.xml file below for an XML example containing Base64 encoded flash file contents.

example-flash-creative-post.xml

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X POST https://cxad.cxense.com/api/secure/flashCreative/0000000000039306 -d @input.xml

This XML example shows the contents returned from a typical POST call:

<?xml version="1.0"?>
<cx:flashCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:featureId>0000000000005dd5</cx:featureId>
  <cx:templateId>000000000000e548</cx:templateId>
  <cx:description>new-creative</cx:description>
  <cx:destinationUrl>http://new-destination-url.com/testing</cx:destinationUrl>
  <cx:status>LIVE</cx:status>
  <cx:flash fileName="300x250-30fps-v7.swf">
    <cx:resourceUrl>http://cdn.example.com/7b2a3dd6137fce8c6c20f24aefbfe17d7a68bd9055824b8ba7ba4321ea7e4921.swf</cx:resourceUrl>
  </cx:flash>
  <cx:image fileName="300x250.jpg" contentType="image/jpeg">
    <cx:resourceUrl>http://cdn.example.com/13a6d17125ee9dcaccb69216881301a89a6fdb45b32263078070f8fbce6501c7.jpg</cx:resourceUrl>
  </cx:image>
</cx:flashCreative>

In the event that creation of this creative will cause the Campaign or Ad to become valid this will not occur until after the sync task to propagate the uploaded binary data to the CDN has successfully run. The sysc task currently executes on the taskserver every second and can take anywhere in the order of seconds up to a couple of minutes to complete. Until such time as it has completed the Campaign/Ad will potentially continue to be considered invalid.

GET

Retrieve the Flash Creative feature with the given featureId

https://{cxadbaseurl}/api/secure/flashCreative/{featureId}

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Flash Creative feature to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/flashCreative/0000000000039307

This XML example shows the contents returned from a typical GET call:

<?xml version="1.0"?>
<cx:flashCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:featureId>000000000000d053</cx:featureId>
  <cx:templateId>000000000000e160</cx:templateId>
  <cx:description>Test Flash Creative Feature</cx:description>
  <cx:destinationUrl>http://www.test.com/destination</cx:destinationUrl>
  <cx:flash fileName="300x250-30fps-v6.swf">
    <cx:resourceUrl>http://cdn.example.com/55767538ec70f34a0f9fb80f49d54f5edcea35dbb1dc8b77de49aea92f1c14e4.swf</cx:resourceUrl>
  </cx:flash>
  <cx:image fileName="300x250.gif" contentType="image/gif">
    <cx:resourceUrl>http://cdn.example.com/a962fdcf71cbcaf319a196f7a239a783adba43dd8022c3df975974311c9a53a0.gif</cx:resourceUrl>
  </cx:image>
</cx:flashCreative>

PUT

Update the Flash Creative feature with the given featureId

https://{cxadbaseurl}/api/secure/flashCreative/{featureId}

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Flash Creative feature to be updated

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X PUT https://cxad.cxense.com/api/secure/flashCreative/0000000000039307 -d @input.xml

This XML example shows the contents required to be supplied for a PUT call:

<?xml version="1.0"?>
<cx:updateFlashCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:description>updated-description</cx:description>
  <cx:destinationUrl>http://updated-destination-url.com/</cx:destinationUrl>
  <cx:flash fileName="300x250-30fps-v7.swf">
    <cx:flashData>
      [Base64 encoded image file contents]
    </cx:flashData>
  </cx:flash>
  <cx:image fileName="300x250.png" contentType="image/png">
    <cx:imageData>
      [Base64 encoded image file contents]
    </cx:imageData>
  </cx:image>
</cx:updateFlashCreative>

DELETE

Delete the Flash Creative feature with the given featureId

https://{cxadbaseurl}/api/secure/flashCreative/{featureId}

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Flash Creative feature to be deleted

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X DELETE https://cxad.cxense.com/api/secure/flashCreative/0000000000039307

Last updated: January 19, 2022