This API exposes operations to allow retrieval of Product data within the Cxense Advertising platform.
This API can be accessed by users with the appropriate permissions to retrieve Products and supports the following operations on Product domain objects:
Object
Supported operations
Product list
GET
Retrieving the list of available Products
A list of all Products that available from which a user can create Campaign(s) and/or AdSpaces can be retrieved using the GET operation.
GET
Retrieve the list of Products available to the user.
https://{cxadbaseurl}/api/secure/products
Parameters:
cxadbaseurl the base URL of the Cxense Advertising system
Example command:
curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/products
This XML example shows the contents returned from a typical GET call:
<?xml version="1.0"?>
<cx:products xmlns:cx="http://cxense.com/cxad/api/cxad">
<cx:cpcProduct>
<cx:productId>0000000000004758</cx:productId>
<cx:name>Test CPC Product</cx:name>
<cx:setupFee currencyCode="AUD" value="10.00"></cx:setupFee>
<cx:runningStartDate>2009-01-01T00:00:00.000Z</cx:runningStartDate>
<cx:runningEndDate>2020-12-31T23:59:59.999Z</cx:runningEndDate>
<cx:costModel>POSITION_STABILISED_YIELD</cx:costModel>
<cx:rankModel>YIELD</cx:rankModel>
<cx:forSale>true</cx:forSale>
<cx:forSaleStartDate>2009-01-01T00:00:00.000Z</cx:forSaleStartDate>
<cx:forSaleEndDate>2020-12-31T00:00:00.000Z</cx:forSaleEndDate>
<cx:advertiserDescription>The default Keyword CPC product. This product allows Audience targeting via Keyword bids. Text and Image creatives are supported on this product. The minimum Floorprice for bids is $0.10AUD, however it may be more for high value keywords. Targeting can be added at the Campaign and Ad level for advanced Ad management.</cx:advertiserDescription>
<cx:featureTemplates>
<cx:template>
<cx:templateId>0000000000004759</cx:templateId>
<cx:name>Keyword Template</cx:name>
<cx:type>KeywordFeature</cx:type>
</cx:template>
<cx:template>
<cx:templateId>0000000000004761</cx:templateId>
<cx:name>Text Creative Template</cx:name>
<cx:type>TextCreativeFeature</cx:type>
</cx:template>
<cx:template>
<cx:templateId>0000000000004762</cx:templateId>
<cx:name>Image Template</cx:name>
<cx:type>ImageCreativeFeature</cx:type>
</cx:template>
</cx:featureTemplates>
<cx:ongoingCost currencyCode="AUD" value="3.00"></cx:ongoingCost>
<cx:ongoingCostPeriod>MONTHLY</cx:ongoingCostPeriod>
<cx:minimumBid currencyCode="AUD" value="0.10"></cx:minimumBid>
</cx:cpcProduct>
<cx:cpmProduct>
<cx:productId>000000000000475a</cx:productId>
<cx:name>CPM product</cx:name>
<cx:setupFee currencyCode="AUD" value="10.00"></cx:setupFee>
<cx:runningStartDate>2009-01-01T00:00:00.000Z</cx:runningStartDate>
<cx:runningEndDate>2020-12-31T23:59:59.999Z</cx:runningEndDate>
<cx:costModel>NULL</cx:costModel>
<cx:rankModel>RANDOM</cx:rankModel>
<cx:forSale>true</cx:forSale>
<cx:forSaleStartDate>2009-01-01T00:00:00.000Z</cx:forSaleStartDate>
<cx:forSaleEndDate>2020-12-31T00:00:00.000Z</cx:forSaleEndDate>
<cx:advertiserDescription>The default CPM product. This product is shown across the very exclusive (albeit imaginary) ImagiNetwork of websites (eg. NewsDotCom, EntertainmentDotCom, SportsDotCom, EnvironmentDotCom and many more). Text and Image creatives are supported on this product. Targeting can be added at the campaign and Ad level for advanced Ad management.</cx:advertiserDescription>
<cx:featureTemplates>
<cx:template>
<cx:templateId>0000000000004777</cx:templateId>
<cx:name>Text Creative Template</cx:name>
<cx:type>TextCreativeFeature</cx:type>
</cx:template>
<cx:template>
<cx:templateId>0000000000004778</cx:templateId>
<cx:name>Image Template</cx:name>
<cx:type>ImageCreativeFeature</cx:type>
</cx:template>
</cx:featureTemplates>
<cx:costPerThousand currencyCode="AUD" value="10.00"></cx:costPerThousand>
</cx:cpmProduct>
<cx:tenancyProduct>
<cx:productId>000000000000475b</cx:productId>
<cx:name>Tenancy product</cx:name>
<cx:setupFee currencyCode="AUD" value="10.00"></cx:setupFee>
<cx:runningStartDate>2009-01-01T00:00:00.000Z</cx:runningStartDate>
<cx:runningEndDate>2020-12-31T23:59:59.999Z</cx:runningEndDate>
<cx:costModel>NULL</cx:costModel>
<cx:rankModel>RANDOM</cx:rankModel>
<cx:forSale>true</cx:forSale>
<cx:forSaleStartDate>2009-01-01T00:00:00.000Z</cx:forSaleStartDate>
<cx:forSaleEndDate>2020-12-31T00:00:00.000Z</cx:forSaleEndDate>
<cx:advertiserDescription>The default Tenancy product. This product is shown on all homepages of the very exclusive (albeit imaginary) ImagiNetwork of websites (eg. NewsDotCom, EntertainmentDotCom, SportsDotCom, EnvironmentDotCom and many more). There is no specific targeting on this default tenancy product. Note: This product uses UTC timezone to determine start and end dates.</cx:advertiserDescription>
<cx:featureTemplates>
<cx:template>
<cx:templateId>0000000000004789</cx:templateId>
<cx:name>Text Creative Template</cx:name>
<cx:type>TextCreativeFeature</cx:type>
</cx:template>
<cx:template>
<cx:templateId>000000000000478a</cx:templateId>
<cx:name>Image Template</cx:name>
<cx:type>ImageCreativeFeature</cx:type>
</cx:template>
</cx:featureTemplates>
<cx:availableSlots>3</cx:availableSlots>
<cx:period>DAILY</cx:period>
<cx:unitCost currencyCode="AUD" value="1.00"></cx:unitCost>
<cx:timeZoneId>UTC</cx:timeZoneId>
<cx:costingFunction>PER_PERIOD</cx:costingFunction>
</cx:tenancyProduct>
</cx:products>
