Connection and annotation macros

The connect and annotate functions have a few “magic” scopes that will trigger actions in the Burt backend. This document explains the available macros and their mening. All these magic macros start with burt..

Annotations

burt.content

This is used to give extra information about the content of the current page.

• type - Tells what kind of page this is. For example: article, video.
• tags - Tag the page. For example: sports, golf, motor

Examples

window.burtApi.annotate('burt.content', 'type', 'article')
window.burtApi.annotate('burt.content', 'tags', ['sports', 'golf'])

Connections

burt.campaign

This is used for reporting campaign data. The name is one of the following:

• campaign-id - The id of the campaign that the ad belongs to.
• creative-id - The id of the creative.

Examples

window.burtApi.connect('burt.campaign', 'campaign-id', '1234567')
window.burtApi.connect('burt.campaign', 'creative-id', '1234567')

burt.creative

This is used to give additional information about the creative content inside a unit

• preview-url - A url to an image preview of the contents inside the unit

Examples

window.burtApi.withUnits('name', function(unit) {
  unit.connect('burt.creative', 'preview-url', 'http://some-domain/image.png')
});