Third Party Creative Feature API

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

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

Retrieving the list of ThirdPartyCreative features saved against a Campaign or Ad

The GET operation is supported for listing existing ThirdPartyCreative features.

GET

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

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

Individual ThirdPartyCreative features

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

POST

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

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

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

<?xml version="1.0" encoding="UTF-8"?>
<cx:thirdPartyCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>0000000000004b45</cx:templateId>
  <cx:name>Test Third Party Creative</cx:name>
  <cx:type>ADBROKER</cx:type>
  <cx:code><![CDATA[<script type="text/javascript" src="http://ads.adbroker.de/adscript.php?pid=00000&ord=[timestamp]&showkid=0000&prdclick_0=[CLICKMACRO ENCODED]" language="JavaScript"></script>]]></cx:code>
  <cx:impressionTrackingUrl><![CDATA[http://t.adcloud.net/t.gif?r=data]]></cx:impressionTrackingUrl>
</cx:thirdPartyCreative>

The set of valid values for the cx:type element can be found in the cxad.xsd schema file. The schema can be retrieved with the following command:

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

The values for the cx:code and cx:impressionTrackingUrl elements must either be encoded or come within a CDATA tag.

Example command:

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

GET

Retrieve the ThirdPartyCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the ThirdPartyCreative feature to be retrieved

Example command:

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

PUT

Update the ThirdPartyCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the ThirdPartyCreative feature to be updated

Example command:

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

DELETE

Delete the ThirdPartyCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the ThirdPartyCreative feature to be deleted

Example command:

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

Last updated: December 23, 2021