Retargeting Feature REST API

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

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

Object	Supported operations
Retargeting feature list	GET
Retargeting feature	POST, GET, PUT and DELETE

Retrieving the list of Retargeting features saved against a Campaign

The GET operation is supported for listing existing Retargeting features.

GET

Retrieve all of the Retargeting features saved at or below the Campaign with the given parentId in a single response.

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

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
parentId the id a Campaign for which the Retargeting 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/retargetings/0000000000039306

This XML example shows the contents returned from a GET call:

<?xml version="1.0"?>
<cx:retargeting xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:featureId>0000000000054e39</cx:featureId>
  <cx:templateId>0000000000054e2a</cx:templateId>
  <cx:retargetingData>
    <cx:costModifier currencyCode="USD" value="1.230000"/>
    <cx:state>ACTIVE</cx:state>
    <cx:param>
      <cx:property>u_area1</cx:property>
      <cx:value>tokyo</cx:value>
    </cx:param>
  </cx:retargetingData>
  <cx:retargetingData>
    <cx:costModifier currencyCode="USD" value="1.230000"/>
    <cx:state>ACTIVE</cx:state>
    <cx:param>
      <cx:property>u_area1</cx:property>
      <cx:value>tokyo</cx:value>
    </cx:param>
    <cx:param>
      <cx:property>u_layout</cx:property>
      <cx:value>2LDK</cx:value>
    </cx:param>
  </cx:retargetingData>
</cx:retargeting>

Individual Retargeting features

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

POST

Create a new Retargeting feature under the Campaign with the given parentId.

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

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
parentId the id of the Campaign under which the new Retargeting feature is to be created

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

<?xml version="1.0"?>
<cx:retargeting xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>0000000000054e2a</cx:templateId>
  <cx:retargetingData>
    <cx:costModifier currencyCode="USD" value="1.230000"/>
    <cx:state>ACTIVE</cx:state>
    <cx:param>
      <cx:property>u_area1</cx:property>
      <cx:value>tokyo</cx:value>
    </cx:param>
  </cx:retargetingData>
  <cx:retargetingData>
    <cx:costModifier currencyCode="USD" value="1.230000"/>
    <cx:state>ACTIVE</cx:state>
    <cx:param>
      <cx:property>u_area1</cx:property>
      <cx:value>tokyo</cx:value>
    </cx:param>
    <cx:param>
      <cx:property>u_layout</cx:property>
      <cx:value>2LDK</cx:value>
    </cx:param>
  </cx:retargetingData>
</cx:retargeting>

Example command:

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

GET

Retrieve the Retargeting feature with the given featureId

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

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Retargeting feature to be retrieved

Example command:

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

PUT

Update the Retargeting feature with the given featureId

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

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Retargeting feature to be updated

Example command:

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

DELETE

Delete the Retargeting feature with the given featureId

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

Parameters:

cxadbaseurl the base URL of the Cxense Advertising system
featureId the id of the Retargeting feature to be deleted

Example command:

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

Last updated: December 23, 2021