HTML 5 Creative Feature REST API

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

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

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

The GET operation is supported for listing existing HTML 5 Creative features.

Please note

The HTML 5 Creative API requires that the creatives HTML code be inside the API's XML. This means that the HTML content must either be escaped or wrapped in a CDATA tag.

GET

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

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

Individual HTML 5 Creative features

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

POST

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• parentId the id of either a Campaign or Ad under which the new HTML 5 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

Example command:

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

GET

Retrieve the HTML 5 Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the HTML 5 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/html5Creative/00000000000353bf

PUT

Update the HTML 5 Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the HTML 5 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/html5Creative/00000000000353bf -d @input.xml

DELETE

Delete the HTML 5 Creative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the HTML 5 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/html5Creative/00000000000353bf

Like

Last updated: December 23, 2021