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
Name | Description |
---|---|
view_item_list | View search results |
view_item | View property page |
add_to_cart | Select room ('book now') |
begin_checkout | Begin reservation booking form |
purchase | Complete reservation (confirmation page) |
Custom Lodging Events
Name | Description |
---|---|
lodging_page_view | New page view; use this custom event to ensure all page parameters are defined |
lodging_data_load | Triggered when property attributes are fully loaded |
lodging_on_page_10s | User on page for 10 seconds |
lodging_search | View search page results with check-in/out dates selected |
lodging_outbound_link | Click link to external domain (does not include property referrals) |
lodging_filter_results | Filter, search, or sort results on search page |
lodging_property_referral | Property referral link ('Visit Website' or 'Book Now') |
lodging_view_photo | Rotate property photo carousel |
lodging_more_search_results | Scroll to end of search results triggering more properties to load (to be released) |
lodging_favorite_property | Click the favorite icon on a property card or property page (to be released) |
lodging_share_property | Click 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).
Name | Description |
---|---|
event | Event name |
ecommerce.item_list_id | Property list type (browser or search) |
ecommerce.item_list_name | Property list type (browser or search) |
ecommerce.transaction_id | Reservation confirmation number |
ecommerce.affiliation | Page domain |
ecommerce.value | Reservation subtotal (excludes tax and fees) |
ecommerce.subtotal | Reservation subtotal (excludes tax and fees) |
ecommerce.total | Reservation total (includes tax and fees) |
ecommerce.tax | Reservation tax and fees amount |
ecommerce.currency | Transaction currency |
ecommerce.coupon | Promo code |
ecommerce.items.item_id | Property ID |
ecommerce.items.item_name | Property name (lowercase) |
ecommerce.items.item_variant | Room description (lowercase) |
ecommerce.items.item_variant_id | Room ID |
ecommerce.items.item_variant_name | Room description (lowercase) |
ecommerce.items.price | Average daily rate |
ecommerce.items.quantity | Number of nights |
Custom Lodging Attributes
Group | Name | Description |
---|---|---|
Event | lodging.event.category | Top level event grouping |
lodging.event.action | Mid level event grouping | |
lodging.event.label | Low level event grouping | |
Affiliate | lodging.affiliate.code | Affiliate code (incoming referral source) |
Dates | lodging.dates.check_in | Check in date |
lodging.dates.check_out | Check out date | |
lodging.dates.check_in_out | Check in and out dates (comma separated) | |
lodging.dates.length_of_stay_metric | Total nights (as number) | |
lodging.dates.length_of_stay_dimension | Total nights (as text string) | |
lodging.dates.booking_window_metric | Days until check in (as number) | |
lodging.dates.booking_window_dimension | Days until check in (as text string) | |
Destination | lodging.destination.name | Destination name (city, event, or area) |
lodging.destination.region | Destination region (state or geographic area) | |
lodging.destination.country | Destination country code | |
Filter | lodging.filter.type | Property list filter category |
lodging.filter.selection | Property list filter selection | |
Link | lodging.link.id | HTML element ID for link |
lodging.link.name | Link description; link text or similar value | |
lodging.link.type | Type of link (XX, XX) | |
lodging.link.url | Link URL | |
lodging.link.domain | Link domain | |
lodging.link.path | Link path | |
Occupancy | lodging.occupancy.adults | Number of adults |
lodging.occupancy.children | Number of children | |
lodging.occupancy.rooms | Number of rooms | |
lodging.occupancy.total_occupants | Total number of occupants (adults + children) | |
lodging.occupancy.string | Occupancy details as single text string | |
Page | lodging.page.name | Path page excluding unique ID values (consolidates path values) |
lodging.page.type | Page category (search page, property page, cart page, etc.) | |
lodging.page.platform | Backend platform | |
Promo | lodging.promo.code | Promotion code |
lodging.promo.source | Promotion selection source (modal, widget, URL) | |
Property | lodging.property.id | Property ID |
lodging.property.name | Property name | |
lodging.property.room_id | Room ID | |
lodging.property.room_name | Room description | |
lodging.property.city | Property location city | |
lodging.property.postal_code | Property location postal code | |
lodging.property.country | Property location country | |
lodging.property.daily_rate_metric | Average daily rate (as number) | |
lodging.property.daily_rate_dimension | Average daily rate rounded to nearest 10 dollars (as text string) | |
lodging.property.stay_rate_metric | (average daily rate) x (length of stay) | |
Search | lodging.search.daily_rate_metric | Average daily lead rate (as number) |
lodging.search.daily_rate_dimension | Average 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_metric | Number of search results (as number) | |
lodging.search.result_count_dimension | Number of search results (as text string) | |
Site | lodging.site.locale | Site language and country |
lodging.site.language | Site language code | |
lodging.site.country | Site country code | |
Traffic Source | lodging.traffic_source.type | Referral source category |
lodging.traffic_source.name | Value set using lodging_source query string parameter | |
lodging.traffic_source.domain | Referral source page domain | |
lodging.traffic_source.path | Referral source page path | |
User | lodging.user.traffic_type | Internal traffic identifier (value undefined for live user traffic) |
lodging.user.ga_client_id | Google Analytics client ID | |
lodging.user.ga_session_id | Google Analytics session ID | |
lodging.user.email | Email address | |
lodging.user.email_hash | SHA256 hash of email address | |
lodging.user.phone | Phone number | |
lodging.user.phone_hash | SHA256 hash of phone number | |
lodging.user.first_name | First name | |
lodging.user.first_name_hash | SHA256 hash of first name | |
lodging.user.last_name | Last name | |
lodging.user.last_name_hash | SHA256 hash of last name |
Updated 14 days ago