Combo Creative Feature REST API

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

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

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

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

GET

Retrieve all of the Combo 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 Combo Creative features stored against the Campaign and all of Ads in a single response.

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• parentId the id of either a Campaign or Ad for which the Combo 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/comboCreatives/0000000000039306

Individual Combo Creative features

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

POST

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• parentId the id of either a Campaign or Ad under which the new Combo Creative feature is to be created

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

 Click to view XML example

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

example-combo-creative-post.xml

Example command:

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

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 Combo Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Combo 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/comboCreative/0000000000039307

PUT

Update the Combo Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Combo 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/comboCreative/0000000000039307 -d @input.xml

DELETE

Delete the Combo Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Combo 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/comboCreative/0000000000039307

Like

Last updated: January 19, 2022