Google Analytics: Add support for universal analytics for eCommerce #8182

allendav · 2017-11-16T00:43:53Z

Ready to test.

Background:

The Jetpack Google Analytics module currently only supports "legacy" (ga.js) analytics
This PR refactors the module in Jetpack to add support for "universal" (analytics.js) analytics and the ecommerce plugin while maintaining support for legacy analytics.
Which is used is driven by a new field in the jetpack_wga option: enh_ec_tracking
Both "modes" support IP anonymization, tracking new orders and tracking when products are added to the cart (on single or loop pages)
A follow-on PR will expand on this PR further by adding support for these additional enhanced analytics behaviors:

enh_ec_track_remove_from_cart
enh_ec_track_prod_impression
enh_ec_track_prod_click
enh_ec_track_prod_detail_view
enh_ec_track_checkout_started

Changes proposed in this Pull Request:

Note: The original wp-google-analytics.php file was copied to modules/google-analytics/classes/wp-google-analytics-legacy.php with minor editing.
Note: The original wp-google-analytics.php file was then modified to either load that legacy implementation or the new universal analytics implementation.
Note: A classes/wp-google-analytics-options.php file was also added to provide a consistent interface to options for both implementations, including the following new enh_ec_tracking (on/off) flag

Testing instructions:

Sign up for a Google Analytics tracking code for your test site
Install, activate and connect Jetpack and get a Jetpack Professional Plan
Install and activate WooCommerce
Create a product with no SKU and at least two categories
Create another product with a SKU and at least two categories
Replace modules/google-analytics with the files from this branch
Install and activate the Jetpack Google Analytics Helper plugin ( https://github.com/Automattic/jetpack-google-analytics-helper )
Use the helper plugin (wp-admin > Tools > Jetpack Google Analytics Helper) to set the following:

Google Analytics Tracking / Property ID: (empty)
Anonymize IP Addresses: unchecked
Track Purchase Transactions: unchecked
Track Add to Cart Events: unchecked
Enable Enhanced eCommerce: unchecked

Visit either product page.
View the source and 1) ensure the Google Analytics script (ga.js) is never referenced and 2) no jQuery is present to hook .single_add_to_cart_button or .add_to_cart_button
Elements.
Note: You should see this in the page source (for legacy/classic analytics only):
Use the helper plugin (wp-admin > Tools > Jetpack Google Analytics Helper) to set the following:

Google Analytics Tracking / Property ID: UA-12345678-1
Anonymize IP Addresses: unchecked
Track Purchase Transactions: unchecked
Track Add to Cart Events: unchecked
Enable Enhanced eCommerce: unchecked

Visit either product page.
View the source and 1) ensure the Google Analytics script (ga.js) is present, 2) that the Tracking ID is present, but 3) that no jQuery is present to hook .single_add_to_cart_button or .add_to_cart_button elements.
Use the helper plugin (wp-admin > Tools > Jetpack Google Analytics Helper) to set the following:

Google Analytics Tracking / Property ID: UA-12345678-1
Anonymize IP Addresses: CHECKED
Track Purchase Transactions: unchecked
Track Add to Cart Events: unchecked
Enable Enhanced eCommerce: unchecked

Visit either product page.
View the source and 1) ensure the Google Analytics script (ga.js) is present and that the _anonymizeIp element is present, e.g. for legacy/classic:

_gaq.push(['_gat._anonymizeIp']);

For universal:

ga( 'set', 'anonymizeIp', true );

Use the helper plugin (wp-admin > Tools > Jetpack Google Analytics Helper) to set the following:

Google Analytics Tracking / Property ID: UA-12345678-1
Anonymize IP Addresses: unchecked
Track Purchase Transactions: CHECKED
Track Add to Cart Events: unchecked
Enable Enhanced eCommerce: unchecked

In your Google Analytics Dashboard ( https://analytics.google.com/ ), go to Admin for your site (it looks like a gear in the lower left corner)
Under View select Ecommerce Settings
Enable Ecommerce if you haven't already. DO NOT ENABLE ENHANCED ECOMMERCE AT THIS TIME.

Back on your test site, Complete the purchase of one of each product using a gateway like Check Payment.
Return to your Google Analytics Dashboard and go to Conversions and then Ecommerce
Set the date range to today
Make sure you see the sale and that the details are correct (note: it can take a few minutes for the transaction to appear in GA)
Use the helper plugin (wp-admin > Tools > Jetpack Google Analytics Helper) to set the following:

Google Analytics Tracking / Property ID: UA-12345678-1
Anonymize IP Addresses: unchecked
Track Purchase Transactions: CHECKED
Track Add to Cart Events: CHECKED
Enable Enhanced eCommerce: unchecked

On the product listing page, choose Add to Cart for one of your products
Then, visit the other product’s product page and add that product to your cart there.
In your Google Analytics Dashboard, go to Real-time and then Events
Make sure you see the addition of the SKU less and the SKU product and that the details are correct (Note: for legacy/classic ecommerce the event appears as Product: Add to Cart. For enhanced ecommerce the event is stored as UX/click/Add to Cart)

In your Google Analytics Dashboard, go to Admin for your site
Under View select Ecommerce Settings
Enable ENHANCED Ecommerce
Now, repeat all the tests above but with Enable Enhanced eCommerce CHECKED

Proposed changelog entry for your changes:

Google Analytics: Add support for Universal Analytics / Enhanced eCommerce

@justinshreve - re #8182 (comment) what would you think about filtering in another data- attribute with the name so we could avoid the "(not set)" rows and keep all the events for a product in one row? it is different than how the existing GA extension works, but i think it would be an easy improvement

Requested changes have been provided. Testing again now

oskosk

Thanks for the detailed diagrams on how to see the events. I got to see everything as expected. LGTM!

oskosk · 2017-11-27T15:22:26Z

@allendav while having this branch checked out, I deactivated WooCommerce and got to see this in debug.log.

map_meta_cap was called <strong>incorrectly</strong>. The post type shop_order is not registered, so it may not be reliable to check the capability "edit_post" against a post of that type. Please see <a href="https://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information. (This message was added in version 4.4.0.)
 Type: PHP Notice Line: 4145
 File: /srv/users/userad06496f/apps/userad06496f/public/wp-includes/functions.php

Do you think it's something related to the PR or just the fact that I deactivated Woo after having created products ?

allendav · 2017-11-27T17:26:26Z

@oskosk wrote:

while having this branch checked out, I deactivated WooCommerce and got to see this in debug.log

...

Do you think it's something related to the PR or just the fact that I deactivated Woo after having created products ?

It's an old core Wordpress bug - woocommerce/woocommerce#10777 https://core.trac.wordpress.org/ticket/36208

justinshreve · 2017-11-27T17:29:05Z

@allendav

@justinshreve - re #8182 (comment) what would you think about filtering in another data- attribute with the name so we could avoid the "(not set)" rows and keep all the events for a product in one row? it is different than how the existing GA extension works, but i think it would be an easy improvement

That sounds good to me. That's definitely an improvement.

* Changelog 5.6: create base for changelog. * Update changelog with 5.5.1 info. * Changelog: add #7930 and #8238 * Changelog: add #8076 * Changelog: add #8100 * Changelog: add #8117 * Changelog: add #8141 * Changelog: add #8143 * Changelog: add #8147 * Changelog: add #8149 * Changelog: add #8153 * Changelog: add #8173 * Changelog: add #8184 * Changelog: add #8196 * Changelog: add #8199 * Changelog: add #8093 * Changelog: add #8171 * Changelog: add #8182 * Changelog: add #8202, #8222 * Changelog: add #8228 * Changelog: add #8240 * Changelog: add #8251 * remove AL card change

Add support for universal analytics

4929866

allendav added [Feature] Google Analytics [Status] In Progress labels Nov 16, 2017

allendav self-assigned this Nov 16, 2017

allendav requested a review from a team as a code owner November 16, 2017 00:43

jeherve added [Pri] High [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it labels Nov 16, 2017

allendav mentioned this pull request Nov 16, 2017

WPCOM API: Site Settings: Additional fields for Google Analytics D8279 #8198

Merged

Allen Snook added 2 commits November 17, 2017 11:18

Refactor into two concrete impls - one for legacy and one for universal

fd7aed1

Add header and footer script; support universal anonymiz and order tr…

e5de7be

…acking

allendav changed the title ~~Google Analytics: Add support for universal analytics~~ Google Analytics: Add support for universal analytics for eCommerce Nov 17, 2017

Allen Snook added 3 commits November 17, 2017 15:26

Remove some of the enh options for now - to be delivered in next PR

de99809

Fix authorship

103c7b3

Track add to cart for enh ecommerce analytics. Remove other events fo…

3e30623

…r next PR.

allendav requested review from zinigor, justinshreve and dereksmart November 18, 2017 00:40

jeherve added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Nov 20, 2017

allendav mentioned this pull request Nov 21, 2017

Google Analytics: Add remaining enhanced eCommerce trackers #8218

Merged

justinshreve approved these changes Nov 21, 2017

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Nov 21, 2017

oskosk reviewed Nov 23, 2017

View reviewed changes

oskosk added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Nov 23, 2017

oskosk previously requested changes Nov 23, 2017

View reviewed changes

Remove debug dump

dca8278

oskosk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Nov 27, 2017

oskosk approved these changes Nov 27, 2017

View reviewed changes

oskosk added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Nov 27, 2017

dereksmart merged commit 2bcd0a0 into master Nov 27, 2017

dereksmart removed the [Status] Ready to Merge Go ahead, you can push that green button! label Nov 27, 2017

oskosk added this to the 5.6 milestone Nov 27, 2017

jeherve deleted the add/8181-enhanced-google-analytics branch November 27, 2017 21:41

jeherve added [Status] Needs Changelog [Status] Needs Testing We need to add this change to the testing call for this month's release and removed [Status] Needs Changelog [Status] Needs Testing We need to add this change to the testing call for this month's release labels Nov 27, 2017

jeherve added a commit that referenced this pull request Nov 28, 2017

Changelog: add #8182

d1d043f

georgestephanis mentioned this pull request Mar 22, 2018

Google Analytics Tracking Code Placed Incorrectly #9129

Closed

-              			$track['code'] = 'search';
+              	private function __construct() {
+              		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
+              			error_log( print_r( Jetpack_Google_Analytics_Options::debug_dump(), true ) );

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Google Analytics: Add support for universal analytics for eCommerce #8182

Google Analytics: Add support for universal analytics for eCommerce #8182

allendav commented Nov 16, 2017 •

edited by oskosk

Loading

justinshreve commented Nov 20, 2017 •

edited

Loading

justinshreve commented Nov 20, 2017

allendav commented Nov 21, 2017

justinshreve left a comment

oskosk Nov 23, 2017

allendav Nov 25, 2017

allendav Nov 25, 2017

oskosk commented Nov 23, 2017

oskosk left a comment

allendav commented Nov 25, 2017

oskosk commented Nov 26, 2017

allendav commented Nov 26, 2017 •

edited

Loading

allendav commented Nov 26, 2017

allendav commented Nov 26, 2017

allendav commented Nov 26, 2017

oskosk left a comment

oskosk commented Nov 27, 2017

allendav commented Nov 27, 2017

justinshreve commented Nov 27, 2017

Google Analytics: Add support for universal analytics for eCommerce #8182

Google Analytics: Add support for universal analytics for eCommerce #8182

Conversation

allendav commented Nov 16, 2017 • edited by oskosk Loading

Background:

Changes proposed in this Pull Request:

Testing instructions:

Proposed changelog entry for your changes:

See also:

justinshreve commented Nov 20, 2017 • edited Loading

justinshreve commented Nov 20, 2017

allendav commented Nov 21, 2017

justinshreve left a comment

Choose a reason for hiding this comment

oskosk Nov 23, 2017

Choose a reason for hiding this comment

allendav Nov 25, 2017

Choose a reason for hiding this comment

allendav Nov 25, 2017

Choose a reason for hiding this comment

oskosk commented Nov 23, 2017

oskosk left a comment

Choose a reason for hiding this comment

allendav commented Nov 25, 2017

oskosk commented Nov 26, 2017

allendav commented Nov 26, 2017 • edited Loading

allendav commented Nov 26, 2017

allendav commented Nov 26, 2017

allendav commented Nov 26, 2017

oskosk left a comment

Choose a reason for hiding this comment

oskosk commented Nov 27, 2017

allendav commented Nov 27, 2017

justinshreve commented Nov 27, 2017

allendav commented Nov 16, 2017 •

edited by oskosk

Loading

justinshreve commented Nov 20, 2017 •

edited

Loading

allendav commented Nov 26, 2017 •

edited

Loading