Skip to content

Commit

Permalink
Document events
Browse files Browse the repository at this point in the history
  • Loading branch information
jissereitsma committed Aug 30, 2024
1 parent b4289ce commit 384841d
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 384841d

Please sign in to comment.