Skip to main content
POST
Serving an ad

Path Parameters

tagid
string<uuid>
required

The ID of the ad unit.

Get from the advertising manager.

Body

application/json

AdRequest is used for requesting an ad.

AdRequest is used for requesting an ad.

ad_size
integer<int32>[][] | null

Ad sizes requested for the ad.

Required array length: 2 elements
app
object | null

App object for the current serving request.

device
object | null

Device object for the current serving request.

Example:

null

site
object | null

Site object for the current serving request.

targeting
any

Targeting key-value pairs for the ad request.

user
object | null

User object for the current serving request.

Example:

Response

Successfully served an ad

version
string
required

Version of the SDK API.

ad
object | null

Ad object.

errorcode
string | null

Error code if the request failed.

ext
any

Optional A2 specific extensions.

user
object | null

Echoed User object from the ad request.