We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

Ad Space Targeting Feature REST API

This API exposes operations to allow management of Ad Space Targeting features on Campaigns and Ads within the Cxense Advertising platform.

This API can be accessed by Advertisers and supports the following combination of operations on Ad Space Targeting feature domain objects:

Object

Supported operations

Ad Space Targeting feature list

GET

Ad Space Targeting feature

POST, GET, PUT and DELETE

Retrieving list of Ad Space Targeting features for a Campaign or Ad

The GET operation is supported for listing existing Ad Space Targeting features.

GET

Retrieve all of the Ad Space Targeting features saved at or below the Campaign or Ad with the given parentId. One call using the id of a Campaign will return all Ad Space Targeting features stored against the Campaign and its Ads in a single response.

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

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad for which the Ad Space Targeting 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/adSpaceTargetingFeatures/0000000000039355

 

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

<?xml version="1.0" encoding="UTF-8"?>
<cx:adSpaceTargetingFeatures xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:adSpaceTargetingFeature>
        <cx:featureId>0000000000002dc8</cx:featureId>
        <cx:templateId>0000000000002db9</cx:templateId>
        <cx:adSpaceId>0000000000002dc0</cx:adSpaceId>
        <cx:adSpaceId>0000000000002dbe</cx:adSpaceId>
        <cx:adSpaceId>0000000000002dbf</cx:adSpaceId>
        <cx:blockedAdSpaceId>0000000000002dbb</cx:adSpaceId>
    </cx:adSpaceTargetingFeature>
    <cx:adSpaceTargetingFeature>
        <cx:featureId>0000000000004ed9</cx:featureId>
        <cx:templateId>0000000000003ec0</cx:templateId>
        <cx:adSpaceId>0000000000004ed1</cx:adSpaceId>
        <cx:blockedAdSpaceId>0000000000003ecf</cx:blockedAdSpaceId>
        <cx:blockedAdSpaceId>0000000000007bbe</cx:blockedAdSpaceId>
    </cx:adSpaceTargetingFeature>
</cx:adSpaceTargetingFeatures>

 

Individual Ad Space Targeting features

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

POST

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

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

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad under which the new Ad Space Targeting 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:adSpaceTargetingFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:templateId>0000000000002db9</cx:templateId>
    <cx:adSpaceId>0000000000002dc0</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbe</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbf</cx:adSpaceId>
    <cx:blockedAdSpaceId>0000000000003ecf</cx:blockedAdSpaceId>
    <cx:blockedAdSpaceId>0000000000007bbe</cx:blockedAdSpaceId>
</cx:adSpaceTargetingFeature>

 

Example command:

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

GET

Retrieve the Ad Space Targeting feature with the given featureId

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

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Ad Space Targeting feature to be retrieved

Example command:

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

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

<?xml version="1.0" encoding="UTF-8"?>
<cx:adSpaceTargetingFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:featureId>0000000000002dc8</cx:featureId>
    <cx:templateId>0000000000002db9</cx:templateId>
    <cx:adSpaceId>0000000000002dc0</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbe</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbf</cx:adSpaceId>
    <cx:blockedAdSpaceId>0000000000003ecf</cx:blockedAdSpaceId>
    <cx:blockedAdSpaceId>0000000000007bbe</cx:blockedAdSpaceId>
</cx:adSpaceTargetingFeature>

 

PUT

Update the Ad Space Targeting feature with the given featureId

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

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Ad Space Targeting feature to be updated

Example command:

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

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

<?xml version="1.0" encoding="UTF-8"?>
<cx:adSpaceTargetingFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:adSpaceId>0000000000002dc0</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbe</cx:adSpaceId>
    <cx:adSpaceId>0000000000002dbf</cx:adSpaceId>        
    <cx:blockedAdSpaceId>0000000000003ecf</cx:blockedAdSpaceId>
    <cx:blockedAdSpaceId>0000000000007bbe</cx:blockedAdSpaceId>
</cx:adSpaceTargetingFeature>


DELETE

Delete the Ad Space Targeting feature with the given featureId

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

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Ad Space Targeting feature to be deleted

Example command:

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


Last updated: