DSPAdRequest
The top-level ad request object. Contains the entire JSON payload for a single consolidated ad request. Send one request per page that contains all impression slots.
Request ID. Unique ID of the bid request for each advertisement batch request from the publisher.
a7sIT125imp object[]required
Array of impression objects representing the supply metadata for each monetizable impression entity. Include one Imp object per ad slot on the page. A single bid request can include multiple Imp objects with unique ID values so bids can reference them individually.
While a single request can contain both banner and video slots, separate slots are designated for each format to prevent competition.
Possible values: >= 1
A unique identifier for this impression within the context of the bid request (typically starts with 1 and increments).
OSGMz25banner object
Banner ad requirements for this impression slot.
Include if requesting a Display Banner ad. Omit for video slots.
format object[]required
Array of permitted banner dimensions for this slot. Each Format object represents one allowed width/height combination. Include multiple Format objects to declare multiple permitted sizes. FCC disables dimension-based filtering if width and height are absent.
Width in device independent pixels (DIPS). FCC does not apply dimension-based filtering if absent.
30Height in device independent pixels (DIPS). FCC does not apply dimension-based filtering if absent.
20video object
Video ad requirements for this impression slot. When FCC serves a video ad, adm in response contains a VAST 4.2 XML string.
Include if requesting a Video ad. Omit for banner slots.
Width of the video player in device independent pixels (DIPS).
640Height of the video player in device independent pixels (DIPS).
360ext objectrequired
Extension to the impression object for sending supply metadata.
Must contain slotid.
A unique identifier for the slot in the ad space within the context of the impression.
HOME-PAGE-DAILY-UAE5device objectrequired
Device object containing hardware, platform, location, and carrier data for the user's device.
FCC uses ua, os, and osv together to determine device type.
User agent of the device. Send the original user agent without any modifications.
Dalvik/2.1.0 (Linux; U; Android 7.0; SM-J701F Build/NRD90M)Recommended. IP address of the device in IPv4 format. Required if the ipv6 field is absent.
127.0.0.1Recommended. Name of the operating system installed on the device.
Recommended. Version of the operating system installed on the device.
Recommended. Device-specific identifier for digital advertising. Use when user.id is unavailable.
kjsdnfapp object
Details of the application calling for the impression.
Required if you omit site. Include this object if the ad-supported content is a non-browser application (typically mobile). A bid request must not contain both an App and a Site object.
Unique publisherId you registered with FCC for this client.
1App name (FCC may alias this at the publisher's request).
Domain of the app (e.g., mygame.foo.com).
site object
Details of the website calling for the impression.
Required if you omit app. Include this object if the ad-supported content is a website. A bid request must not contain both a Site and an App object.
Unique publisherId you registered with FCC for this client.
bloomsretailSite name (FCC may alias this at the publisher's request).
Domain of the site (e.g., mygame.foo.com).
user object
Information known or derived about the human user of the device (the audience for advertising). Include this object for user and key-value targeting.
The user ID is an exchange artifact and may be subject to rotation or other privacy policies. The user ID must be stable long enough to serve as the basis for frequency capping and retargeting.
Publisher specific ID for the user.
C785902B8150944Bdata object[]
Optional. Array of Data objects for custom audience targeting. Use the data and segment objects together to define targeting criteria such as demographics and behaviour to target different audience sets.
When present, FCC serves only demand that targets those key-values. Publish segment names and values in FCC Ads Manager before sending them in requests.
Pass user_targeting in this field for custom targeting.
user_targetingsegment object[]required
Array of targeting segments. Each segment is a name and value pair. FCC applies OR logic to multiple values within the same segment and AND logic across different segment keys. Publish segment names and value options in FCC Ads Manager before sending them in requests.
Name of the data segment you configured in FCC Ads Manager.
key-id-1One or more values for this segment key as a comma separated string.
value-id-11,value-id-12geo object
Optional. Geographical information about the user, if available.
Zip or postal code of the user.
110001ext object
Optional. Extension to the User object for supplying additional info such as consent.
If true, FCC applies user targeting. If false, FCC does not apply user targeting for this request.
trueAllowlist of languages for creatives, using ISO-639-1-alpha-2 codes (e.g., en for English).
{
"id": "a7sIT125",
"imp": [
{
"id": "OSGMz25",
"banner": {
"format": [
{
"w": 30,
"h": 20
}
]
},
"video": {
"w": 640,
"h": 360
},
"ext": {
"slotid": "HOME-PAGE-DAILY-UAE5"
}
}
],
"device": {
"ua": "Dalvik/2.1.0 (Linux; U; Android 7.0; SM-J701F Build/NRD90M)",
"ip": "127.0.0.1",
"os": "string",
"osv": "string",
"ifa": "kjsdnf"
},
"app": {
"id": "1",
"name": "string",
"domain": "string"
},
"site": {
"id": "bloomsretail",
"name": "string",
"domain": "string"
},
"user": {
"id": "C785902B8150944B",
"data": [
{
"name": "user_targeting",
"segment": [
{
"name": "key-id-1",
"value": "value-id-11,value-id-12"
}
]
}
],
"geo": {
"zip": "110001"
},
"ext": {
"consent": true
}
},
"wlang": [
"string"
]
}