GTM Data Layer

The tables below list all of the events ('triggers') and attributes ('variables') that can be leveraged by clients when deploying analytics and marketing tags via Google Tag Manager.

The 'standard' events and attributes match Google Analytics syntax and are tracked in most analytics platforms. The "custom lodging" events and attributes provide additional information that is unique to the Ripe site. The 'lodging' prefix is used for custom items to avoid any potential naming conflicts with the data layer on the client's parent website.


Events


Standard Events

NameDescription
view_item_listView search results
view_itemView property page
add_to_cartSelect room ('book now')
begin_checkoutBegin reservation booking form
purchaseComplete reservation (confirmation page)

Custom Lodging Events

NameDescription
lodging_data_loadDynamic property information loaded (availability and rates)
lodging_filter_resultsSelect filter on property search page
lodging_map_interactionClick, zoom, or drag map
lodging_outbound_linkClick link to external domain (does not include property referrals)
lodging_page_viewPage view (ensures page type and other page parameters are defined)
lodging_select_promoPromo selected (pre-selected or via modal selection)
lodging_view_promoPromo modal displayed
lodging_referral_linkProperty referral link ('Visit Website' or 'Book Now')
lodging_browseViewed property browse page (no check-in/out dates selected)
lodging_searchViewed search pages
lodging_timer60 seconds on page
lodging_errorPage load or form field error

Attributes


Standard Attributes

NameDescription
eventEvent name
ecommerce.item_list_idProperty list type (browser or search)
ecommerce.item_list_nameProperty list type (browser or search)
ecommerce.transaction_idReservation confirmation number
ecommerce.affiliationPage domain
ecommerce.valueReservation subtotal (excludes tax and fees)
ecommerce.subtotalReservation subtotal (excludes tax and fees)
ecommerce.totalReservation total (includes tax and fees)
ecommerce.taxReservation tax and fees amount
ecommerce.currencyTransaction currency
ecommerce.couponPromo code
ecommerce.items.item_idProperty ID
ecommerce.items.item_nameProperty name (lowercase)
ecommerce.items.item_variantRoom description (lowercase)
ecommerce.items.item_variant_idRoom ID
ecommerce.items.item_variant_nameRoom description (lowercase)
ecommerce.items.priceAverage daily rate
ecommerce.items.quantityNumber of nights

Custom Lodging Attributes

NameDescription
lodging.affiliate.codeAffiliate code (incoming referral source)
lodging.dates.check_inCheck in date
lodging.dates.check_outCheck out date
lodging.dates.check_in_outCheck in and out dates (comma separated)
lodging.dates.length_of_stay_metricTotal nights (as number)
lodging.dates.length_of_stay_dimensionTotal nights (as text string)
lodging.dates.booking_window_metricDays until check in (as number)
lodging.dates.booking_window_dimensionDays until check in (as text string)
lodging.destination.nameDestination name (city, event, or area)
lodging.destination.regionDestination region (state or geographic area)
lodging.destination.countryDestination country code
lodging.discount.codePromo code
lodging.event.categoryTop level event grouping
lodging.event.actionMid level event grouping
lodging.event.labelLow level event grouping
lodging.filter.typeProperty list filter category
lodging.filter.selectionProperty list filter selection
lodging.link.idHTML element ID for link
lodging.link.nameLink description; link text or similar value
lodging.link.typeType of link (XX, XX)
lodging.link.urlLink URL
lodging.link.domainLink domain
lodging.link.pathLink path
lodging.occupancy.adultsNumber of adults
lodging.occupancy.childrenNumber of children
lodging.occupancy.roomsNumber of rooms
lodging.occupancy.total_occupantsTotal number of occupants (adults + children)
lodging.occupancy.stringOccupancy details as single text string
lodging.page.namePath page excluding unique ID values (consolidates path values)
lodging.page.typePage category (search page, property page, cart page, etc.)
lodging.page.platformBackend platform
lodging.promo.codePromotion code
lodging.promo.sourcePromotion selection source (modal, widget, URL)
lodging.property.idProperty ID
lodging.property.nameProperty name
lodging.property.room_idRoom ID
lodging.property.room_nameRoom description
lodging.property.cityProperty location city
lodging.property.postal_codeProperty location postal code
lodging.property.daily_rate_metricAverage daily rate (as number)
lodging.property.daily_rate_dimensionAverage daily rate rounded to nearest 10 dollars (as text string)
lodging.property.stay_rate_metricAverage daily rate x number of nights
lodging.search.results_metricNumber of search results (as number)
lodging.search.results_dimensionNumber of search results (as text string)
lodging.site.localeSite language and country
lodging.site.languageSite language code
lodging.site.countrySite country code
lodging.traffic_source.typeReferral source category
lodging.traffic_source.nameValue set using lodging_source query string parameter
lodging.traffic_source.domainReferral source page domain
lodging.traffic_source.pathReferral source page path
lodging.user.traffic_typeInternal traffic identifier (value undefined for live user traffic)
lodging.user.ga_client_idGoogle Analytics client ID
lodging.user.ga_session_idGoogle Analytics session ID
lodging.user.emailEmail address
lodging.user.email_hashSHA256 hash of email address
lodging.user.phonePhone number
lodging.user.phone_hashSHA256 hash of phone number
lodging.user.first_nameFirst name
lodging.user.first_name_hashSHA256 hash of first name
lodging.user.last_nameLast name
lodging.user.last_name_hashSHA256 hash of last name