Advertiser | Publisher | Internal

Yieldbot (sync) tagging, with OAS

Use of Yieldbot tagging breaks into three main areas:

This document describes both the use of the Intent Tag as well as ad tagging.

Document Styling

Code found in regular document text appears as:'1234');

This is regular code in references
This is highlighted code in references

Reference Code

The following reference code shows both the Yieldbot Intent Tag as well as the ad serving tagging for OAS in synchronous rendering mode with a simple example page.

<!-- Intent Tag -->
<script type="text/javascript" src="">
<script type="text/javascript">'1234');
<!-- END Intent Tag -->
<!-- Begin Yieldbot Parameters -->
<script type='text/javascript'>
var yieldbotParams = 'n';
try {
    yieldbotParams = yieldbot.params(['Top', 'Right'], '&');
}catch (e) {}
<!-- END Yieldbot Parameters -->

<script type="text/javascript" src="/CommonControls/Script/oas.js"></script>
<script type="text/javascript">
    OAS_url = '';
    OAS_sitepage = 'publishersite/homepage2';
    OAS_listpos = 'Top,Frame1,Frame2,Right,x01,x02,Middle,x51';
    OAS_query += 'ybot_ad=' + yieldbotParams;
OAS_version = 11;
if ((navigator.userAgent.indexOf('Mozilla/3') != -1) ||
(navigator.userAgent.indexOf('Mozilla/4.0 webTV') != -1))
OAS_version = 10;
if (OAS_version >= 11)
document.write('<SCR' + 'IPT LANGUAGE=JavaScript1.1 SRC="' + OAS_url + '' + OAS_sitepage + '/1' + OAS_rns + '@' +
OAS_listpos + '?' + OAS_query + '"></SCRIPT>');//-->

Yieldbot Intent Tag

The Yieldbot Intent Tag brings state of the art analytics technology, data mining and realtime matching to your site. It is the collection mechanism for Yieldbot publisher analytics and the first step towards harvesting your site intent for increased visitor intelligence and monetization.


For ad serving with OAS in synchronous mode, the Yieldbot Intent Tag must load before any of the OAS ad tags. It’s recommended that this tag be installed where it will need to be for ad serving even prior to enabling the Yieldbot advertising system so that the tag can remain untouched when the transition to ad serving is made.

In this example, line 04 of the intent tag,'1234');, configures the unique identifier for the publisher site that it sits on – in this example the dummy value ‘1234’. To install Yieldbot on your site you must get your own version of the tag which will have the unique value assigned to your site for identification in the Yieldbot platform.

In line 05, yieldbot.defineSlot('Top');, defines the ad slots that are on the current page. There should be a call to defineSlot() for each ad slot on the current page. If not being used for ad serving, calls to defineSlot() should not be present.

Finally, the yieldbot.go(); call on line 07 puts the Intent Tag in motion.

Ad Serving Tags

The tagging for ad serving is shown in the reference code in lines 11 through 24.

Line 15 shows the call to determine the parameters to include in the OAS request URL to the ad server (in OAS_query in line 24), yieldbotParams = yieldbot.params(['Top', 'Right'], '&');. It is placed in a try..catch so that in the case of an error in the Yieldbot code it will not interfere with ad serving.

OAS Configuration

Yieldbot ad serving is accomplished by using OAS’s query string keyname functionality (search term targeting). When Yieldbot has ads available the ad request will come in with a query string parameter of ybot_ad set to the value “y”.

Configuring Keynames

The configuration of the Keyname parameter requires adding it under the Databases role in OAS.

Click “New Keyname” and fill in these fields:
Keyname: ybot_ad
Keyvalue: y

Keyname: ybot_slot
Keyvalue: Top
Keyvalue: Right

Note: Keyvalues for ybot_slot should match the slot names defined in the intent tag.

For any campaign/line item that represents Yieldbot serving the ad, make the serving of the Yieldbot campaign depend on the Keyname ybot_ad having a value of “y”, AND the corresponding ad slotname:

Thirdparty Creative Code

The following is the thirdparty creative code per ad size that gets configured in OAS for the respective Yieldbot campaigns in the publisher ad server.

<!-- Creative Tag -->
<script type="text/javascript" src=""></script>
<script type="text/javascript">
    var ybotq = ybotq || [];
    ybotq.push(function () {
<!-- END Creative Tag -->
<!-- Creative Tag -->
<script type="text/javascript" src=""></script>
<script type="text/javascript">
    var ybotq = ybotq || [];
    ybotq.push(function () {
<!-- END Creative Tag -->