API Reference

Get ads to display

post
https://us-central1-readysandbox.cloudfunctions.net/ads-getAdsToDisplay
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of the ad to display.

Allowed:
string
enum
required

The size of the ad to display. Possible values:

  • medium_rectangle - 300x250 pixels
  • large_rectangle - 336x280 pixels
  • leaderboard - 728x90 pixels
  • skyscraper - 120x600 pixels
  • wide_skyscraper - 160x600 pixels
  • hd - 1920x1080 pixels
  • hd_portrait - 1080x1920 pixels
Allowed:
integer
required
1 to 100

The maximum number of ads to return.

integer
1 to 100

The number of random ads to return. Optional. Should be less than the limit. It loads 'limit' ads and then randomly selects 'randomCount' ads from them based on the ad.random.weight value.

Responses

Updated over 1 year ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago