Learn how to leverage Yahoo SSP (formerly known as AOL One Video) when integrating ads into your content.
Perform the following steps to integrate an Yahoo SSP ad server with live content, VOD, or both:
Configure your Yahoo SSP account as indicated below.
The following parameters may be defined in the content URL when inserting any type of ad from the Yahoo SSP platform:
Parameter | Description |
---|---|
serverURL Required |
Identifies a Yahoo SSP ad decision server by its URL. However, this static parameter should not be included in the content URL. Please use the ad parameter instead. Example: http://ads.adaptv.advertising.com/a/h/goVEVo3rWYgYdVFSx+zlsZrEL3O2+DnfY+DxB78vh7E=?
|
ad Required |
Identifies an ad configuration by its name. |
categories |
Identifies one or more video categories by name. |
id |
Identifies a video by its external ID. |
title |
Defines the ad's title. |
description |
Defines a description for the ad. |
keywords |
Associates keywords with the ad. |
duration |
Defines a duration for the video. |
url |
Indicates a media file's location by its URL-encoded URL. |
context |
Defines a comma-separated list of URL-encoded custom key=value pairs. Leading and trailing whitespace for keys and values will be trimmed. Example: key1%3Dvalue1%2Ckey2%3Dvalue2
|
pageURL |
Identifies the site where the player is embedded through a URL-encoded domain or its full URL. This value is inserted into the request automatically. |
The following parameters are only applicable for mobile requests:
Parameter | Description |
---|---|
ad.aid |
Android advertising ID. Recommended for all mobile requests. |
ad.aid_md5 |
MD5-hashed Android advertising ID. Use this parameter when this ID shouldn't be passed as raw data. |
ad.idfa |
Apple identifier for advertisers. Recommended for all mobile requests. |
ad.idfa_md5 |
MD5-hashed Apple identifier for advertisers. Use this parameter when this identifier shouldn't be passed as raw data. |
ad.ip |
This parameter, which is required for all server-side mobile requests, is automatically set by the system. This parameter should only be set manually during testing. |
ad.ua |
This parameter, which is required for all server-side mobile requests, is automatically set by the system. This parameter should only be set manually during testing. |
Please refer to Yahoo SSP documentation for guidance on creating custom keys.
A prerequisite for ad insertion is the following custom key:
Value: Valid values for this parameter are:
Once the above custom key has been added to your Yahoo SSP account, the system will automatically add the following context parameter for each ad request:
Ad positions are specified by the ad offsets sliced into your content or the following ad.preroll/ad.postroll query string parameters:
Parameter | Description |
---|---|
ad.preroll |
Set this parameter to "1" to add a pre-roll ad. Example: ad.preroll=1
|
ad.postroll |
Set this parameter to "1" to add a postroll ad to on-demand content. Example: ad.postroll=1
|
skippreroll |
If the ad.preroll=1 URL parameter is specified in the Uplynk playback URL, the URL parameter skippreroll=1 forces Uplynk to look ahead in the stream and skip the pre-roll ad if the mid-roll is within 60 seconds of the stream start. skippreroll=1
|
All instances of the following macros in the request URL will be replaced with session-specific values.
Original Macro | Session-Specific Value |
---|---|
cb |
timestamp |
pageURL |
referrer |