Site JSON Fields
| Property | Description | Type | Optional on Creation? |
|---|---|---|---|
| publisher-id | The id of the publisher to which the site belongs. This can be set only when a site is created. | Integer | No |
| type | The site type. Possible values are:
| String | No |
| name | The site name | String(255) | No |
| contact-name | Name of the contact | String(255) | Yes |
| contact-email | Email of the contact | String(255) | Yes |
| site | The site URL | String(255) | Yes, only when the application is defined as application or the device is defined as mobile-in-app or OTT. |
| website-type | Tells if site is TRANSPARENT or PACKAGED. If "show-domain" is set to SHOW, website-type is set to TRANSPARENT; otherwise it is set to PACKAGED. | String READ ONLY | |
| show-domain | The show domain policy for bidders. Possible values are:
| String | Yes, only when the application is defined as application or the device is defined as mobile-in-app or OTT. |
| category | The site content category code in the IAB taxonomy. See OpenRTB API specification version 2.1 page 60. | String | No |
| pricing-cpm | The site pricing model for CPM campaigns | Object | Yes If not provided the publisher is configured with a 100% revenue sharing for ad network campaigns. |
| pricing-openrtb | The site pricing model for OpenRTB campaigns | Object | Yes If not provided the publisher is configured with a 100% revenue sharing for ad network campaigns and values will be set to: 100-AdexCommission. |
| max-ad-duration | The maximum duration in seconds the site allows for an ad. Zero value indicates that no limitation is applied. | Integer | Yes Default is null: no limitation is applied on ad durations. |
| floor-price | The minimum sell-side CPM (in the private exchange currency) that the publisher allows for a campaign | String with dot as decimal separator to avoid conversion issues | Yes Default is null: no limitation is applied on bid prices. |
| floor-price-buy-side | The minimum buy-side CPM (in the private exchange currency) that the publisher allows for a campaign. This field is not allowed if the AdNetwork module is disabled. | String with dot as decimal separator to avoid conversion issues | Yes Default is null: no limitation is applied on bid prices. |
| application-name | The application name | String(80) | No, if the application is defined as mobile-in-app. Yes, if the application is defined tv-ott. |
| application-bundle | The application bundle | String(200) | No, if the application is defined as mobile-in-app. Yes, if the application is defined tv-ott. |
| show-application-bundle | The show application bundle policy, Possible values are:
| String | Yes except if the application is defined as application or if the device is defined as mobile-in-app |
| application-version | The application version | String(20) | No, if the application is defined as mobile-in-app. Yes, if the application is defined tv-ott. |
| application-store-url | The application store url from which the application can be downloaded | String(255) | NNo, if the application is defined as mobile-in-app. Yes, if the application is defined tv-ott. |
| application-paid | Defines the application as paid (mobile-in-app only) | Boolean | No |
| audience-gender | Define the gender options (male, female, both). | String | Yes Default is both. |
| audience-ages | Defines a list of age ranges. Possible values are:
| Array | Yes |
| 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. |
Pricing CPM
| Property | Description | Type | Optional on Creation? |
|---|---|---|---|
| model | The site pricing model for CPM campaigns,. Possible values are:
| CPM String | No |
| preroll-cpm | The site minimum CPM revenue for campaigns on preroll zones | String with dot as decimal separator to avoid conversion issues | No, if the pricing-cpm.model is CPM or CPM+sharing |
| midroll-cpm | The site minimum CPM revenue for campaigns on midroll zones | String with dot as decimal separator to avoid conversion issues | No, if the pricing-cpm.model is CPM or CPM+sharing |
| postroll-cpm | The site minimum CPM revenue for campaigns on postroll zones | String with dot as decimal separator to avoid conversion issues | No, if the pricing-cpm.model is CPM or CPM+sharing |
| outstream-cpm | The site minimum CPM revenue for campaigns on outstream zones | String with dot as decimal separator to avoid conversion issues | No, if the pricing-cpm.model is CPM or CPM+sharing |
| preroll-percent | The site percentage revenue of the campaigns CPM on preroll zones | Integer | No, if the pricing-cpm.model is sharing or CPM+sharing |
| midroll-percent | The site percentage revenue of the campaigns CPM on midroll zones | Integer | No, if the pricing-cpm.model is sharing or CPM+sharing |
| postroll-percent | The site percentage revenue of the campaigns CPM on postroll zones | Integer | No, if the pricing-cpm.model is sharing or CPM+sharing |
| outstream-percent | The site percentage revenue of the campaigns CPM on outstream zones | Integer | No, if the pricing-cpm.model is sharing or CPM+sharing |
Pricing OpenRTB
| Property | Description | Type | Allowed for Model? |
|---|---|---|---|
| model | The site pricing model for OpenRTB campaigns, Possible values are:
| String | No |
| preroll-cpm | The site minimum CPM revenue for campaigns on preroll zones | String with decimal point separator to avoid conversion issues | cpm, viewable-impression, vtr100, vtr75, vtr50 and vtr25 |
| midroll-cpm | The site minimum CPM revenue for campaigns on midroll zones | String with decimal point separator to avoid conversion issues | cpm, viewable-impression, vtr100, vtr75, vtr50, and vtr25 |
| postroll-cpm | The site minimum CPM revenue for campaigns on postroll zones | String with decimal point separator to avoid conversion issues | cpm, viewable-impression, vtr100, vtr75, vtr50 and vtr25 |
| outstream-cpm | The site minimum CPM revenue for campaigns on outstream zones | String with decimal point separator to avoid conversion issues | cpm, viewable-impression, vtr100, vtr75, vtr50 and vtr25 |
| preroll-percent | The site percentage revenue of the campaigns OpenRTB on preroll zones | Integer | sharing |
| midroll-percent | The site percentage revenue of the campaigns OpenRTB on midroll zones | Integer | sharing |
| postroll-percent | The site percentage revenue of the campaigns OpenRTB on postroll zones | Integer | sharing |
| outstream-percent | The site percentage revenue of the campaigns OpenRTB on outstream zones | Integer | sharing |
Note
it is not possible to set financial information for CPV campaigns. If you go o the form in the UI, you see CPV campaigns copied from their CPM counterpart.