...
Attribute | Type | Description |
type | int | Internal |
name | string | The name of the adsource |
advertiserID | string - AdvertiserID | The advertiser which entity connected to(optional) |
description | string | Informative |
createdAt | int | Auto field |
createdBy | string | Auto field |
updatedAt | int | Auto field |
updatedBy | string | Auto field |
id | string | Internal |
fr | Float | Internal |
flags | object | Internal |
optData | array | Internal |
provider | null | Internal |
servingMode | int | Impression Serving Mode ENUM ServingMode 1 - As Fast As Possible 2 - Evenly |
publisherId | string | The account to which entity belongs to |
status | int | The adsource status: 0 - PENDING 1 - ACTIVE 2 - PAUSED 4 - ARCHIVED |
environment | int | Used to setup the environment of the adsource(informative): ENUM Environment 1 - MOBILE_WEB 2 - DESKTOP 3 - IN_APP 4 - CTV |
cpm | Float | The gross CPM collected from the demand side, will calculate the revenue by impressions in HIT time.
In RTB sources it will be the auction floor price per RTB 2.x spec. The real cpm will be calculated based on the bidding response. |
haCPM | string | Cpm which was hashed for third party pixel purpose - Auto field |
cpr | Float | CPM request fee, will calculate the request fee by requests. Calculated based on the value. Not when the TRACK/HIT is being made. |
impressionCap | object | Used to setup impression limitation on the ad source. |
requestPerDay | object | Used to setup request limitation on the ad source. |
flight | object | Option to define flight time for the ad source to be live. |
source | object | Used to configure the actual ad source |
targeting | object | Used to configure the ad source serving targeting limitations |
playerSettings | object | Used to configure advanced setting on the behaviour of this specific ad source in the player. |
trackers | Array of objects | Used to configure the third party Trackers for this adsource and should include an array of objects |
ivt | object
| IVT configuration for this specific adsource and should include an array of objects |
3.3.2.1 Object: flight
Attribute | Type | Description |
isScheduled | boolean | Turn on/off the flight settings |
startDate | int | Define the start date. EPOCH TIMESTAMP UTC |
endDate | int | Define the end date. EPOCH TIMESTAMP UTC |
3.3.2 .2 Object: cappings
Attribute | Type | Description |
impression | object | |
request | object | |
frequency | object | |
completion | object | |
revenue | object |
3.3.2.2.1 Object: cappings.request / impression / completion / revenue / frequency
Attribute | Type | Description |
enable | boolean | |
rule | object |
3.3.2.2.1.1 Object: request / impression / completion / revenue rule
Attribute | Type | Description |
sum | int | amount of : request / impression / completion / revenue |
frequency | boolean | ENUM frequency 1 - daily 2 - weekly 3 - monthly 4 - unlimited 5 - hourly |
servingMode | int | ENUM ServingMode 1 - As Fast As Possible 2 - Evenly |
completed | int |
3.3.2.2.1.2 Object: frequency rule
...