Placement API Integration

Owned by Hadas Makovsky (Unlicensed)
Last updated: May 21, 2023
2 min read

The Browsi API is a set up method for those who would like to implement Browsi and use current ad placements that will be optimised based on our machine learning software.

Steps

  1. Copy & Paste the code snippet at the highest position within the <head> section of the pages on your website. This snippet needs to be inserted after the Browsi Tag from the first implementation step (see implementation).

<head>
<!-- Script #1 -->
<!-- The following script loads the Browsi Engine A.I -->
<script
src="https://cdn.browsiprod.com/bootstrap/bootstrap.js"
id="browsi-tag"
data-pubKey="pubkey" // will be provided by Browsi
data-siteKey="sitekey" // will be provided by Browsi
async></script>
!-- Script #2 --><
<script>
  window.browsitag = window.browsitag || {};  
window.browsitag.cmd = window.browsitag.cmd || [];
</script>
</head>

 

2. Replace each ad placement tags with the Browsi tags.
Here's a simple example of an ad placement tag by Google (GPT tag):

<body>
<!-- replace this code -->
<div id="banner-ad" styles=”width: 300px; hight: 250px;”>
<script>
  googletag.cmd.push(function() {
  googletag.display('banner-ad);
});
</script>
  </div>
</body>

Replace with:

<body>
<div id="<DIV_ID>"> <script> window.browsitag.cmd.push(() => { window.browsitag.display("<DIV_ID>", { sizes: [ {w:300,h:600},{w:300,h:250},"fluid" ],
adUnit: "AD_UNIT", disableViewabilityOptimization: false , positionTag: 'top'
//can be also: 'bottom','in-content','adhesive','left-rail', 'right-rail'
});
});
</script>
  </div>
</body>

API Parameters

parameter

description

type

required

example

parameter

description

type

required

example

div_id

Element id; must be a single unique id per slot on the page; unit id and element id need to be the same.

string

Yes

“div-gpt-ad-12345”

adUnit

 

Google Ad Manager ad unit to call, including the publisher id and leading “/”. 

When left empty we will use the default configured ad unit on the Browsi platform.

string

Yes

adUnit: "/1234456/browsi/ad/unit"

Sizes

 

A list of all sizes for this specific ad placement.

Format - {w:XXX, h:XXX} (Width x Height). For Fluid ad size - 'fluid'.

array of objects

Yes

sizes: [ {w:300,h:600}, {w:300,h: 250}, "fluid" ]

 

positionTag

 

Communicates the position of the ad element/unit to be served. The position tag can be from the following options: top, bottom, in-content(in-line), adhesive, rail-left and rail-right.

string

Yes

positionTag:'top'