Keyword Feature REST API

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

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

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

The GET operation is supported for listing existing Keyword features.

GET

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

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

Individual Keyword features

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

POST

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

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• parentId the id of either a Campaign or Ad under which the new Keyword 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:keyword xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>0000000000004b49</cx:templateId>
  <cx:keywordData>
    <cx:text>apples</cx:text>
    <cx:keywordMatchType>EXACT</cx:keywordMatchType>
    <cx:language>EN</cx:language>
    <cx:bid currencyCode="AUD" value="0.10"/>
    <cx:state>ACTIVE</cx:state>
  </cx:keywordData>
  <cx:keywordData>
    <cx:text>oranges</cx:text>
    <cx:keywordMatchType>EXACT</cx:keywordMatchType>
    <cx:language>EN</cx:language>
    <cx:bid currencyCode="AUD" value="0.10"/>
    <cx:state>ACTIVE</cx:state>
  </cx:keywordData>
  <cx:keywordData>
    <cx:text>fresh fruit</cx:text>
    <cx:keywordMatchType>PHRASE</cx:keywordMatchType>
    <cx:language>EN</cx:language>
    <cx:bid currencyCode="AUD" value="0.20"/>
    <cx:state>ACTIVE</cx:state>
  </cx:keywordData>
  <cx:keywordData>
    <cx:text>phone</cx:text>
    <cx:keywordMatchType>NEGATIVE</cx:keywordMatchType>
    <cx:language>EN</cx:language>
    <cx:bid currencyCode="AUD" value="0.20"/>
    <cx:state>ACTIVE</cx:state>
  </cx:keywordData>
</cx:keyword>

Note: Bid values for keywords only apply to Campaigns (and their Ads) created from CPC Products.  Therefore, any bid values supplied in the request payload when creating a Keyword feature under a Campaign (or one of its Ads) created from a CPM Product will be ignored.

Example command:

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

GET

Retrieve the Keyword feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Keyword feature to be retrieved

Example command:

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

PUT

Update the Keyword feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Keyword feature to be updated

Note: Bid values for keywords only apply to Campaigns (and their Ads) created from CPC Products.  Therefore, any bid values supplied in the request payload when updating a Keyword feature under a Campaign (or one of its Ads) created from a CPM Product will be ignored.

Example command:

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

DELETE

Delete the Keyword feature with the given featureId

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

Parameters:

• cxadbaseurl the base URL of the Cxense Advertising system

• featureId the id of the Keyword feature to be deleted

Example command:

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

Like

Last updated: December 23, 2021