# Instreamatic VAST

Instreamatic allows you to request ads in VAST format.

In order to do so, make an ad call to [http://x3.instreamatic.com/v5/vast/{site\_id}](http://x3.instreamatic.com/v2/vast/%7Bsite_id%7D), where site\_id is a site identifier.

### Test tags

#### For Audio Ads:

<https://x3.instreamatic.com/v5/vast/777/483[^1>]

777 is the Test ID

Please use these parameters only for testing purposes. We will provide your actual site\_id after the integration is complete.&#x20;

The same VAST-Tag format will be delivered for Contextual Audio Ads.

#### For Contextual Video Ads:

<https://x3.instreamatic.com/v2/vast/2279?campaign_id=1194>

For alternative versions of the ad please use the following tags:

<https://x3.instreamatic.com/v2/vast/2277?campaign_id=1194>

<https://x3.instreamatic.com/v2/vast/2280?campaign_id=1194>

You'll receive different publisher names in each of the ads depending on the publisher ID in the tag.

Please use these parameters only for testing purposes. We will provide your actual site\_id after the integration is complete.

### Ad request parameters

You need to use the following construction in order to send parameters e.g. targeting details:&#x20;

{% hint style="info" %}
*<http://x3.instreamatic.com/v5/vast/{site\\_id}/{player\\_id}?slot={slot}\\&noad={noad}\\&preview={preview}\\&user\\_id={user\\_id}\\&ip={ip}\\&gender={gender}\\&age={age}\\&country={country}\\&region={region}\\&media={media}&{variable}={variable.value}>*
{% endhint %}

Where:

| *Parameter Name*          | Description                                                                                                                                                                      |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| slot                      | The slot type - preroll/midroll/postroll. Can be empty if you don't need to specify the slot type                                                                                |
| preview                   | Flag for tests. Not to be used in production environment.                                                                                                                        |
| user\_id                  | Optional user identifier, you will receive the necessary information on it from support if needed.                                                                               |
| ip                        | ip address for geo-targeting                                                                                                                                                     |
| gender                    | Gender parameter for targeting                                                                                                                                                   |
| age                       | Age parameter for targeting in min-max format                                                                                                                                    |
| country                   | Country code in a format ISO 3166-1 alpha-2                                                                                                                                      |
| region                    | Geoip code for a region                                                                                                                                                          |
| media                     | Preset for the format of your creative: mp4, mp3, ogg. (if needed)                                                                                                               |
| idfa                      | Advertising id for iOS                                                                                                                                                           |
| advertising\_id (or gaid) | Advertising id for Android *(gaid can also be used instead of advertising\_id)*                                                                                                  |
| user\_agent               | Can be used if you need to specify a certain platform in ad request                                                                                                              |
| type                      | <p>Campaign type <br>any - will request an ad of any type<br>radio - for audio-only ads<br>digital - for audio ads with banner</p><p>voice - for voice ads</p>                   |
| variable                  | Custom variable for precise targeting needs. Please contact support.                                                                                                             |
| bundle-id                 | Bundle ID of the app                                                                                                                                                             |
| store-id                  | Store ID of the app                                                                                                                                                              |
| store-url                 | URL for app store/google play listing of the app                                                                                                                                 |
| domain                    | domain of the website or app developer/owner                                                                                                                                     |
| screen\_on                | <p>1 if the player is present on the screen (for web when the tab is open, for mobile devices when the app in the foreground). </p><p>0 if the player is not on the screen. </p> |

You can also use 'Variables' for additional targeting options. You need to discuss variables names you want to use, and their values with your manager.&#x20;

Then you will be able to use it as follows:

```
{variable.name}={variable.value}, for example: 
https://x.instreamatic.com/v5/vast/420?genre=pop
```

**Example VAST usage for JWPlayer 6**

```javascript
jwplayer("player").setup({
    file: "http://content.jwplatform.com/videos/bkaovAYt-640.mp4",
    width: '640px',
    height: '380px',
    aspectratio: '4:3',
    primary: 'flash',
    advertising: {
      client: "vast",
      tag: "//x3.instreamatic.com/v5/vast/777"
    }
  });
```

Please find the documentation on VAST format for reference -  <https://www.iab.com/wp-content/uploads/2015/06/VASTv3_0.pdf>

[^1]:
