Onboarding
/
Seller

Onboarding - OOH Seller

Maximise the power of your inventory with VIOOH


Sync your inventory

Overview

This page explains the journey you will have to follow to sync your inventory in the VIOOH platform.

❕ The order may seem strange, but it is important for the way DOOH operates and the dependencies that exist to ensure your inventory is created successfully, without missing any mandatory information.

1️⃣ You start with creating your Audience categories, that define the different data sets you have for each one of your channels (street furniture, airport, etc..).

2️⃣ Then you create your different channels and link them to the proper Audience categories.

3️⃣ Then you create your product formats that exist within your channels. e.g. "Airport - D6S" could be a channel relating to the digital 6 sheets screens that are being operated within your "Airport" channel.

4️⃣ Then you will create all your different Digital specs, that will define the different frame specs you have in your inventory (resolution, rotation, motion/still, etc..). This data is extremely important as it will ensure the creatives playing on your screen are always following the rules in terms of having the right aspect ratio, the proper resolution and rotation, not having video on motion-prohibited screens, etc..

Are we almost ready to create the screens themselves? Not yet but almost.

5️⃣ Optionally, you can create tags, but more importantly, you will have to create the commercial entities, i.e. product categories, advertisers and brands. This neeeds to be completed before creating the assets, so that you can then assign to the assets the right prohibitions against product categories (for instance, alcohol-prohibited screens), or the prohibitions against advertisers directly (blocklists).

Once the above is done, you will then be able to create the screens themselves, that will include geo-coordinates, address, and the links to all the relevant entities created before (link to product format, digital spec, and links to product categories or advertisers through respective prohibitions and counter-prohibitions or blacklists.

Please find below the full journey described, and if you have any questions, as usual, please contact us through support@viooh.com!

Audience categories

Prior to creating the screens themselves, we need to know what are the key audience data sets you are using for each one of your channels. For instance, a media owner in the US might use Geopath for outdoor street furniture, and a bespoke provider for indoor screens in airports. You will need to declare also the latest audience version that is applicable. The UUID needs to be declared in the path, and the body specified as follow.

{
  "name": "Geopath",
  "version": "Version X"
}
{
  "name": "MyAirportAudienceProvider",
  "version": "Version Y"
}

All details are described here

Once you have created your audience category groups above, you will need to create the audience segments that will be used to power up the platform with targeting capabilities.

Each category group can then have different categories. In example below, we are creating segments by nationality of passengers that are linked to the group "MyAirportAudienceProvider". The path needs to specify the UUID of the category group the category is linked to, and the UUID for the category itself, as described here. The body will describe the name of the category, and a parent category if needed (useful if you want to represent categories as a tree in the UI).

In the example below, we have created a category for French passengers that travel in business, and it's described as a child entity of the category 10, being all French passengers

{
"name": "French",
"parent_category": ""
}
{
"name": "French - business",
"parent_category": "10"
}

More details are available here

Asset reference

Now that audience category groups and categories have been created, you will be able to define your channels, which is the top-level segmentation of your business.

Channels and product formats

Channels allow you to split your activity into top-level segments, ie Airports, Billboards, Street Furniture, etc.. For each channel, you need to specify what is the audience measurement in place, hence you need to link it to the proper audience category that has been loaded previously. For instance, if you're creating a "Street Furniture" channel in the UK, and the default audience category to be used is "All Adults" from "Route", you will link the channel to the category "All Adults", which itself is linked to "Route"

{
  "name": "Street Furniture",
  "audience_category_uuid": "12"
}

Please find the full API reference about this entity here

Once your channels are created, the next step is then to create all the product formats that you're operating within each channel. For instance, if you have within your Airport channel, which UUID is 7, two different product formats, one being D6S and the other one being spectaculars, you will do the following to create those two product formats:

{
  "name": "Airport - D6S"
}

Please check the API spec directly to access to more details: Put Channel Product Format

Digital specs

You have one last mandatory thing to do before syncing the screens themselves - syncing the digital specs. This is a very important piece of information, as it defines the different frame specifications you have in your inventory (resolution, rotation, motion/still, etc..), and it then allows to ensure the creatives playing on your screen are always following the rules in terms of having the right aspect ratio, the proper resolution and rotation, not having motion on motion-prohibited screens, etc..

Here's below the information required when you will create your digital specs, specifying the UUID as usual in the path directly

{
  "name": "D6S - portrait",
  "width": 1080,
  "height": 1920,
  "min_width": 1080,
  "min_height": 1920
  "rotation": 90,
  "motion_type": "MOVING",
  "fps": 0,
  "audible": false
}

On the example above, we are creating a portrait 6-sheet specification (that might be common to many screens), with a rotation of 90 degrees, a physical resolution of 1080-1920, and these screens expect creatives with a minimum resolution of 1080/1920. It authorizes motion (it's probably not a roadside screen, where landlords usually prohibit motion), and audio is not allowed. For more details please check our digital spec

Tags

Tags are optional. They allow you to create any attribute and link it to the frame. You can group your tags by tag group, which will allow you to see them grouped in the UI rather than having a long dropdown of tags. To easily filter all the assets that are facing inbound traffic - you can simply create a tag group "Traffic direction", then create the two tags "Inbound" and "Outbound", and then you'll be able to link your assets to Inbound or Outbound which will enable easy filtering in the UI. One frame can belong to as many tags as you want, so you can be very creative and create segments based on the way you package your inventory. For more details please check the tag section on the API reference documentation

Commercial entities

We are now ready to create the screens! 🎉 But there's just one last thing to check.. Do you have prohibitions against product categories or even blocklists? For instance, or some of your screens next to school or sensitive sites, and then alcohol ads are prohibited? Or do you have screens in indoor retail environments (malls, etc..), with either:

  • Specific advertiser blocklisted (ie blocklists)
  • A full product category prohibited, except for brands that actually have stores in the mall (ie prohibition counters)

If one of the statements above is true, you can create the commercial entities first (product categories, advertisers, brands), which will allow you then to create assets and prohibit them against the relevant product categories or advertisers. You could also create your assets right away, and update the prohibitions, blocklists and prohibitions counters through a patch call.

Please find below how to create product categories, advertisers, and brands!

Our API allows you to create your own categories rather than using a standard such as IAB. We've seen media owners that can have more than 500 bespoke product categories and that needs to enforce them to apply the prohibitions at the right level.

Before creating the categories, you will have to create groups. Those groups will be displayed in UI, which allows having an organized tree rather than a very long dropdown. Once the groups are created, you will be able then to create the categories, then proceed with creating the advertisers, the brands and finally linking the brands to the advertisers.

Let's do this with the following example:

  1. We are creating two product category groups, "Drinks" and "Finance"
  2. Below the group "Drinks", we are creating "Soft Drinks" and "Fruit Juices"
  3. Then we are creating the advertiser "Coca-Cola"
  4. And the brands "Honest" and "Sprite", which will be linked respectively to the product categories "Fruit Juice" and "Soft Drinks"
  5. Finally, we will link those two brands to the advertiser "Coca Cola"

Step 1: creating the product category groups You will simply have to use the service documented here You just need to specify the UUID in the path as usual, and describe the name in the body:

{
  "name": "Drinks"
}

and

{
  "name": "Finance"
}

Step 2: creating the product categories Documentation here

You will have to mention the UUID of the parent group in the path, and simply declare the name of the category in the body

Path

{
  "name": "Soft Drinks"
}

and

{
  "name": "Fruit Juices"
}

Step 3: creating the organizations

The VIOOH platform supports 5 types of organisation, including ADVERTISER, DSP, AGENCY, SPECIALIST, BARTER.

To create your organisation, you need to use the service described here You will just have to declare the organization name and the type in the message body:

{
  "name": "Coca-Cola",
  "organisation_type": "ADVERTISER"
}

Step 4: creating the brands

You will use the service described here And you have to simply declare in the body the brand name and the UUID of the relevant product category. In the example below, product categories "Soft Drinks" and "Fruit Juices" have respectively UUID 1 and 2

{
  "name": "Honest",
  "product_category_uuid": "2"
}

and here's the 2nd brand

{
  "name": "Sprite",
  "product_category_uuid": "1"
}

Step 5: linking the brands to the organizations

As you might have noticed, we haven't declared in the brands directly the parent advertiser. This is because the VIOOH platform supports an N-N link between Advertisers and Brands, hence there's a separate service linking brands and advertisers. Please note however that the standard is to have 1 advertiser linked to 1 or many brands, and each brand being linked to a single advertiser. If you need us to support a model with one brand being linked to many advertisers, please contact support@viooh.com as we might have to activate for you a different set of configurations and features.

The mapping is done through the service described here, and you will simply have to declare in the path both UUID for the brand and advertiser that you want to link together.

Creating your screens

You have now created all the mandatory entities (digital specs, product formats, commercial entities...), so now you can proceed with creating the screens!

You will find out more about how to create an asset on our API reference documentation

And here's an example below that describes how to create an asset that has the following attributes

  1. Located in Westfield in London, and mounted
  2. Operating hours between 8 am and 8 pm, Monday to Saturday
  3. An allotment of 10% from Monday to Saturday, from 8 am to 8 pm. It means that VIOOH has a fully delegated inventory of 10%, on which guaranteed PMP deals can be booked upon. The rest of the inventory might still be monetized through non guaranteed deals, but not through guaranteed ones as there's no predictability on the inventory that will be available. You can adjust this allotment value depending on your supply/demand conditions, to match the amount you want to delegate to VIOOH for guaranteed deals. NB: An allotment cannot be taken back, and the API allows you to define different allotment values per day/screen/hour if need be.
  4. A floor CPM of 35 GBP. The API allows you to differentiate the floor by screen, day and hour if need be.
  5. a prohibition against the product category "Soft Drinks"...
  6. ... and a counter prohibition on the organization UUID 836429, which is Coca-Cola. It means all "Soft Drinks" ads will be prohibited, except the ones for Coca-Cola's brands, which might happen for instance if there's a Coca-Cola store in the mall.
  7. A blacklist on a specific advertiser that has the UUID 836429

Here's the message body required for this example:

https://api.viooh.com/v1/assets/1234723760
{
    "asset_uuid": "1234723760",
    "address": {
        "thoroughfare": "WESTFIELD LONDON, FIRST FLOOR RETAIL (LEVEL 1) NEW LOOK",
        "administrative_area": "Greater London",
        "locality": "London",
        "postal_code": "W12 7GF",
        "country": "GBR"
    },
    "longitude": 51.50746,
    "latitude": -0.22341,
    "product_format_uuid": "1216",
    "digital_spec_uuid": "3109",
    "players": [
        {
            "digital_unit_uuid": 55234,
            "digital_player_uuid": 55234,
            "backup": false,
            "in_use": true
        }
    ],
    "tags": [
        {
            "start_date": "2017-07-03",
            "end_date": "2030-12-31,
      "tag_uuid": "2117a6fa-94b6-49f6-9cd7-9890286722ab"
        }
    ],
    "statuses": [
        {
            "start_date": "2017-07-03",
            "end_date": "2030-12-31",
            "status": "MOUNTED"
        }
    ],
    "time_models": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "days": [
                "FRIDAY",
                "MONDAY",
                "SATURDAY",
                "THURSDAY",
                "TUESDAY",
                "WEDNESDAY"
            ],
            "start_offset": 28800,
            "end_offset": 71999
        }
    ],
    "allotment": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "days": [
                "FRIDAY",
                "MONDAY",
                "SATURDAY",
                "THURSDAY",
                "TUESDAY",
                "WEDNESDAY"
            ],
            "start_offset": 28800,
            "end_offset": 71999,
            "sot": 10
        }
    ],
    "price": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "floor_cpm": 35
        }
    ],
    "prohibitions": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "product_category_uuid": "1"
        }
    ],
    "prohibition_counters": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "product_category_uuid": "1",
            "organisation_uuid": "165729"
        }
    ],
    "blacklists": [
        {
            "start_date": "2020-01-01",
            "end_date": "2021-12-31",
            "organisation_uuid": "836429"
        }
    ]
}

You're now done with creating your screens! 🎉 We hope this page has been useful, and as usual if you have any questions or suggestions on this documentation please reach out to us.

board yellow.png

Next up - *Sync Your Audiences

Keep track of your progress

Mark as completed