API Reference

Add a new ad

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

The unique identifier for the ad.

string
required

The title of the ad.

string
required

The description of the ad.

redirectUrls
array of objects
required

The URLs per platform to redirect when the ad is clicked.

redirectUrls*
previewBinaryUrl
object

Represents a mapping of URLs to their respective size identifiers.

binaryUrl
object

Represents a mapping of URLs to their respective size identifiers.

boolean

Indicates whether the ad is active.

time
object

The time configuration for the ad. The 'start' and 'end' are used currently to determine if the ad is available.

tags
array of strings

The tags associated with the ad.

tags
random
object

The random configuration for the ad. Later we will rather use the AdCampaigns settings to determine if an ad is fetched or not.

number
1 to 2147483647

Absolute limit of the ad views.

number
-1 to 2147483647

The limit of the ad views per user. -1 means no limit.

string
enum
required

The type of the ad. Possible values are 'banner' and 'fullscreen'.

Allowed:
string
enum

The size configuration for the ad. Possible values are:

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