Skip to main content
POST
Request an ad

Path Parameters

tagid
string<uuid>
required

The ID of the ad unit.

Get from the advertising manager.

Body

application/json
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

ext
object | null

Optional ad serving options. Set echo_user to true to include user in a successful ad response.

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

Returned ad, or the ad unit's passback when no ad is available and a passback tag is configured. A passback response has errorcode: "204", ext.passback, and no ad. An A/B assignment appears only when applicable; the example illustrates an assigned request.

version
string
required

Version of the SDK API.

ad
object | null

Served ad. Absent in passback and error responses.

errorcode
string | null

Error code if the request failed.

ext
object | null

Tracking, experiment assignment, or passback details, depending on the response.

user
object | null

Echoed User object from the ad request.