Create Supply
Creates a new Supply
POST /api/player
Request
Body Parameters
Attribute Name | Summary | Required | Possible Values | Default |
---|---|---|---|---|
player_name | Supply Name | Yes | string | NA |
player_type | Player Type | Yes | 0 - HTML Player 1 - Vast 2 - CedatoX | NA |
cost_type | Cost Type | Yes | 1 - Revshare (Not CedatoX) 2 - Fixed CPM per Opportunities (Not CedatoX) 3 - Fixed CPM per Impressions (Not CedatoX) 4 - Revshare (CedatoX) 5 - Fixed CPM (CedatoX) 7- None | |
cost_value | Yes | |||
is_active | active | No | 0/1 | 1 |
is_desktop | Is desktop supply | No | 0/1 | 0 |
is_mobile_web | Is mobile web supply | No | 0/1 | 0 |
is_mobile_app | Is mobile app supply | No | 0/1 | 0 |
is_ctv | Is CTV supply | No | 0/1 | 0 |
isMuted | Mute | No | 0/1 | 0 |
rotate | Allows ad rotation | No | 0/1 | 0 |
rotate_number | Number of allowed rotations | No | 1 to 5 0 is unlimited | 0 |
autoplay | Autoplay | No | 0/1 | 0 |
controlbar | Control Bar | No | 0/1 | 0 |
loader_image_url | Image for url loader | No | ||
user_mvr | VAST Requests Limit | No | from 1 to 5 (highest) | 5 |
domain_list_type | List restriction type (cedatoX) | No | 1 - white list 2- black list | 0 |
preroll | Pre Roll | No | 0/1 | 0 |
preroll_time | Pre Roll Ad Max Loading Time | No | int | 4 |
max_total_vast_requests | Maximum Ad Requests per Opportunity | No | ||
content_url | Content video | No | ||
content_loop | Loop Content | No | ||
content_play_full | Play Full Content | No | ||
affiliate_network_id | Partner Network ID (CedatoX) | Only For CedatoX | NA | |
callbacks | Callbacks | No | callbacks[0][url]=https://callbackurl.com&callbacks[0][typeId]=0&callbacks[0][eventId]=1 eventId options :
typeId is mandatory
| |
assigned_vasts | Assigned Vasts | No | Assigned Vasts params:
Sample: assigned_vasts[0][vastId]=6&assigned_vasts[0][is_active_on_player]=1&assigned_vasts[0][vast_cpm_on_player]=8&assigned_vasts[0][useDefaultCPM]=true | |
targeting | Targeting | No | Sample: targeting[browsers_oper]=1&targeting[browsers]=cr:30-latest,op:15-39&targeting[country_codes_oper]=1&targeting[country_codes]=US&targeting[os]=and:4-latest&targeting[os_oper]=1
| |
player_capping | Capping (CedatoX Type) | No | Sample: player_capping[0][cappingType]=1&player_capping[0][cappingValue]=999999&player_capping[0][paceOption]=1 | |
ip_restriction_lists | IP lists (CedatoX,Vast types) | No | Sample: ip_list_type=2&ip_restriction_lists[0]=111&ip_restriction_lists[1]=222 |
targeting_id | Targeting Object Id | |
---|---|---|
country_codes_oper | Include/Exclude countries | 0 - exclude 1 - include |
country_codes | Country codes | list of country codes |
browsers_oper | Include/Exclude browsers | 0 - exclude 1 - include |
browsers | Browsers with versions browser:from-to | cr:30-latest - Chrome ff:17-latest - Firefox op:15-latest - Opera ie:7-latest - Explorer/Edge sa:5-latest - Safari |
os_oper | Include/Exclude operating system | 0 - exclude 1 - include |
os | Operating systems with version os:from-to | and:4.0-latest - Android osx:10.5-latest - OsX ios:7-latest - ios win:7-latest - Windows |
sizes_oper | Include/Exclude player sizes | 0 - exclude 1 - include |
sizes | Players sizes list a:from-to (width x height) | a:0-75000 - Small a:230400-all - Medium a:75001-230399 - Large custom - other |
Response
Attribute Name | Summary | Possible Values |
---|---|---|
playerId | Supply Id | |
name | Supply Name | |
active | Is Supply Active | 0/1 |
type | Supply Type | 0 - HTML Player 1 - Vast 2 - CedatoX |
is_mobile_web | Is mobile web supply | 0/1 |
is_mobile_app | Is mobile app supply | 0/1 |
is_desktop | Is desktop supply | 0/1 |
max_total_vast_requests | Maximum Ad Requests per Opportunity | int |
passback | Passback enabled | 0/1 |
passback_timeout | Passback Timeout | int |
passback_code | Passback Code | json |
domain_list_type | List restriction type (cedatoX) | 1 - white list 2- black list |
allow_rotation | Allows ad rotation | 0/1 |
rotate_number | Number of allowed rotations | 1 to 5 0 is unlimited |
allow_sound | Allow sound | 0/1 |
auto_play | Auto play ad | 0/1 |
show_control_bar | Enables the display of the control bar on content and ad playback | 0/1 |
cx_traffic_source_allowed_html | Allow assigning HTML players to DemandX | relevant for CedatoX Supplies only |
cx_traffic_source_allowed_vast | Allow assigning VAST players to DemandX | relevant for CedatoX Supplies only |
created | Creation Timestamp | |
updated | Update Timestamp | |
tag_data | ||
Content | ||
content_url | Content video | string |
loader_image_url | Content image | string |
content_video_title | Video Title | string |
content_video_keywords | Video Keywords | string |
content_video_desc | Video Description | string |
click_url | Content Click URL | string |
preroll | Pre Roll | 0/1 |
preroll_time | Pre Roll Ad Max Loading Time | int |
content_before_ads | Post Roll | 0/1 |
loop | Loop Content | 0/1 |
content_control_bar | Show control bar on content playback only | 0/1 |
Callbacks (callbacks)
Attribute Name | Summary | Possible Values |
---|---|---|
callbackId | Callback ID | |
url | Callback URL | |
typeId | Callback Type | 0 - pixel 1 - IVT javascript |
eventId | Callback Event |
|
rate | Callback Rate | 0-100 |
Assigned Vasts ( assigned_vasts)
Attribute Name | Summary | Possible Values |
---|---|---|
vast_cpm_on_player | CPM for assignment or demand if not defined | int |
is_active_on_player | is demand currently assigned | 0/1 |
vastId | Demand Id | int |
name | Demand Name | string |
url | Demand URL | string |
cpm | Demand CPM | int |
active | Is demand active | 0/1 |
user_mvr | VAST Requests Limit | from 1 to 5 (highest) |
user_type | JS/Flash Preference for Demand
| 0 - auto 1 - use flash by default 2 - use JS by default 3- use flash only 4- use js only |
domain_list_type | List restriction type (cedatoX)
| 1 - white list 2- black list |
vast_type | Demand Type | 0 - Vast 1 - CedatoX |
created | Created Timestamp | |
updated | Updated timestamp |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article