Reading time: ±2 minutes
Introduction
You can retrieve venue data from the SSP using the Inventory JSON file stored in a shared S3 bucket. This lets you launch open exchange campaigns independently, without needing support from Vistar or publishers before each campaign’s launch.
The Inventory JSON file helps you:
- Check inventory availability based on your set targeting.
- Estimate the impressions you can traffic.
- Determine creative size requirements and other campaign details.
We store the Inventory JSON file in an S3 bucket: s3://vistarmedia-3p-inventory/production/inventory.json
The file only includes venues with recent avails that are available to third-party DSPs. However, presence in the file doesn't guarantee availability. Also, access may vary by buyer or advertiser.
We refresh the file daily. And, we recalculate avails data every Friday using a 60-day lookback window.
What You'll Learn:
In this topic, you’ll learn:
- How to access the Inventory JSON.
- How to request access to the Inventory JSON.
- About the fields included in the Inventory JSON.
Request Access to the JSON
To access the file, you must provide an AWS ARN for a user role in your AWS account. Once provided, we’ll grant you access to the S3 bucket.
Access the JSON
Run the following command to retrieve the JSON file:
aws s3 cp s3://vistarmedia-3p-inventory/production/inventory.json inventory.json
Fields in the JSON
The following fields are included in the venue drop file:
| Name | Field name | Description | Type | Example |
| Public ID | public_id |
Globally unique identifier of the venue. | String | vae9d:acb1234 |
| Industry ID | industry_id |
Unique identifier for the screen as specified by the publisher. | String | abc1234 |
| ID | id |
Vistar generated UUID based identifier for the venue | String | 1234abcd5678efgh9012ij |
| Venue Name | venue_name |
Name for the venue as defined by the publisher. | String | Test Venue |
| Venue Type ID | venue_type_id |
ID describing the requesting venue type. For mapping of IDs to labels, see Venue types in Vistar’s SSP | Integer | 301 |
| Publisher Display Name | publisher_ |
Name the publisher chooses to display for themselves. | String | Lamar |
| Publisher Currency | publisher_ |
Local currency for the publisher. | String | USD |
| Latitude | latitude |
The requesting screen’s latitude. | Number | 40.71284 |
| Longitude | longitude |
The requesting screen’s longitude. | Number | -74.00615 |
| Country | country |
Country in which the venue is located. | String | US |
| Height | height |
Height of the screen in pixels. | Integer | 1080 |
| Width | width |
Width of the screen in pixels | Integer | 1920 |
| Avg. Floor CPM Cents | avg_floor_ cpm_cents |
Floor CPM of the venue in local currency cents for open auction transactions Cannot exceed a value equivalent to $500 US dollars |
Integer |
800 |
| Publisher Currency | publisher_currency |
Currency of the publisher's CPM floor |
Integer | USD |
| Supports Video |
supports_video |
Whether or not the venue supports video ads | Boolean |
FALSE |
| Supports Banner |
supports_banner |
Whether or not the venue supports banner ads | Boolean |
TRUE |
| Supports Audio |
supports_audio |
Whether or not the venue supports audio | Boolean |
TRUE |
| Min Duration |
min_duration |
Minimum accepted video duration | Integer | 5 |
| Max Duration |
max_duration |
Maximum accepted video duration | Integer | 30 |
| Avg. Daily Impressions |
avg_daily_ impressions |
Average daily impressions available on the screen based on historical request volumes | Number |
24654.4 |
| Avg. Impression Multiplier |
impressions_ per_spot |
dooh.impmultiply value for ads on the screen assuming a 15s spot duration | Number |
12.21 |
| Deal Enabled |
deal_enabled |
Whether or not the venue is available via PMPs/deals | Boolean |
TRUE |
| Open Exchange Enabled |
exchange_enabled |
Whether or not the venue is available via open exchange | Boolean | FALSE |