Skip to content

Property Selector

The Property Selector configures a set of script tokens that are unique to a single property. These tokens are mapped to a key/identifier that uniquely identifies a specific property on the vendor's website such as a property's location.

Once configured, the script tokens are used to selectively install/uninstall their tms scripts when their property is selected and/or deselected.

The method of identification on the vendor's site should be discussed and any internal changes to this identifier should be notified to Orbee to persist the Property Selector's functionality

Installation

Add the following snippet to every page on your site.

This should be placed after the Bootloader script and will be loaded after the Bootloader is completely loaded.

<script
  async
  src="https://scripts.orb.ee/custom/{{SCRIPT_ID}}/propertyselector.js"
></script>

The SCRIPT_ID value will be provided with formal install instructions when the script is ready to deploy

Configuration

This script has no public configuration available.

Methods

This plugin has the following available public methods:

getScriptToken

getScriptToken ( key: string ): { token: string, trackerId: string }

Gets the script token associated with the given key

Parameter Type Required Description
key string yes Key identifier of desired property

enableScript

enableScript ( scriptToken: string ): void

Installs the tms script for the given script token

Parameter Type Required Description
scriptToken string yes Script token to install

disableScript

disableScript ( scriptToken: string ): void

Disables the tms script for the given script token.

This will not uninstall the script from the DOM, it will just tell the Web SDK to stop tracking and sending events for this script token.

Parameter Type Required Description
scriptToken string yes Script token to disable

Events

Generated

This script generates no events.

Listening

This script does not listen for any events.

Dependencies

  • The snippet needs to be installed prior to the installation of propertyselector.js
  • The Bootloader must be loaded before propertyselector.js

Last update: 2023-04-13