Follow

Support for managing Third-Party Creatives now available (September 29, 2014)

With our new Rest API you can now create and manage Third Party Creative features inside Cxense Advertising. This API can be accessed by users with the appropriate permissions to manage Third Party Creative features. The API supports the following combination of operations on Third Party Creative feature domain objects:

Object

Supported operations

Third Party Creative feature list

GET

Third Party Creative feature

POST, GET, PUT and DELETE

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:

 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/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

 

Have more questions? Submit a request

Comments

Powered by Zendesk