Update Supply

Adi Heymann -

Updates Supply

PATCH /api/player/<SupplyId>

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
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
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    
cost_type Cost Type

No

(Yes if CedatoX)

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)

 
cost_value   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 :

  • 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)
 
         
Have more questions? Submit a request

0 Comments

Article is closed for comments.