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_typeCost 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_activeactiveNo0/11
is_desktopIs desktop supplyNo0/10
is_mobile_webIs mobile web supplyNo0/10
is_mobile_appIs mobile app supplyNo0/10
is_ctv
Is CTV supply
No0/10
isMutedMuteNo0/10
rotateAllows ad rotationNo0/10
rotate_numberNumber of allowed rotationsNo

1 to 5 

0 is unlimited

0
autoplayAutoplayNo0/10
controlbarControl BarNo0/10
loader_image_urlImage for url loaderNo  
user_mvr

VAST Requests Limit

Nofrom 1 to 5 (highest)5
domain_list_type

List restriction type (cedatoX)

No

1 - white list

2- black list

0
preroll

Pre Roll

No0/10
preroll_time

Pre Roll Ad Max Loading Time

Noint4
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
callbacksCallbacksNo

callbacks[0][url]=https://callbackurl.com&callbacks[0][typeId]=0&callbacks[0][eventId]=1

eventId options :

  • Player Ready = 1
  • Ad Starts = 2
  • Ad Complete =3
  • Ad Click = 4

typeId is mandatory

  • URL request = 0
  • JS run = 1 (eventId should be 2)
 
assigned_vastsAssigned VastsNo

Assigned Vasts params:

  • vastId - the id of the demand to assign 
  • is_active_on_player - 1 for assigning 0 for unassigning
  • vast_cpm_on_player - cpm value when not using default cpm
  • useDefaultCPM

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

 
targetingTargetingNo

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_cappingCapping (CedatoX Type)No

Sample:

player_capping[0][cappingType]=1&player_capping[0][cappingValue]=999999&player_capping[0][paceOption]=1

 
ip_restriction_listsIP 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_operInclude/Exclude countries

0 - exclude

1 - include

country_codesCountry codeslist of country codes
browsers_operInclude/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_operInclude/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_operInclude/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
playerIdSupply Id 
nameSupply Name 
activeIs Supply Active0/1
typeSupply Type

0 - HTML Player

1 - Vast 

2 - CedatoX

is_mobile_webIs mobile web supply0/1
is_mobile_appIs mobile app supply0/1
is_desktopIs desktop supply0/1
max_total_vast_requestsMaximum Ad Requests per Opportunityint
passbackPassback enabled0/1
passback_timeoutPassback Timeoutint
passback_codePassback Codejson
domain_list_typeList restriction type (cedatoX)

1 - white list

2- black list

allow_rotationAllows ad rotation0/1
rotate_numberNumber of allowed rotations

1 to 5 

0 is unlimited

allow_soundAllow sound0/1
auto_playAuto play ad0/1
show_control_barEnables the display of the control bar on content and ad playback0/1
cx_traffic_source_allowed_htmlAllow assigning HTML players to DemandXrelevant for CedatoX Supplies only
cx_traffic_source_allowed_vastAllow assigning VAST players to DemandXrelevant for CedatoX Supplies only
createdCreation Timestamp 
updatedUpdate Timestamp 
   
Content  
content_urlContent videostring
loader_image_urlContent image string
content_video_titleVideo Titlestring
content_video_keywordsVideo Keywordsstring
content_video_descVideo Descriptionstring
click_urlContent Click URLstring
prerollPre Roll0/1
preroll_timePre Roll Ad Max Loading Timeint
content_before_adsPost Roll0/1
loopLoop Content0/1
content_control_barShow control bar on content playback only 0/1
   

Callbacks (callbacks)

Attribute Name
Summary
Possible Values
callbackIdCallback ID 
urlCallback URL 
typeIdCallback Type

0 - pixel

1 - IVT javascript

eventIdCallback Event
  • Player Ready = 1
  • Ad Starts = 2
  • Ad Complete =3
  • Ad Click = 4
rateCallback Rate0-100

Assigned Vasts ( assigned_vasts)

Attribute Name
Summary
Possible Values
 
 
vast_cpm_on_playerCPM for assignment or demand if not definedint
is_active_on_playeris demand currently assigned0/1
vastIdDemand Idint
nameDemand Namestring
urlDemand URLstring
cpmDemand CPMint
activeIs demand active0/1
user_mvrVAST Requests Limitfrom 1 to 5 (highest)
user_typeJS/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_typeList restriction type (cedatoX)

 

1 - white list

2- black list

vast_typeDemand Type

0 - Vast

1 - CedatoX

createdCreated Timestamp 
updatedUpdated timestamp 
 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article