General Introduction
Freewheel's Inbound API is based on REST (Representational State Transfer). described above.
For a general introduction to SFX APIs, see SFX APIs: Using JSON.
API Scope
The Inbound API uses HTTP methods to call create, retrieve, update, and delete operations on the publisher and advertiser sides.
Publisher Side
| Property | Description | Type | Optional on Creation? |
|---|---|---|---|
| name | The publisher name | String(100) | No |
| technical-fees | The technical fees (as CPM) a publisher needs to pay to a marketplace operator to broadcast its own campaigns | String with decimal point separator to avoid conversion issues | Yes Default is 0.0. |
| ad-ex-commission | The publisher share for ad-exchange campaigns as a percentage. This field is not allowed if the AdNetwork module is disabled. | Integer | Yes Default is 0%, i.e., the market place won't take any money on ad exchange transactions. |
| max-ad-duration | The maximum duration in seconds the publisher allows for an ad. A zero value indicates that no limitation should be applied. | Integer | Yes Default is null: no limitation is applied on ad duration. |
| floor-price | The minimum "sell-side" CPM (in the private exchange currency) the publisher allows for a campaign. A publisher has to have a sell-side floor defined. | String with decimal point separator to avoid conversion issues | Yes Default is 1. |
| floor-price-buy-side | The minimum "buy-side" CPM (in the private exchange currency) the publisher allows for a campaign. This field is not allowed if the AdNetwork module is disabled. | String with decimal point separator to avoid conversion issues | Yes Default is null: no limitation is applied on bid prices. |
| externalref | String(50) | Yes Default is null. | |
| ad-type | Defines the ad type for this site:
Audio support module is required when creating audio inventory. | integer | Yes (Default is 0, video) |
Rules
When ad-ex-comission is set when you run a create or update request, all sites belonging to the updated publisher are set to "Rev share based" on impression and the value provided is used for all zone types. As a consequence, the existing field cannot be removed because it is used for later site creation.
When ad-ex-comission is not set when you run a create request, the default value is set to 0%, which results in all sites set to "Rev share based" on impression with a 100% share to the publisher for all zone types. On retrieval, if all the sites do not have the same model (Rev share based on impression) or do not have the same value for all zone types, the field is not included in the JSON response.