Orbee Tag Setup Guide | Client-Side Tags

Orbee provides a tag to its customers to enable the integration of their web analytics and data solutions with their websites. The web SDK snippet allows the customers to send event and user data to Orbee’s servers.

Tag tips

Use mappings to:

Dynamically override configuration data.
Trigger events and set values for event parameters.

Tag configuration

Navigate to the Tag Marketplace to add a new tag. For more information, see About tags.

When adding the tag, configure the following settings:

Script Token: The token of the script that belongs to the client’s account. The Script Token is the same as SID (script identifier).
Host: The domain where the script is being hosted. The default value is scripts.orb.ee.

Load rules

Load the tag on all pages or set conditions for when your tag will load. For more information, see About load rules.

Data mappings

Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For more information, see About data mappings.

The available categories are:

Standard Parameters

Variable	Type	Description
`sid`	String	Script token
`host`	String	Host
`additional_config_info.scope`	String or Array of strings	Scope
`additional_config_info.namespace`	String or Array of strings	Namespace

Event Spec Object Parameters

Variable	Type	Description
`action`	String	Action
`object`	String	Object
`token`	String	Token
`namespaces`	String or Array of strings	Namespaces
`vendor`	String	Vendor
`product`	String	Product
`label`	String	Label
`score`	Number	Score
`instanceID`	String	Instance ID
`element`	Object	Element
`element.classes`	Array of text	Element classes
`element.id`	String	Element ID
`element.href`	String	Element HREF
`element.innerText`	String	Inner text
`element.title`	String	Element title
`element.src`	String	Element SRC
`element.alt`	String	Element alt text
`element.node`	String	Element node
`element.value`	String	Element value
`element.type`	Array of objects	Element type
`elements`	Array of objects	Elements
`custom`	String	Custom

Facebook Plugin

Variable	Type	Description
`facebook.facebookId`	String	Segment name
`facebook.event`	String	Segment ID
`facebook.params`	String	Additional configuration for the Facebook segment
`facebook.token`	String	Script token

Favorites Plugin

Variable	Type	Description
`favorites.element`	String	HTML element to register
`favorites.config`	String	Optional parameters for the Favorite node

Google Ads Plugin

Variable	Type	Description
`googleAds.adwordsID`	String	Google Ads segment name
`googleAds.event`	String	Google Ads segment ID
`googleAds.params`	String	Additional configuration for Google Ads segment

Google Analytics Plugin

Variable	Type	Description
`googleAnalytics.adwordsID`	String	Google segment name
`googleAnalytics.event`	String	Google segment ID
`googleAnalytics.params`	String	Script token

Layout Manager Plugin

Variable	Type	Description
`layoutManager.config`	String	Layout configuration of the ORB element container
`layoutManager.config.id`	String	Configuration ID
`layoutManager.config.location`	String	Configuration location
`layoutManager.config.position`	String	Configuration position
`layoutManager.config.attributes`	Object	Configuration attributes

Notifications Plugin

Variable	Type	Description
`notifications.message`	String	Message
`layoutManager.config`	Object	Custom object
`notifications.notificationId`	String	Notification ID

Variable	Type	Description
`popupConfig.plugin_id`	String	Plugin ID
`popupConfig.context_id`	String	Context ID
`popupConfig.css_url`	String	CSS URL
`popupConfig.display_type`	String	Display type
`popupConfig.popupTimer`	String	Popup timer
`popupConfig.visitThreshold`	String	Visit threshold
`popupConfig.scrollPersentThreshold`	String	Scroll percentage threshold
`popupConfig.scrollTrigger`	String	Scroll trigger
`popupConfig.disableConvertedUsers`	String	Disable converted users
`popupConfig.disaleNewVisit`	String	Disale New Visit
`popupConfig.maxContentDisplayCount`	String	Maximum content display count
`popupConfig.cookieExpirationDays`	String	Cookie expiration in days

Snapchat Plugin

Variable	Type	Description
`snapchat.pixelID`	String	Snapchat pixel ID
`snapchat.event`	String	Name of event
`snapchat.params`	Object	Additional configuration
`snapchat.token`	String	Token

Events

To map events, refer to Create an Event Mapping

Variable	Description
`dropSegment`	Facebook plugin: drop segment
`registerFavoriteNode`	Favorites plugin: register Favorite node
`dropSegment`	Google Analytics plugin: drop Google Analytics segment
`inject`	Layout Manager plugin: inject
`runModules`	Metadata plugin: run modules
`renderNotifications`	Notifications plugin: render notifications
`push`	Notifications plugin: push
`pop`	Notifications plugin: pop
`closeNotification`	Notifications plugin: close notification
`hideNotifications`	Notifications plugin: hide notifications
`showNotifications`	Notifications plugin: show notifications
`loadPopup`	Popup plugin: load popup
`dropSegment`	SnapChat plugin: drop segment
`Custom`	Custom

Event-specific Parameters