Advertisements¶
Advertisements or ads are the main resource on the Sellside API. You can create (calling POST /ad), update and delete them (PUT /ad/{adId} and PUT /ad/{adId}/status/{status} respectively), and get a list of your ads matching various criteria (GET /ad/) Through the API you only have access to your own ads. Ads from other advertisers are not accessible to you.
Note
We introduced a new monetary unit of micros across our product more recently, where one cent equals 10000 micros. One micro is 1-millionth of the local tenant currency (Euro). This will allow for a higher level of granularity when specifying the cost (per click).
We are substituting the current CPC values across the API with a bid value, and the actual (incurred) billed cost value - this to allow for better differentiation between the two. This split between bid and billed values is currently utilised for an experimental feature which adjusts the bid value for the quality of the traffic.
This new micros unit, as well as the distinction between bid and billed cost, are a core part of the product. We will gradually deprecate any fields with cents and local currency units across the API. Check our extensive Migration Guide for more information on how to transition to using micros units.
Price Types¶
Each advertisement has a price type which determines the type of transaction the seller would like to perform. The following table lists the valid price types and their descriptions.
Note
Please notice the deprecated price types, after the grace period they will be migrated to SEE_DESCRIPTION and support will be removed from the API.
PRICE_TYPE |
Price required? |
Deprecated |
Description |
|---|---|---|---|
BIDDING |
no |
no |
Request a bid on the ad starting from 0 EUR. |
BIDDING_FROM |
yes |
no |
Request a bid with a starting price > 0 EUR. price must contain a value in the interval of |
FIXED_PRICE |
yes |
no |
Request a fixed price. price must contain a value in the interval of |
FREE |
no |
no |
Request no price. |
NEGOTIABLE |
no |
yes |
Request a negotiation between buyer and seller. |
SEE_DESCRIPTION |
no |
no |
Additional information is in the description of the ad. |
SWAP |
no |
yes |
Request an exchange of one item for another. |
CREDIBLE_BID |
no |
no |
Request for any reasonable offer. |
ON_DEMAND |
no |
yes |
Price is communicated on request. |
NOT_APPLICABLE |
no |
yes |
Price is not applicable for this ad (e.g. a Jobs ad). |
RESERVED |
no |
yes |
Flag for transaction in progress. |