To further help a customer understand the granular data available within the ecosystem, another valuable JSON example is the Detailed Device Inventory response. While the campaign creation and forecasting tools provide high-level summaries, this specific response allows a developer to see the exact technical and geographical characteristics of a single advertising point.
Example: Detailed Device Information Response
This example represents the data structure returned when a GET request is made to the device inventory endpoint. It is especially useful for customers who want to verify exactly where their ads are being shown or for those using "Extended" output to see localized costs.
Endpoint: GET /api/v2/agency/<dsp_agency_id>/dsp/device/
{
"id": 84,
"external_id": 7482,
"name": "Downtown Mall Screen #4",
"resolution": "2160x3840",
"orientation": 2,
"is_deployed": true,
"country": "RU",
"city": "Nizhny Novgorod",
"street": "Bolshaya Pokrovskaya St",
"building": "Building 12",
"floor": 2,
"room": "Food Court",
"latitude": 56.326944,
"longitude": 44.0075,
"ad_plays_cost": {
"min": 150.0,
"max": 150.0
},
"cpm_cost": {
"min": 150.0,
"max": 150.0
},
"cpv_cost": {
"min": 7.5,
"max": 7.5
}
}Why This Example is Important for Learning
Geographic Transparency: Unlike traditional digital ads, DOOH occurs in a physical space. This JSON structure teaches the customer how to access specific location data, including the floor and room (e.g., "Food Court"), allowing for highly contextual creative strategies.
Hardware Compatibility: The
resolutionandorientationfields (where2indicates portrait mode) are essential for the production team. Learning this structure helps developers ensure that the assets uploaded in previous steps will actually fit the target screens.Localized Pricing (Extended Format): By requesting the "extended" format, the customer learns that pricing isn't always uniform across a network8. The
ad_plays_cost,cpm_cost, andcpv_costobjects provide the specific minimum and maximum bids required for that specific device.Operational Status: The
is_deployedboolean allows a developer to programmatically filter out devices that are currently offline or undergoing maintenance, ensuring the budget is only allocated to active hardware.
By understanding this JSON structure, a customer can build a more transparent reporting dashboard for their clients, showing exactly which screens are active and what the specific cost of entry is for premium high-traffic locations.
Comments
0 comments
Please sign in to leave a comment.