Skip to content

Ad Server

Orbee provides customers with the option to use an Ad Server to manage their digital media. The ad server provides a variety of capabilities. This includes providing customized content, specializations by keywords, campaigns, zones, and flights.

Installation

This plugin requires you to install orb elements wherever you want the ads to show up. This does require a couple things:

  • the ID of the orb element must match the installation instructions
  • the additional parameters (campaign, zone, etc.) should match up with what's expected. Orbee's Platform will explicitly specify these for you.

Info

Curious about the orb elements? Want to use DIV's instead? Check out the reference here.

Below is an example installation, put in a div element on a page. For convenience, we've provided both implementations (ORB element and DIV):

<orb id="orb-ad-{ORBEE_PLUGIN_ID}"
     data-type="ad-placement"
     data-plugin-id="{ORBEE_PLUGIN_ID}"></orb>

<div data-orb
     id="orb-ad-{ORBEE_PLUGIN_ID}"
     data-type="ad-placement"
     data-plugin-id="{ORBEE_PLUGIN_ID}"></div>

Configuration

This JavaScript plugin provides the following parameters for you to configure the ads that are available on the page:

Variable Type Required Description
ads array yes ad parameters for each placement
ads[].networkID integer yes network ID provided by Orbee
ads[].siteID integer yes site ID provided by Orbee
ads[].placementID string yes placement ID that matches the corresponding orb element
ads[].adTypeID integer yes the type of the ad, describing the ad's size
ads[].zoneID object no optionally define the zone the orb element is in
ads[].campaignID object no optionally control which campaign shows up
ads[].style string no a style string to apply to the orb element

Methods

This plugin has no public methods.

Events

Generated

This plugin generates the following events:

Action Spec Trigger
marker 
{
    object: 'visit',
    vendor: 'Orbee',
    product: 'AdServer',
    label: 'adserver.{type}'
}
 marks different ad serving capabilities
change 
{
    object: 'element',
    vendor: 'Orbee',
    product: 'AdServer',
    label: 'adserver.serve',
    ad: ad,
}
 notifies when an ad is changed (inserted)

Listening

This plugin does not listen for any events.

Dependencies

This plugin does not depend on any other services or plugins.

Last update: 2023-04-13