Get an ad by ID

post https://us-central1-readysandbox.cloudfunctions.net/ads-getById

Responses

Response body

object

The retrivied ad data

string

The unique identifier for the ad.

title

string

The title of the ad.

description

string

The description of the ad.

redirectUrls

array of objects

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

redirectUrls

object

url

string

The URL to redirect when the ad is clicked.

name

string

The name of the URL.

platformId

string

The platform ID of the URL.

iconUrl

string

The icon URL for the specific link on the platform.

previewBinaryUrl

object

The preview binary URL of the ad.

binaryUrl

object

The ad binary URL of the ad.

isActive

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

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.

viewLimit

number

1 to 2147483647

Absolute limit of the ad views.

viewLimitPerUser

number

-1 to 2147483647

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

type

string

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

banner fullscreen

size

string

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

medium_rectangle large_rectangle leaderboard skyscraper wide_skyscraper hd hd_portrait

currentViewLimit

number

The current view limit of the ad. This field serves as a counter for the ad views.

clickCounter

number

The counter of the ad clicks.

createdAt

int64

Date and time when the ad was created in milliseconds since midnight, January 1, 1970 UTC. Automatically populated by the backend.

updatedAt

int64

Date and time when the ad was last time updated in milliseconds since midnight, January 1, 1970 UTC. Automatically populated by the backend.

createdBy

string

User Id who created the ad. This field is automatically populated by the backend.

updatedBy

string

User Id who last time updated the ad. This field is automatically populated by the backend.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/ads-getById \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
59
}
1
{
2
  "ad": {
3
    "id": "string",
4
    "title": "string",
5
    "description": "string",
6
    "redirectUrls": [
7
      {
8
        "url": "string",
9
        "name": "string",
10
        "platformId": "string",
11
        "iconUrl": "string"
12
      }
13
    ],
14
    "previewBinaryUrl": {
15
      "contentType": "image/jpeg",
16
      "source": "string",
17
      "large": "string",
18
      "medium": "string",
19
      "small": "string"
20
    },
21
    "binaryUrl": {
22
      "contentType": "image/jpeg",
23
      "source": "string",
24
      "large": "string",
25
      "medium": "string",

200Successful response with the details of the retrieved ad.

400Invalid argument error for invalid input values.

401Unauthenticated error 401 indicating the user is not authenticated.