GTM Data Layer

The tables below list all of the events and attributes made available via the window.datalayer variable for deploying custom analytics and marketing tags with Google Tag Manager.

The standard events and attributes match Google Analytics default syntax and are commonly tracked in most marketing and analytics platforms.

The custom lodging events and attributes provide additional information that is unique to the Ripe website. All of the custom items include the 'lodging' prefix to avoid possible naming conflicts with other items defined on 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_page_viewNew page view; use this custom event to ensure all page parameters are defined
lodging_data_loadTriggered when property attributes are fully loaded
lodging_on_page_10sUser on page for 10 seconds
lodging_searchView search page results with check-in/out dates selected
lodging_outbound_linkClick link to external domain (does not include property referrals)
lodging_filter_resultsFilter, search, or sort results on search page
lodging_property_referralProperty referral link ('Visit Website' or 'Book Now')
lodging_view_photoRotate property photo carousel
lodging_more_search_resultsScroll to end of search results triggering more properties to load (to be released)
lodging_favorite_propertyClick the favorite icon on a property card or property page (to be released)
lodging_share_propertyClick the share icon on a property page (to be released)

Attributes

Standard Attributes

Note: all ecommerce events include an attribute source = 'ripe' to easily distinguish the event from ecommerce events located on other websites (if applicable).

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

GroupNameDescription
Eventlodging.event.categoryTop level event grouping
lodging.event.actionMid level event grouping
lodging.event.labelLow level event grouping
Affiliatelodging.affiliate.codeAffiliate code (incoming referral source)
Dateslodging.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)
Destinationlodging.destination.nameDestination name (city, event, or area)
lodging.destination.regionDestination region (state or geographic area)
lodging.destination.countryDestination country code
Filterlodging.filter.typeProperty list filter category
lodging.filter.selectionProperty list filter selection
Linklodging.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
Occupancylodging.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
Pagelodging.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
Promolodging.promo.codePromotion code
lodging.promo.sourcePromotion selection source (modal, widget, URL)
Propertylodging.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.countryProperty location country
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_metric(average daily rate) x (length of stay)
Searchlodging.search.daily_rate_metricAverage daily lead rate (as number)
lodging.search.daily_rate_dimensionAverage daily lead rate rounded to nearest 10 dollars (as text string)
lodging.search.stay_rate_metric(average lead rate) x (length of stay)
lodging.search.result_count_metricNumber of search results (as number)
lodging.search.result_count_dimensionNumber of search results (as text string)
Sitelodging.site.localeSite language and country
lodging.site.languageSite language code
lodging.site.countrySite country code
Traffic Sourcelodging.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
Userlodging.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