Heap Tag Setup Guide
This article describes how to configure the Heap Tag.
Tag Configuration
First, go to the tag marketplace and add the Heap Tag to your profile (See Add a tag). After adding the Tag, configure the below settings:
- Title (Required): The default is
Heap. You may replace it with a custom name of choice. - Application ID (Required): Enter the Application ID provided by Heap.
- String Delimiter: This is the default seperator (semicolon) for passing an array as delimited strings. You may replace it with another delimiter of choice.
Override, or dynamically populate, the Application ID and String Delimiter using Data Mappings.
Load Rules
Load Rules determine when and where to load an instance of this Tag on your site.
Recommended Load Rule: The default All Pages Rule.
Data Mappings
Mapping is the process of sending data from a Data Layer Variable to the corresponding destination variable of the vendor Tag. For instructions on how to map a variable to a tag destination, see Mapping Variables.
The destination variables for the Heap Tag are built into its Data Mapping toolbox under the following categories:
Standard
In the following destinations, replace custom with your specific value.
| Destination Name | Description |
|---|---|
| Application ID | The app id value provided by Heap |
| User ID | Unique visitor identifier assigned by Heap |
Track Event Properties (track.custom) |
Attach event properties to the event being tracked. Mapping to this destination triggers the heap.track() function (learn more). |
Add Event Properties (addEventProperties.custom) |
Attach new event properties to the visitor’s subsequent events (learn more). |
Add User Properties (addUserProperties.custom) |
Attach new properties to a visitor profile (learn more) |
| String Delimiter | The delimiter character for separating array values. Mapping to this destination overrides the default semicolon delimiter. |
Event Triggers
The Heap Tag automatically triggers any events that are defined in your Heap interface. But when you want to trigger events on the fly, without defining them in Heap first, you must map them in the Event Triggers category.
Triggering an event requires two things:
- event name
- trigger string (ideally a Data Layer value from the page where you want the event to trigger).
To map an event trigger,
- Under Data Mappings, select your event variable from the Variables dropdown.
- Click on Select Destination and go to the Event Triggers category.
- In the Value field, enter the value of the variable being mapped. This becomes the trigger string.
- In the Trigger field, specify a name for the event.
- Click Add.
Repeat if you want to add more triggers.
How it works
As the tag loads on a page, it scans the Data Layer to see what value is populated in the mapped Variable. If it’s equal to the supplied trigger string, the tag fires the event.
The Ecommerce Extension does not automatically map any e-commerce Variables for this Tag.
Vendor Documentation
This page was last updated: February 10, 2017