All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Documentation typos
- Fix
item_category
hierarchy on eventpurchase
- Fix attributes received from
eventData
on eventvtex:addToWishlist
extractingitems.product
ans usingsku
insteadselectedSku
- Fix
eventData
for therefund
to receive a formatted order object instead
- A new app configuration option on Admin, "Send Google Analytics 4 Events", that clients can opt-in to also send the events in the GA4 format.
- Support for sending GA4
view_item
(UAdetail
) whenvtex:productView
is received. - Support for sending GA4
view_item_list
(UAimpressions
) whenvtex:productImpression
is received. - Support for sending GA4
select_item
(UAclick
) whenvtex:productClick
is received. - Support for sending GA4
purchase
(UApurchase
) whenvtex:orderPlaced
is received. - Support for sending GA4
add_to_cart
(UAadd
) whenvtex:addToCart
is received. - Support for sending GA4
remove_from_cart
(UAremove
) whenvtex:removeFromCart
is received. - Support for sending GA4
view_promotion
(UApromoView
) whenvtex:promoView
is received. - Support for sending GA4
select_promotion
(UApromoClick
) whenvtex:promotionClick
is received. - Support for sending GA4
add_payment_info
whenvtex:addPaymentInfo
is received (not being sent yet). - Support for sending GA4
begin_checkout
whenvtex:beginCheckout
is received (not being sent yet). - Support for sending GA4
view_cart
whenvtex:beginCheckout
is received (not being sent yet). - Support for sending GA4
add_shipping_info
whenvtex:addShippingInfo
is received (not being sent yet). - Support for sending GA4
search
whenvtex:search
is received (not being sent yet). - Support for sending GA4
login
whenvtex:login
is received (not being sent yet). - Support for sending GA4
refund
whenvtex:refund
is received (not being sent yet). - Support for sending GA4
add_to_wishlist
whenvtex:addToWishlist
is received (not being sent yet). - Support for sending GA4
sign_up
whenvtex:signUp
is received (not being sent yet). - Support for sending GA4
share
whenvtex:share
is received (not being sent yet).
- Updates lodash version
- Updates dependencies with security issues
- Fix
ecommerce
variable firing, pass null toecommerce
before pass values again, like google recommend.
- Added a custom field to "userData" dataLayer
- Added
ecommerceV2
property sent on the orderPlaced event to match the checkout dataLayer
-dimension4
property to the product data layer on productView
events, representing the availability of the product
- Product names on orderPlaced events now no longer include SKU name at the end
- First event push is now detected correctly, considering that there may be GTM native events on the
dataLayer
array before the first push happens - Current campaign is no longer invalidated when the browser referrer matches the storage referrer
originalReferrer
to the docs
originalReferrer
variable to events
- Added mechanism to avoid losing campaign attributon.
originalLocation
variable is now dynamic and consider Google's session expiration rules.
- The variable name
OriginalLocation
tooriginalLocation
.
- Step on how to add the variable OriginalLocation to your Google Tag Manager (GTM) container and configure your store’s Google Analytics tags, to persist campaign data throughout a user session and avoid providing inconsistent campaign data to Google Analytics.
- Add originalLocation variable to dataLayer
- All events are now using the productId as the main product identifier
- Product name doesn't include the variation anymore
variant
property now contains the SKU Id
- SKU id field to all events that contains product ids
list
property toproductView
(productDetail
) eventposition
property toproductClick
eventdimension1
property pointing to Product Reference Iddimension2
property pointing to SKU Reference Iddimension3
property pointing to SKU Name (previous variant)
productClick
andproductDetail
now considers the selected item when getting the product priceproductClick
now considers the default seller when getting the item's price
- Old backwards compatible
pageLoaded
andproductImpression
events
- Use sellerDefault to select the default seller.
- Property
price
being sent asinteger
inaddToCart
event when using the blockadd-to-cart-button
.
- Legacy events to dataLayer:
homeView
categoryView
departmentView
internalSiteSearchView
productView
otherView
- Docs regarding Custom HTML tags.
allowCustomHtmlTags
option onsettingsSchema
.
- Public metadata information following App Store standards
- Billing Options structure following App Store standards
list
property toproductClick
.
- Events
promoView
andpromotionClick
.
- Replace handler of
vtex:cart
event tovtex:cartLoaded
.
- Updated README.md file
- Enable configuration by binding.
- Event
userData
.
- Events typings.
- Get blacklist values from server.
- Change
productDetail
event to sendid
andvariant
of the visible SKU - Change
productClick
event to sendid
of the visible SKU - Change
productImpression
event to sendid
of the visible SKU
category
field inorderPlaced
,productClick
,productImpression
,addToCart, and
removeFromCart`.
### Added
- Event
productClick
.
- Build assets with new builder hub.
- Use ES5.
- Avoid using global scope.
- Ported to pixel builder 0
- Typo in
orderPlaced
Enhanced Ecommerce property.
- Event
productImpression
.
- Add Enhanced Ecommerce data to
orderPlaced
event.
- Event
pageView
. - Property
event: 'productDetail'
to product view event.
- Use the right price property.
- Event
removeFromCart
. - Event
orderPlaced
.
- Add
pixel
policy.
- Migrate the app to typescript.
- Update to use new pixel API.
- Add billingOptions on manifest.json.
- Add full description to publish in Apps Store.
- Change the Readme to reflect the Setup of the service.
- MVP of
Google Tag Manager
.