- Overview
- Getting started with the Tracking Package
- Constructing the Event Object
- Types of events
- Event Object Parameters
- How to populate the actionLabel parameter
- Examples
- Testing the Tracking Implementation
- FAQ
The Tracking Package enables you to measure views and engagement across your applications. This documentation provides implementation instructions and reference materials geared towards a developer audience.
To track a new application, developers construct an event object for each event they wish to track and utilize this npm package to send the event. Once sent, the tracking package formats each event object according to the specifications outlined in the emDataStandards and pushes it to a dataLayer object. Subsequently, both customers and EveryMundo have the ability to leverage a tag manager to access the data layer values and transmit events to an Analytics account.
Follow these simple steps to quickly integrate the Tracking Package into your project for seamless event tracking.
Step 1: Download the npm Package
Install @everymundo/airmodules-event-datalayer by using npm. Open your terminal and run:
npm install @everymundo/airmodules-event-datalayerStep 2: Import the Formatter Function into the Project
In your project file where you plan to implement event tracking, import the formatter function. Add the following line at the top of your file:
import { formatter } from "@everymundo/airmodules-event-datalayer"Step 3: Construct the Event Object Based on Vertical
Create an event object that captures the relevant information for the specific event you want to track. Ensure that the object follows the required structure and contains essential details related to the event. Refer to the details below for more information.
Example
const eventObject = {
event: 'viewable_impression',
module: 'em-booking-popup',
eventAction: 'viewable_impression',
actionLabel: '',
airlineIataCode: 'UL',
journeyType: 'ONE_WAY',
originAirportIataCode: 'CMB',
destinationAirportIataCode: 'SIN',
route: 'CMB>SIN',
currencyCode: 'LKR',
totalPrice: 5.21,
totalPriceUSD: '',
fareClass: 'ECONOMY',
departureDate: '2021-03-13',
returnDate: '2021-06-14',
daysUntilFlight: 25,
tripLength: 93,
isFlexibleDates: '',
discountCode: '',
deeplinkSiteEdition: '',
miles: '',
timestamp: '2021-02-16T00:00:00.000Z',
url: 'https: //www.srilankan.com/en-lk/',
passenger: [
{
count: 1,
adultCount: 1,
youngAdultCount: '',
childCount: '',
infantInLapCount: '',
infantInSeatCount: ''
}
],
page: [
{
siteEdition: 'en-LK',
countryIsoCode: 'LK',
languageIsoCode: 'en',
pageTypeName: 'CUSTOM_PAGE'
}
],
lodging: [
{
cityCode: 'SIN',
name: 'Intercontinental',
startDate: '2021-03-13',
endDate: '2021-03-20',
roomCount: 2,
tripLength: 7,
starRating: 5
}
],
moduleId: '',
tagName: ''
}Step 4: Call the Function Based on Vertical
After constructing the event tracking object, use the appropriate function based on the tenant type (vertical) to format and process the event. Pass the event object as the parameter to ensure accurate tracking.
// For Vertical Airlines
formatter.formatAirlines(eventObject);
// For Vertical Hospitality
formatter.formatHotels(eventObject);
// For Vertical Events
formatter.formatEvents(eventObject);These functions are designed to handle specific verticals and ensure proper formatting of the event object. Here's a brief explanation of the process:
-
Handling Missing Fields: If the event object is missing values for certain keys, the respective keys will be assigned empty values during the formatting process.
-
Handling Null Values: Null values in the event object will be converted to an empty string during the formatting process.
-
Handling Multiple Values: If 'eventExperience' contains multiple values (e.g., "The Lounge," "Player Pod"), the function will format them to "MULTIPLE."
-
Pushing to the dataLayer: After formatting, the resulting data will be pushed to the dataLayer, making it ready for further processing and analysis by analytics tools.
Ensure you choose the correct function based on your application's vertical to maintain consistency in data formatting and tracking. Customize the event object and parameters as needed for your specific tracking requirements.
Events let you measure user interactions on your app; for example, you can measure when someone, clicks on a button or interacts with a filter. The data from events is used to create reports.
Step 1: Select the Empty Event Object by Vertical
Identify the appropriate empty event object template based on the vertical or category of the event you intend to track. Different verticals may require specific information to be captured.
Airlines
const eventObject = {
event: '',
module: '',
eventAction: '',
actionLabel: '',
airlineIataCode: '',
journeyType: '',
originAirportIataCode: '',
destinationAirportIataCode: '',
route: '',
currencyCode: '',
totalPrice: 0,
totalPriceUSD: '',
fareClass: '',
departureDate: '',
returnDate: '',
daysUntilFlight: 0,
tripLength: 0,
isFlexibleDates: '',
discountCode: '',
deeplinkSiteEdition: '',
miles: '',
timestamp: '',
url: '',
passenger: [
{
count: 1,
adultCount: 1,
youngAdultCount: '',
childCount: '',
infantInLapCount: '',
infantInSeatCount: ''
}
],
page: [
{
siteEdition: '',
countryIsoCode: '',
languageIsoCode: '',
pageTypeName: ''
}
],
lodging: [
{
cityCode: '',
name: '',
startDate: '',
endDate: '',
roomCount: 0,
tripLength: 0,
starRating: 0
}
],
carRentals: [
{
provider: '',
brand: '',
model: ''
}
],
moduleId: '',
tagName: ''
}Hospitality
const eventObject = {
event: '',
module: '',
eventAction: '',
actionLabel: '',
tenantCode: '',
tenantType: '',
regionName: '',
countryCode: '',
cityName: '',
propertyCode: 0,
propertyName: '',
currencyCode: '',
totalPrice: 0,
totalPriceUSD: 0,
startDate: '',
endDate: '',
daysUntilBooking: 0,
tripLength: 0,
roomAccesibility: true,
timestamp: '',
url: '',
guest: [
{
count: 0,
adult: 0
}
],
room: [
{
count: 0,
type: ''
}
],
page: [
{
siteEdition: '',
countryIsoCode: '',
languageIsoCode: '',
pageTypeName: ''
}
],
}Events
const eventObject = {
event: '',
module: '',
eventAction: '',
actionLabel: '',
tenantCode: '',
tenantType: '',
regionName: '',
countryCode: '',
cityName: '',
propertyCode: 0,
propertyName: '',
currencyCode: '',
totalPrice: 0,
totalPriceUSD: 0,
startDate: '',
endDate: '',
daysUntilBooking: 0,
tripLength: 0,
roomAccesibility: true,
timestamp: '',
url: '',
guest: [
{
count: 0,
adult: 0
}
],
room: [
{
count: 0,
type: ''
}
],
page: [
{
siteEdition: '',
countryIsoCode: '',
languageIsoCode: '',
pageTypeName: ''
}
],
}Step 2: Decide Which Events to Track in the 'event' and 'eventAction' Fields
Determine the key events you want to track and assign them to the 'event' and 'eventAction' fields. These fields define the type of user interaction and the specific action taken and take identical values. For example:
const eventObject = {
event: 'viewable_impression',
module: 'em-booking-popup',
eventAction: 'viewable_impression',
...
};Adjust the values of 'event' and 'eventAction' to accurately reflect the nature of your tracked events. Refer to Types of Events below for more information.
Step 3: Set Up Event Parameters
The event object includes several parameters to provide detailed context to a specific event for better analysis. For instance:
const eventObject = {
event: 'viewable_impression',
module: 'em-booking-popup',
eventAction: 'viewable_impression',
actionLabel: '',
airlineIataCode: 'UL',
journeyType: 'ONE_WAY',
originAirportIataCode: 'CMB',
destinationAirportIataCode: 'SIN',
route: 'CMB>SIN',
currencyCode: 'LKR',
totalPrice: 5.21,
...
};Refer to Event Object Parameters below for a detailed explanation of each parameter, and which ones are required.
[!NOTE] Automatically collected events are events that are collected by default. These events include:
- Pageviews: A pageview is recorded when a user loads a new page
- Viewable impressions: A viewable impression is recorded when a module is displayed on the user's screen.
Recommended events are events that you implement, but that have predefined names and parameters. These events unlock existing and future reporting possibilities. The following is a list of recommended events that you can track using the tracking package:
For Airlines
| Event |
|---|
| viewable_impression |
| fsi |
| open_booking_popup |
| select_origin |
| select_destination |
| select_departure_date |
| select_return_date |
| select_journey_type |
| select_miles |
| expand_form |
| collapse_form |
| sort |
| more_deals |
| select_tab |
| filter_airlines |
| select_budget |
| select_fare_class |
| collapse_histogram |
| select_month |
| expand_flight |
| reset_filter |
| toggle_farelist |
| select_map_destination |
| selected_travel_interest |
| select_interest |
| click_out |
| read_article |
| select_location |
| search |
| select_status |
| select_stops |
| select_article |
| select_resident_status |
| no_fares_available |
| insert_first_name |
| insert_last_name |
| insert_email |
| insert_phone_number |
| subscribe |
| enter_promo_code |
For Hotels
| Event |
|---|
| viewable_impression |
| search_initiation |
| open_booking_popup |
| more_deals |
| select_origin |
| select_trip_length |
| sort |
| select_rating |
| select_destination |
| select_budget |
| reset_filter |
| select_night |
| search_initiation |
| select_property |
| select_start_date |
| select_end_date |
| select_room_guest |
| select_accessibility |
| select_redemption |
| select_stay_length |
| select_offer |
| no_fares_available |
| insert_first_name |
| insert_last_name |
| insert_email |
| insert_phone_number |
| subscribe |
| enter_promo_code |
For Events
| Event |
|---|
| viewable_impression |
| search_initiation |
| open_booking_popup |
| select_date |
| select_session |
| select_category |
| select_experience |
| select_location |
| select_budget |
| sort |
| reset_filter |
| no_fares_available |
| insert_first_name |
| insert_last_name |
| select_origin |
| insert_email |
| insert_phone_number |
| subscribe |
| enter_promo_code |
Custom events are events that you define. Make sure to only create custom events when no other events work for your use case. Custom events do not show up in most standard reports and require a custom request for meaningful analysis. (we give guidelines in case nothing on our list is appropriate)
To track a custom event, simply add in the event object an event action name and/or module name that is not on the recommended list.
The event object must contain the following properties:
- event and eventName: The name of the event. Both fields have the same value.
- module: The name of the module.
For example, the following event object would track a custom event called "product_detail_clicked" for a new module ':
const eventObject = {
event: 'product_detail_clicked',
module: '',
eventAction: 'product_detail_clicked',
...
}[!NOTE] Guidelines for tracking custom events
When tracking custom events, it is important to follow the following guidelines:
- Use descriptive event names. This will help you to easily identify and analyze your event data.
- Avoid tracking too many custom events. This can make your event data difficult to analyze.
- Only track custom events that are important to your business. This will help you to focus on the most important events and to get the most out of your tracking data.
This section provides a detailed explanation of the parameters used in the event object, along with their examples, definitions, and whether they are required.
-
The parameters marked as required need to be inluded in all events.
-
The viewable-impression events will only collect the required parameters.
-
The interaction events, such as select-departure-date, will only populate the relevant parameters to the event itself and what has already been filtered in the module.
Common Parameters Across All Verticals
| Parameter | Example | Definition | Required |
|---|---|---|---|
| event | T_123456 | Name of the event performed | Yes |
| module | em-booking-popup | Name of the module | Yes |
| eventAction | viewable_impression | Name of the event action used in GA Reports | Yes |
| actionLabel | ... | Populated based on what was selected in the user interaction. See details below. | Optional |
| tenantCode | HDI | Tenant Code | Yes |
| tenantType | hotel | Tenant Type (Hotel, Airline, Event) | Yes |
| currencyCode | USD | The currency (in 3-letter ISO 4217 format) of the price | Yes |
| totalPrice | 399.37 | The total price for the reservation or ticket, including applicable taxes, shipping, etc | Yes |
| totalPriceUsd | 530.62 | The total price for the reservation or ticket in USD, including applicable taxes, shipping, etc. | Yes |
| startDate | 2022-04-01 | Date of check-in | Yes |
| endDate | 2022-04-07 | Date of check-out | Yes |
| timestamp | 2021-02-16T17:41:43.200Z | Timestamp of the event sent | Yes |
| url | https://www.example.com | Full URL in lowercase (without query parameters to avoid collecting personal data by mistake) | Yes |
| adultCount, youngAdultCount, childCount | 1 | Amount of adult/young adult/child passengers | Yes |
| count | 3 | Amount of guests for a specific category | Yes |
| siteEdition | en-HK | Site edition combination of ISO codes for language and country. The country reflects the market | Yes |
| countryIsoCode | HK | Country code (in 2 letter codes from ISO 3166-1) | Yes |
| languageIsoCode | en | Language ISO 629-1 code | Yes |
| tagName* | Name given by Standard Fare Modules or Front Components. *Required if there is a name or tag associated with the module other than the module name. E.g. A module that only displays miles and has been named "Miles" | No | |
| discountCode | AFFBFAN | Discount promotion code | Optional |
| pageTypeName | CUSTOM_PAGE | Name of the type of page template | No |
Airlines Vertical Parameters
| Parameter | Example | Definition | Required |
|---|---|---|---|
| airlineIataCode | AA | IATA identifier for the airline | Yes |
| journeyType | ONE_WAY | Trip type (ROUND_TRIP, ONE_WAY, MULTI_CITY) | Yes |
| originAirportIataCode | SFO | IATA identifier for the departure/origin airport | Yes |
| destinationAirportIataCode | JFK | IATA identifier for the arrival/destination airport | Yes |
| route | SFO>JFK | Route of the trip from origin to destination | Yes |
| currencyCode | USD | The currency (in 3-letter ISO 4217 format) of the price | Yes |
| totalPrice | 399.37 | The total price for the flight ticket, including applicable taxes, shipping, etc | Yes |
| totalPriceUsd | 530.62 | The total price for the flight ticket in USD, including applicable taxes, shipping, etc. | Yes |
| fareClass | ECONOMY | Fare class type (ECONOMY, BUSINESS, PREMIUM_ECONOMY, FIRST) | Yes |
| departureDate | 2022-04-01 | Date of departure | Yes |
| returnDate | 2022-04-07 | Date of return | Yes |
| daysUntilFlight | 25 | Amount of days from the current date to the departure date | Yes |
| tripLength | 5 | Length of stay / trip | Yes |
| isFlexibleDates | true | True/false value if flexible dates are selected for flights | Yes |
| discountCode* | AFFBFAN | Discount promotion code | Optional |
| deeplinkSiteEdition | en-HK | Site edition combination of ISO codes for language and country provided in the URL | Yes |
| miles | 25790 | Flight distance in miles | Yes |
| timestamp | 2021-02-16T17:41:43.200Z | Timestamp of the event sent | Yes |
| url | Full URL in lowercase (without query parameters to avoid collecting personal data by mistake) | Yes | |
| adultCount, youngAdultCount, childCount | 1 | Amount of adult/young adult/child passengers | Yes |
| infantInLapCount | 1 | Amount of infant passengers in lap | Yes |
| infantInSeatCount | 1 | Amount of infant passengers in seat | Yes |
| count | 3 | Amount of passengers for a specific category | Yes |
| siteEdition | en-HK | Site edition combination of ISO codes for language and country. The country reflects the market | Yes |
| countryIsoCode | HK | The country code (in 2-letter codes from ISO 3166-1) | Yes |
| languageIsoCode | en | The language ISO 629-1 code | Yes |
| cityCode | SIN | The city code for the selected property (in 2-letter codes from ISO 3166-1) | Yes |
| name | Intercontinental | Name of the selected property. | Yes |
| startDate | 2021-03-13 | Date of check-in | Yes |
| endDate | 2021-03-20 | Date of check-out | Yes |
| roomCount | 2 | Amount of rooms selected | Yes |
| tripLength | 7 | Length of stay/trip | Yes |
| starRating | 5 | An official rating for the property | Yes |
| moduleId | XADPLIK7890 | Unique ID used for the module. Only required for DPA | Yes - for DPA modules only |
| tagName | Name given to Standard Fare Modules (SFM) / Front Components (FC) | Yes - if there is a name or tag associated with the module other than the module name. E.g., A module that only displays miles and has been named "Miles". | |
| provider | Hertz | Name of the car rental company | Optional - Required only if there is car rental information available |
| brand | BMW | Make of the rental car | Optional - Required only if there is car rental information available |
| model | 530i | Model of the rental car | Optional - Required only if there is car rental information available |
Hospitality Vertical Parameters
| Parameter | Example | Definition | Required |
|---|---|---|---|
| emcid | T-123456 | Unique identifier | Yes |
| tenantCode | HDI | Tenant Code | Yes |
| tenantType | hotel | Tenant Type (Hotel, Airline, Event) | Yes |
| module | open-booking-popup-abstract | Name of the event | Yes |
| actionLabel | open-booking-popup | Name of the event action | Yes |
| regionName | North America | Name of the region for the selected property (North America, South America, East Asia...) | Yes |
| countryCode | US | The country code for the selected property (in 2 letter codes from ISO 3166-1) | Yes |
| cityName | Miami | Name of the city for the selected property (Miami, Orlando, Tampa...) | Yes |
| propertyCode | HYATT9015479 | Code of the selected property (Hotel code, event code...) | Yes |
| propertyName | HolidayInn-Miami | Name of the selected property. e.g Name of the Hotel (Holiday Inn - Miami, Hyatt Regency Hong Kong...) | Yes |
| currencyCode | USD | The currency (in 3-letter ISO 4217 format) of the price. | Yes |
| totalPrice | 399.37 | The total price for the reservation or ticket, including applicable taxes, shipping, etc | Yes |
| totalPriceUsd | 530.62 | The total price for the reservation or ticket in USD, including applicable taxes, shipping, etc. | Yes |
| startDate | 2022-04-01 | Date of check in | Yes |
| endDate | 2022-04-07 | Date of check out | Yes |
| daysUntilBooking | 25 | Amount of days from the current date to the startDate (Check-in date) | Yes |
| tripLength | 5 | Length of stay / trip | Yes |
| roomAccesibility | false | Room accessibility requirement | Yes |
| timestamp | 2021-02-16T17:41:43.200Z | timestamp of the event sent | Yes |
| url | https://www.holidayinn.com/miami | Full url in lowercase (without query parameters to avoid collecting personal data by mistake) | Yes |
| adult | 1 | Amount of adult guests | Yes |
| child | 1 | Amount of child guests | Yes |
| count (in guest array) | 3 | Amount of guests for a specific category | Yes |
| count (in room array) | Amount of rooms selected | Yes | |
| type | Suite | Room type | Yes |
| pageTypeCode | CI | Page Type Code: HP, CICO, FCI, TCI, CICI, COCI, COCO, FCO, TCO, EXT, CP, 404, SM, BS, FS, FA | Yes |
| siteEdition | en-HK | Site edition combination of ISO codes for language and country. The country reflects the market | Yes |
| countryIsoCode | HK | The country code (in 2 letter codes from ISO 3166-1) | Yes |
| languageIsoCode | en | The language ISO 629-1 code | Yes |
| tagName | Name given to Standard Fare Modules (SFM) / Front Components (FC) | Yes - if there is a name or tag associated with the module other than the module name. E.g., A module that only displays miles and has been named "Miles". | |
| discountCode | AFFBFAN | Discount promotion code | Yes |
| pageTypeName | CUSTOM_PAGE | Name of the type of page template | Yes |
Events Vertical Parameters
| Parameter | Example | Definition | Required |
|---|---|---|---|
| tenantCode | HDI | Tenant Code | Yes |
| tenantType | hotel | Tenant Type (Hotel, Airline, Event) | Yes |
| event | search_initiation | Name of the event | Yes |
| module | open-booking-popup-abstract | Name of the interacted module | Yes |
| eventAction | search_initiation | Name of the event action used in Google Analytics Reports. It is the same value as the “event” field. | Yes |
| actionLabel | Book Now | Name of the event action | Yes |
| eventName | Semifinal | Name of the Event | Yes |
| eventLocation | Laver Arena | Location for the selected Event | Yes |
| eventSession | Night | Time of the Event session | Yes |
| eventExperienceCategory | Ticket Only | Name of the selected experience category | Yes |
| eventNameFilter | Semifinal | Name of the filtered Event | Yes |
| eventLocationFilter | Laver Arena | Name of the filtered Event location | Yes |
| eventSessionFilter | Night | Name of the filtered session | Yes |
| eventExperienceCategoryFilter | Ticket Only | Name of the filtered experience category | Yes |
| eventExperienceFilter | MULTIPLE | Types of Event experiences selected | Yes |
| currencyCode | USD | The currency (in 3-letter ISO 4217 format) of the price. | Yes |
| totalPrice | 399.37 | The total price for the reservation or ticket, including applicable taxes, shipping, etc | Yes |
| totalPriceUsd | 530.62 | The total price for the reservation or ticket in USD, including applicable taxes, shipping, etc. | Yes |
| startDate | 2022-04-01 | Date of check in | Yes |
| endDate | 2022-04-07 | Date of check out | Yes |
| timestamp | 2021-02-16T17:41:43.200Z | timestamp of the event sent | Yes |
| url | https: //www.srilankan.com/en-lk/ | Full url in lowercase (without query parameters to avoid collecting personal data by mistake) | Yes |
| adultCount, youngAdultCount, childCount | 1 | Amount of adult/young adult/child passengers | Yes |
| count | 3 | Amount of guests for a specific category | Yes |
| siteEdition | en-HK | Site edition combination of ISO codes for language and country. The country reflects the market | Yes |
| countryIsoCode | HK | The country code (in 2 letter codes from ISO 3166-1) | Yes |
| languageIsoCode | en | The language ISO 629-1 code | Yes |
| tagName* | Name given by Standard Fare Modules or Front Components. | Yes - if there is a name or tag associated with the module other than the module name. E.g., A module that only displays miles and has been named "Miles". | |
| discountCode | AFFBFAN | Discount promotion code | Yes |
| pageTypeName | CUSTOM_PAGE | Name of the type of page template | Yes |
How to populate the actionLabel parameter
The 'actionLabel' serves as a descriptive label, tracking what was specifically selected based on the event. For instance, when the event is 'select-interest,' the 'actionLabel' might capture values like 'snorkeling.'
| Event | Action Label |
|---|---|
| select-budget | 1000 |
| select-interest | snorkeling |
| select-destination | MIA |
| select-departure-date | 2023-04-01 |
- Note that for select-destination and select-departure-date the values will also have to be included in the relevant event object parameters.
Airlines
const eventObject = {
event: 'viewable_impression',
module: 'em-booking-popup',
eventAction: 'viewable_impression',
actionLabel: '',
airlineIataCode: 'UL',
journeyType: 'ONE_WAY',
originAirportIataCode: 'CMB',
destinationAirportIataCode: 'SIN',
route: 'CMB>SIN',
currencyCode: 'LKR',
totalPrice: 5.21,
totalPriceUSD: '',
fareClass: 'ECONOMY',
departureDate: '2021-03-13',
returnDate: '2021-06-14',
daysUntilFlight: 25,
tripLength: 93,
isFlexibleDates: '',
discountCode: '',
deeplinkSiteEdition: '',
miles: '',
timestamp: '2021-02-16T00:00:00.000Z',
url: 'https: //www.srilankan.com/en-lk/',
passenger: [
{
count: 1,
adultCount: 1,
youngAdultCount: '',
childCount: '',
infantInLapCount: '',
infantInSeatCount: ''
}
],
page: [
{
siteEdition: 'en-LK',
countryIsoCode: 'LK',
languageIsoCode: 'en',
pageTypeName: 'CUSTOM_PAGE'
}
],
lodging: [
{
cityCode: 'SIN',
name: 'Intercontinental',
startDate: '2021-03-13',
endDate: '2021-03-20',
roomCount: 2,
tripLength: 7,
starRating: 5
}
],
carRentals: [
{
provider: Hertz,
brand: BMW,
model: 530i
}
],
moduleId: '',
tagName: '',
}Hospitality
const eventObject = {
event: 'viewable_impression',
module: 'em-booking-popup-abstract',
eventAction: 'viewable_impression',
actionLabel: '',
tenantCode: 'UL',
tenantType: '',
regionName: 'North America',
countryCode: 'US',
cityName: 'Miami',
propertyCode: 105565,
propertyName: 'N/a',
currencyCode: 'USD',
totalPrice: 900.55,
totalPriceUSD: 900.55,
startDate: '2022-04-01',
endDate: '2022-04-07',
daysUntilBooking: 25,
tripLength: 4,
roomAccesibility: true,
timestamp: '2021-02-16T17:41:43.200Z',
url: 'https: //www.hyatt.com/en/miami',
guest: [
{
count: 1,
adult: 1
}
],
room: [
{
count: 1,
type: ''
}
],
page: [
{
siteEdition: 'en-LK',
countryIsoCode: 'LK',
languageIsoCode: 'en',
pageTypeName: 'CUSTOM_PAGE'
}
]
}Events
const eventObject = {
'event': 'search_initiation',
'module': 'em-booking-popup-abstract',
'eventAction': 'search_initiation',
'actionLabel': null,
'tenantCode': 'ETA',
'eventName': 'Semifinal',
'eventLocation': 'Laver Arena',
'eventSession': 'Night',
'eventExperienceCategory': 'Ticket Only',
'eventExperience': 'The Lounge',
'eventNameFilter': 'Semifinal',
'eventLocationFilter': 'Laver Arena',
'eventSessionFilter': 'Night',
'eventExperienceCategoryFilter': 'Ticket Only',
'eventExperienceFilter': 'MULTIPLE',
'currencyCode': 'LKR',
'totalPrice': null,
'totalPriceUSD': null,
'startDate': '2021-03-13',
'endDate': '2021-03-14',
'timestamp': '2021-02-16T17:41:43.200Z',
'url': 'https: //www.srilankan.com/en-lk/',
'passenger': [{
'count': 1,
'adultCount': 1,
'youngAdultCount': null,
'childCount': null
}],
'page': [{
'siteEdition': 'en-LK',
'countryIsoCode': 'LK',
'languageIsoCode': 'en',
'pageTypeName': 'CUSTOM_PAGE'
}],
}[!NOTE] Tracking Implementation Options:
Understand that legacy modules may employ the Tracking Library (TL), Tracking Package (TP), or both in their implementation. The focus should be on having an "airmodule" data layer for each user interaction, ensuring events are collected in Google Analytics 4 (GA4).
To ensure the proper integration with the Tracking Package, follow these steps to effectively test the event object:
- Check the Event Object
Inspect the event object by typing tp_debug=true in the browser console. This will allow you to view the event object and identify any issues. This feature is available for implementations of the tracking package version 1.4.3 and above. You can check the Tracking Package version by typing tp_v in the console.
Additional note on verifying search_initiation events:
In addition to the steps above, before performing the search, run this in the console to avoid redirection to the search results page:
window.onbeforeunload = function (e) { e = e || window.event; return ''; }
That will prompt a popup to appear asking if you want to change pages. Just click "Cancel" and you should be able to see the details.
- Inspect the Data Layer
Interact with the modules as users would and observe the corresponding data layer events in the console. To inspect the formatted result, open your browser's console and type "dataLayer." This action will reveal the structured data layer, allowing you to review and confirm that the necessary events are captured in the "airmodule" data layer format.
- Validate GA4 Integration
Verify the successful collection and transmission of events to Google Analytics 4 (GA4) by entering collect in the Network tab. Confirm that the required data is being sent to GA4.
What is the difference between the event tracking object and the dataLayer object? Why do developers not implement the dataLayer object directly?
The event object and the dataLayer object serve distinct roles in the tracking process to standardize information across applications and prevent data loss.
Event Object: The event object is essentially the raw, unformatted input that developers implement for each specific event they want to track in an application. It serves as the initial stage of data collection, capturing essential information about user interactions or system events. Developers use the event object to provide detailed context and data related to specific actions within the application.
dataLayer Object: On the other hand, the dataLayer object is the formatted output that results from compiling and processing the raw event objects. This formatting adheres to predefined standards, such as the emDataStandards. The dataLayer object consolidates information from various tracking objects into a standardized format, ensuring consistency across all applications.
Why Not Implement the dataLayer Object Directly? Developers do not implement the dataLayer object directly because the separation of the event tracking and dataLayer stages offers several advantages. It allows for flexibility in tracking diverse events without imposing a rigid structure on developers during the initial data collection phase. The raw, unformatted nature of the event object accommodates the unique requirements of different events and interactions.
By processing the tracking objects into the dataLayer format, we can standardize the information before it is transmitted to analytics tools such as Google Analytics 4 (GA4). This ensures a uniform and organized dataset, facilitating more accurate analysis and reporting. The dataLayer object, therefore, acts as a streamlined and consistent data feed for analytics platforms.
In summary, the distinction between the event object and the dataLayer object is crucial for maintaining flexibility during data collection and standardizing the information for effective analysis, all while preventing data inconsistencies and losses across applications.
What is the difference between the Tracking Library and Tracking Package?
The tracking library is the traditional way of tracking events. It is loaded via an entrypoint script that is placed on the target page. It relies on PubSub events that it subscribes to in order to receive events, format them, and then send them to DataCore and push to the dataLayer for GA4. In order to run, the tracking library relies on several external resources which may slow down page performance.The tracking package is the newest way of tracking events. It is an npm package that is included in every module that we want to track. The modules call a function from within the package and the package will in turn format the event and push it to the dataLayer for GA4. It is significantly smaller and faster which improves performance over the tracking library.