xF2 Add-on [DigitalPoint] Better Google Analytics 1.1.1

• Fixed issue when tracking emails being opened and the encrypted payload is invalid
• Changed user property for tracking user ID from uid to usid

!!Important!!

It seems Google Analytics doesn't allow creation of the user property uid any longer so user ID tracked has been changed to usid. For new installations, nothing needs to change, but for existing installations, you'll want to go into your Google Analytics admin area to: Admin -> Data display -> Custom dimensions, and rename the existing User ID dimension to something else (for example User ID OLD)

Should look something like this:

Edit the User ID dimension:

Once you have done that, go to XenForo admin -> Options -> Analytics and click the "Set" button. If you reselect your property and data stream, it will create the new user ID dimension, usid automatically.

Once that is all done, your custom dimensions in Google Analytics will look something like this:

You can archive the User ID OLD dimension if you want since it's not going to be used going forward.

XenForo 2.3 updates:

• Updated overlay page tracking to work with lazy loaded core XenForo JavaScript
• Fixed compatibility issue with email tracking in XenForo 2.3 (different getTo() method)
• Changed verbiage from "conversation" to "direct message" on settings when using XenForo 2.3

Other:

• Don't try to generate an encryption key during setup if Sodium extension isn't installed
• Ignore invalid payload for email tracking (if payload can't be decrypted for whatever reason)

• Made change to Mailer class to have better compatibility with XenForo 2.3 w/ PHP 8.3

Click to expand...

• All JavaScript has been rewritten to be "native" (does not use jQuery) in preparation for removal of jQuery in XenForo 2.3.
• Fixed issue with app_install_prompt PWA event being triggered
• Added ecommerce support for DigitalPoint/Marketplace addon. Events:
  • view_item_list
  • view_item
  • add_to_cart
  • view_cart
  • begin_checkout
  • purchase

Fixes issue where some PWA tracking events would fire on all page views.

Click to expand...

• Require XF 2.2 or higher (incompatible Mailer class between XF 2.1 and 2.2)
• Use <xf:fa /> for the staffBar now that XF requirement is 2.2+ (better compatibility with Font Awesome Manager)

If you aren't using Font Awesome Manager, nothing really changes with this update (if you were using XF 2.0 or 2.1, you would have gotten errors before, now it simply doesn't let you install unless you have XF 2.2).

Google Analytics changed what dimensions are compatible and no longer allow full page URL to be used in conjunction with most other dimensions/metrics. Because of that, we are switching to something that works reasonably well as far as compatibility in reporting (page path).

• Some template modification changes to work better with third-party styles
• Removed ability for purchase revenue chart to be broken down by item name (no longer allowed with Google Analytics API)

• Fixed issue with compatibility with old versions of PHP.
• Requires PHP 7.0 or higher (just getting too annoying/difficult to maintain backward compatibility with very old versions of PHP on old versions of XenForo).
• Exception reporting works again by changing pageLocation dimension to pagePath (Google seems to not allow reporting on URLs with full query string any longer... maybe a privacy thing?)

This version has nothing added other than support for XenForo's new cookie consent system. If you are using a version of XenForo prior 2.2.12, it has no effect. There's also no effect if you aren't using the new cookie consent system.

The only situation where this update would be needed is if you are using XenForo 2.2.12+ and you are using the new Advanced (Beta) cookie consent option.