Text Creative Feature REST API

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

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

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

The GET operation is supported for listing existing TextCreative features.

GET

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

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

Individual TextCreative features

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

POST

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• parentId the id of either a Campaign or Ad under which the new TextCreative 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:textCreative xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>0000000000004b45</cx:templateId>
  <cx:title>Test text creative</cx:title>
  <cx:content>
    <cx:contentLine>The first content line</cx:contentLine>
    <cx:contentLine>Another line of content</cx:contentLine>
  </cx:content>
  <cx:displayUrl>http://www.example.com/display</cx:displayUrl>
  <cx:destinationUrl>http://www.example.com/destination</cx:destinationUrl>
  <cx:status>LIVE</cx:status>
</cx:textCreative>

Example command:

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

GET

Retrieve the TextCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the TextCreative feature to be retrieved

Example command:

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

PUT

Update the TextCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the TextCreative feature to be updated

Example command:

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

DELETE

Delete the TextCreative feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the TextCreative feature to be deleted

Example command:

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

Last updated: December 23, 2021