Standard Schemas for OOH Data Onboarding

This page is the field-level specification for OOH data delivered to Mira. It is the reference to send a vendor when asking them to prepare a file, and the thing to check a sample against before uploading it.

Two ideas run through all four schemas. Standard metadata fields have fixed names and consistent meaning across every Source type, so anything supplied under them can be reported on without further configuration. Custom fields carry whatever else you want to cut by, and are recognised by their prefix.

Any field present in a file - standard or custom - becomes available as a cut on a Study. Anything absent cannot be recovered later, which is why it is worth deciding what you want to report on before the data is delivered rather than after.

Standard Metadata fields

This is a set of fields that are available for all

• unit_id - Identifier for an OOH unit that may be internal to the customer
• geopath_id - Geopath/TAB Identifer for an OOH unit
• venue_type - OOH format
• vendor_name - name of publisher / vendor
• contract_id - ID of the contract between the buyer and seller (e.g. agency and publisher)
• campaign_id - Vendor-internal campaign ID
• creative_id - Vendor-internal creative identifier

Custom Metadata fields

We will allow custom metadata fields.

Custom field names must be prefixed with some defined token, e.g. custom_. So only fields that begin with the custom prefix will be considered as a custom field (e.g. custom_flight_name)

Static

• latitude - required - latitude of unit
• longitude - required - longitude of unit
• facing - optional - cardinal direction that a screen faces, e.g. "N" or "NW"
• metadata fields
• custom fields

Static Geojson

• Geojson file (normal FeatureCollection or line-delimeted features, not important)
• geometry - required - specified in Geometry field
• properties dict
  • metadata fields
  • custom fields

Digital OOH Ad Play

• latitude - required
• longitude - required
• facing - optional
• start_time - required
• end_time - required
• metadata fields
• custom fields

Moving OOH Waypoint

The moving OOH schema can be thought of in a few chunks:

Start position/time - required

• start_time - required
• start_latitude - required
• start_longitude - required
• start_speed - optional
• start_bearing - optional
• start_facing - optional

End Position / Time

• end_time - required
• end_latitude - required
• end_longitude - required
• end_speed - optional
• end_bearing - optional
• end_facing - optional

Moving Specific Metadata Fields

• vehicle_id
• route_id
• gtfs - if this is something we can update in the future we can omit it

General Fields

• metadata fields
• custom fields