From 384841ddf487640f3d20758b1379aecf2a9fce63 Mon Sep 17 00:00:00 2001 From: Jisse Reitsma Date: Fri, 30 Aug 2024 09:21:02 +0200 Subject: [PATCH] Document events --- USAGE.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/USAGE.md b/USAGE.md index b0ed55ac..53c02a32 100644 --- a/USAGE.md +++ b/USAGE.md @@ -15,10 +15,35 @@ The extension has the following configuration options: - **Category EAV Attributes**: Category attributes to include when listing categories in a specific event. - **Customer EAV Attributes**: Customer attributes to include when listing customers in a specific event. Currently this is not implemented fully because of privacy regulations. +# Implemented events +The following events are implemented in the current version: + +- `add_payment_info` +- `add_shipping_info` +- `add_to_cart` +- `add_to_wishlist` +- `begin_checkout` +- `login` +- `logout` +- `purchase` +- `remove_from_cart` +- `sign_up` +- `view_cart` +- `view_item_list_event` +- `view_item_event` +- `view_search_result` + +If you think an event is missing, post a GitHub Issue to kickstart such an initiative. + +The following events are not implemented because a lack of inspiration: +- `view_promotion` +- `select_promotion` + +The following events should actually be implemented via a server-side implementation: +- `refund` + # Tip: Browser extension -Use the [DataLayer -Checker](https://chrome.google.com/webstore/detail/datalayer-checker/ffljdddodmkedhkcjhpmdajhjdbkogke) for Chrome to -easily see what kind of data is sent from Magento to Google Tag Manager. +Use the [DataLayer Checker](https://chrome.google.com/webstore/detail/datalayer-checker/ffljdddodmkedhkcjhpmdajhjdbkogke) for Chrome to easily see what kind of data is sent from Magento to Google Tag Manager. # Tip: CheckoutTester2 When you want to track conversions in your Magento checkout, our extension helps out as well: It adds the relevant information to all your checkout and cart pages. Do you want to know which variables are on the success page? Use the [Yireo CheckoutTester](https://github.com/yireo/Yireo_CheckoutTester2) extension to preview that page and view its HTML source.