feat(ga4): np_newsletter_subscribed event upon front-end signup #3938

dkoo · 2025-04-21T20:39:15Z

All Submissions:

Have you followed the Newspack Contributing guideline?
Does your code follow the WordPress' coding standards and VIP Go coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

#3895 migrated back-end GA4 events to the front-end, but didn't implement events to replace back-end np_newsletter_subscribed events. This PR does.

How to test the changes in this Pull Request:

Check out this branch and feat(ga4): dispatch newsletter_signup activity upon signup via block newspack-newsletters#1819.
As a new reader, sign up for newsletters using the following methods:

Registration block, signing up for newsletters
Auth modal, after registering (must enable post-checkout newsletter signup lists in Audience > Settings)
After completing modal checkout (must enable post-checkout newsletter signup lists in Audience > Settings)
My Account > Newsletters (check new lists and save)

In each case, confirm that an np_newsletter_subscribed event is dispatched to Google Analytics with the following params:

lists - array of list IDs the user subscribed to
newsletters_subscription_method - the method of signup (one of: newsletters-subscription-block, reader-registration, auth-modal, post-checkout, or my-account)
newspack_popup_id or gate_post_id, if applicable

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you successfully ran tests with your changes locally?

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1210051336945369

miguelpeixe

There are some schema inconsistencies across different event origins. When subscribing to newsletters via the reader registration block the lists are not part of the payload, just email and newsletters_subscription_method.

There's also a strange behavior when accessing the My Account after registering, I got a couple of dispatches with the following payload:

{
  "action": "newsletter_signup",
  "data": {
    "email": "[email protected]",
    "lists": [
      ""
    ],
    "newsletters_subscription_method": "my-account"
  },
  "timestamp": 1745412894141
}

This happened to an unverified account, at the My Account dashboard landing page.

miguelpeixe · 2025-04-22T21:33:48Z

includes/reader-revenue/my-account/index.js

+	// Fire a newsletter_signup event when the user subscribes to a newsletter via My Account.
+	window.newspackRAS = window.newspackRAS || [];
+	window.newspackRAS.push( readerActivation => {
+		const reader = readerActivation.getReader();
+		const params = new URLSearchParams( window.location.search );
+		const subscribed = ( params.get( 'newspack_newsletters_subscription_subscribed' ) || '' ).split( ',' );
+		if ( subscribed && reader?.email && reader?.authenticated ) {
+			readerActivation.dispatchActivity( 'newsletter_signup', {
+				email: reader.email,
+				lists: subscribed,
+				newsletters_subscription_method: 'my-account',
+			} );
+		}
+		params.delete( 'newspack_newsletters_subscription_subscribed' );
+		const newQueryString = params.toString() ? '?' + params.toString() : '';
+		window.history.replaceState( {}, '', window.location.pathname + newQueryString );


This will also fire an event with empty lists if I only remove subscriptions. I don't think we should fire for such cases.

Ah, the split( ',' ) was in the wrong place, resulting in that [ '' ] value when the param is empty or nonexistent. b9e5937 should fix it.

dkoo · 2025-04-23T16:26:40Z

@miguelpeixe thanks for catching those bugs!

There are some schema inconsistencies across different event origins. When subscribing to newsletters via the reader registration block the lists are not part of the payload, just email and newsletters_subscription_method.

This was happening because the success callback was removing the form element before we built the activity data. 🤦 23cce1e should fix this by removing the form after we dispatch the event.

There's also a strange behavior when accessing the My Account after registering, I got a couple of dispatches with the following payload:

Is this still happening for you after b9e5937? If so, we can tighten up the JS so that this particular push only happens if the newspack_newsletters_subscription_subscribed query param exists AND we're on the my-account/newsletters path, but in my testing this doesn't seem to be necessary.

miguelpeixe

Thanks for revising! The issues were fixed and all is working well.

github-actions · 2025-04-23T17:24:41Z

Hey @dkoo, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

# [6.5.0-alpha.1](v6.4.4...v6.5.0-alpha.1) (2025-04-23) ### Bug Fixes * add white background to Newspack admin screens ([#3909](#3909)) ([4c8409e](4c8409e)) * allow guest contributors to have empty archives ([#3902](#3902)) ([af8bed9](af8bed9)) * **analytics:** migrate back-end GA4 events to front-end ([#3895](#3895)) ([7e18628](7e18628)) * **auth-form:** check user before is_user_reader() call ([#3944](#3944)) ([1cbb760](1cbb760)) * avoid warning for network event ([#3942](#3942)) ([60d0aa3](60d0aa3)) * **bylines:** avoid rerendering of editable area ([#3896](#3896)) ([9fdf659](9fdf659)) * **bylines:** custom edited state for modal ([#3919](#3919)) ([2a1a800](2a1a800)) * **bylines:** get CAP data from the plugin's store ([#3906](#3906)) ([0745113](0745113)) * **corrections:** Limit CPT to posts only ([#3927](#3927)) ([1d49c39](1d49c39)) * **corrections:** Use Corrections Archive template by default ([#3929](#3929)) ([c4c1925](c4c1925)) * **email-change:** ensure success and error messages persist after redirect ([#3913](#3913)) ([caf82a5](caf82a5)) * **email-change:** improve messaging for in-progress or expired change requests ([#3886](#3886)) ([02d2ea0](02d2ea0)) * **email-change:** typo in variable name ([#3941](#3941)) ([941dc21](941dc21)) * **google-login:** handle google oauth disabled state in the editor ([#3946](#3946)) ([0f9f7c6](0f9f7c6)) * hide campaigns menu when the Newspack Campaigns plugin is not activated ([#3922](#3922)) ([adcc21f](adcc21f)) * make front end not dependent on coauthors plus ([#3905](#3905)) ([dc96e5b](dc96e5b)) * **otp-input:** enhance OTP input handling for clipboard ([#3898](#3898)) ([a56328b](a56328b)) * reinstate the Add New Newsletter link in the admin menu ([#3926](#3926)) ([1c8c7d7](1c8c7d7)) * remove extra space above empty help text ([#3904](#3904)) ([6a4fe4f](6a4fe4f)) * remove import and route for Suppression ([#3894](#3894)) ([a2034e7](a2034e7)) * **setup-wizard:** prevent Yoast redirect ([#3940](#3940)) ([3461b5f](3461b5f)) ### Features * **auth:** OTP autocomplete integration ([#3888](#3888)) ([5a1d7a8](5a1d7a8)) * **bylines:** get post byline authors ([#3911](#3911)) ([17942a2](17942a2)) * **bylines:** useAuthorTokens() hook with user entity validation ([#3907](#3907)) ([3d1feee](3d1feee)) * **email-change:** allow old email to cancel email change only, not confirm ([#3912](#3912)) ([92413e3](92413e3)) * **ga4:** np_newsletter_subscribed event upon front-end signup ([#3938](#3938)) ([2295277](2295277)) * **ras-newsletter:** Newsletters list progressive disclosure ([#3887](#3887)) ([53f4eed](53f4eed)) * **reader-auth:** send WP login reminder email to non-reader accounts ([#3796](#3796)) ([d1af25e](d1af25e)), closes [#3823](#3823) * **scss:** export colors as module for JS consumption ([#3910](#3910)) ([81da8f0](81da8f0)) * **segments:** add filter for device segment ([#3880](#3880)) ([d465726](d465726)) * update colors and add all design system variables ([#3882](#3882)) ([6ee8e30](6ee8e30))

matticbot · 2025-04-23T17:55:42Z

🎉 This PR is included in version 6.5.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [6.6.0-alpha.1](v6.5.0...v6.6.0-alpha.1) (2025-05-08) ### Bug Fixes * add white background to Newspack admin screens ([#3909](#3909)) ([4c8409e](4c8409e)) * allow guest contributors to have empty archives ([#3902](#3902)) ([af8bed9](af8bed9)) * **analytics:** migrate back-end GA4 events to front-end ([#3895](#3895)) ([7e18628](7e18628)) * **auth-form:** check user before is_user_reader() call ([#3944](#3944)) ([1cbb760](1cbb760)) * avoid warning for network event ([#3942](#3942)) ([60d0aa3](60d0aa3)) * **bylines:** avoid rerendering of editable area ([#3896](#3896)) ([9fdf659](9fdf659)) * **bylines:** custom edited state for modal ([#3919](#3919)) ([2a1a800](2a1a800)) * **bylines:** get CAP data from the plugin's store ([#3906](#3906)) ([0745113](0745113)) * **corrections:** Limit CPT to posts only ([#3927](#3927)) ([1d49c39](1d49c39)) * **corrections:** Use Corrections Archive template by default ([#3929](#3929)) ([c4c1925](c4c1925)) * **email-change:** ensure success and error messages persist after redirect ([#3913](#3913)) ([caf82a5](caf82a5)) * **email-change:** improve messaging for in-progress or expired change requests ([#3886](#3886)) ([02d2ea0](02d2ea0)) * **email-change:** typo in variable name ([#3941](#3941)) ([941dc21](941dc21)) * **ga4:** ensure gate_post_id and newspack_popup_id are passed to activities ([#3956](#3956)) ([fadaa4d](fadaa4d)) * **google-login:** handle google oauth disabled state in the editor ([#3946](#3946)) ([0f9f7c6](0f9f7c6)) * hide campaigns menu when the Newspack Campaigns plugin is not activated ([#3922](#3922)) ([adcc21f](adcc21f)) * make front end not dependent on coauthors plus ([#3905](#3905)) ([dc96e5b](dc96e5b)) * **newsletters-wizard:** remove advertisers menu item ([#3948](#3948)) ([2fddbd6](2fddbd6)) * **otp-input:** enhance OTP input handling for clipboard ([#3898](#3898)) ([a56328b](a56328b)) * reinstate the Add New Newsletter link in the admin menu ([#3926](#3926)) ([1c8c7d7](1c8c7d7)) * remove extra space above empty help text ([#3904](#3904)) ([6a4fe4f](6a4fe4f)) * remove import and route for Suppression ([#3894](#3894)) ([a2034e7](a2034e7)) * **setup-wizard:** prevent Yoast redirect ([#3940](#3940)) ([3461b5f](3461b5f)) ### Features * **auth:** OTP autocomplete integration ([#3888](#3888)) ([5a1d7a8](5a1d7a8)) * **bylines:** get post byline authors ([#3911](#3911)) ([17942a2](17942a2)) * **bylines:** useAuthorTokens() hook with user entity validation ([#3907](#3907)) ([3d1feee](3d1feee)) * **email-change:** allow old email to cancel email change only, not confirm ([#3912](#3912)) ([92413e3](92413e3)) * **ga4:** np_newsletter_subscribed event upon front-end signup ([#3938](#3938)) ([2295277](2295277)) * **ras-newsletter:** Newsletters list progressive disclosure ([#3887](#3887)) ([53f4eed](53f4eed)) * **reader-auth:** send WP login reminder email to non-reader accounts ([#3796](#3796)) ([d1af25e](d1af25e)), closes [#3823](#3823) * **scss:** export colors as module for JS consumption ([#3910](#3910)) ([81da8f0](81da8f0)) * **segments:** add filter for device segment ([#3880](#3880)) ([d465726](d465726)) * update colors and add all design system variables ([#3882](#3882)) ([6ee8e30](6ee8e30))

matticbot · 2025-05-08T17:11:16Z

🎉 This PR is included in version 6.6.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [6.6.0](v6.5.1...v6.6.0) (2025-05-14) ### Bug Fixes * add white background to Newspack admin screens ([#3909](#3909)) ([4c8409e](4c8409e)) * allow guest contributors to have empty archives ([#3902](#3902)) ([af8bed9](af8bed9)) * **analytics:** migrate back-end GA4 events to front-end ([#3895](#3895)) ([7e18628](7e18628)) * **auth-form:** check user before is_user_reader() call ([#3944](#3944)) ([1cbb760](1cbb760)) * avoid warning for network event ([#3942](#3942)) ([60d0aa3](60d0aa3)) * **bylines:** avoid rerendering of editable area ([#3896](#3896)) ([9fdf659](9fdf659)) * **bylines:** custom edited state for modal ([#3919](#3919)) ([2a1a800](2a1a800)) * **bylines:** get CAP data from the plugin's store ([#3906](#3906)) ([0745113](0745113)) * **corrections:** Limit CPT to posts only ([#3927](#3927)) ([1d49c39](1d49c39)) * **corrections:** Use Corrections Archive template by default ([#3929](#3929)) ([c4c1925](c4c1925)) * **email-change:** ensure success and error messages persist after redirect ([#3913](#3913)) ([caf82a5](caf82a5)) * **email-change:** improve messaging for in-progress or expired change requests ([#3886](#3886)) ([02d2ea0](02d2ea0)) * **email-change:** typo in variable name ([#3941](#3941)) ([941dc21](941dc21)) * **ga4:** ensure gate_post_id and newspack_popup_id are passed to activities ([#3956](#3956)) ([fadaa4d](fadaa4d)) * **google-login:** handle google oauth disabled state in the editor ([#3946](#3946)) ([0f9f7c6](0f9f7c6)) * hide campaigns menu when the Newspack Campaigns plugin is not activated ([#3922](#3922)) ([adcc21f](adcc21f)) * make front end not dependent on coauthors plus ([#3905](#3905)) ([dc96e5b](dc96e5b)) * **newsletters-wizard:** remove advertisers menu item ([#3948](#3948)) ([2fddbd6](2fddbd6)) * **otp-input:** enhance OTP input handling for clipboard ([#3898](#3898)) ([a56328b](a56328b)) * reinstate the Add New Newsletter link in the admin menu ([#3926](#3926)) ([1c8c7d7](1c8c7d7)) * remove extra space above empty help text ([#3904](#3904)) ([6a4fe4f](6a4fe4f)) * remove import and route for Suppression ([#3894](#3894)) ([a2034e7](a2034e7)) * **setup-wizard:** prevent Yoast redirect ([#3940](#3940)) ([3461b5f](3461b5f)) ### Features * **auth:** OTP autocomplete integration ([#3888](#3888)) ([5a1d7a8](5a1d7a8)) * **bylines:** get post byline authors ([#3911](#3911)) ([17942a2](17942a2)) * **bylines:** useAuthorTokens() hook with user entity validation ([#3907](#3907)) ([3d1feee](3d1feee)) * **email-change:** allow old email to cancel email change only, not confirm ([#3912](#3912)) ([92413e3](92413e3)) * **email-change:** remove env constant requirement ([#3943](#3943)) ([f04e58f](f04e58f)) * **ga4:** np_newsletter_subscribed event upon front-end signup ([#3938](#3938)) ([2295277](2295277)) * **ras-newsletter:** Newsletters list progressive disclosure ([#3887](#3887)) ([53f4eed](53f4eed)) * **reader-auth:** send WP login reminder email to non-reader accounts ([#3796](#3796)) ([d1af25e](d1af25e)), closes [#3823](#3823) * **scss:** export colors as module for JS consumption ([#3910](#3910)) ([81da8f0](81da8f0)) * **segments:** add filter for device segment ([#3880](#3880)) ([d465726](d465726)) * update colors and add all design system variables ([#3882](#3882)) ([6ee8e30](6ee8e30))

matticbot · 2025-05-14T17:29:33Z

🎉 This PR is included in version 6.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

feat(ga4): np_newsletter_subscribed event upon front-end signup

213b548

dkoo added the [Status] Needs Review The issue or pull request needs to be reviewed label Apr 21, 2025

dkoo self-assigned this Apr 21, 2025

dkoo requested a review from a team as a code owner April 21, 2025 20:39

dkoo mentioned this pull request Apr 21, 2025

feat(ga4): dispatch newsletter_signup activity upon signup via block Automattic/newspack-newsletters#1819

Merged

6 tasks

dkoo added 2 commits April 21, 2025 14:46

Merge branch 'trunk' into feat/ga-events-newsletter-signup

084bd64

feat: dispatch newsletter_signup activity from My Account

c201b18

miguelpeixe requested changes Apr 23, 2025

View reviewed changes

dkoo added 2 commits April 23, 2025 10:20

fix: capture subscribed list IDs on registration

23cce1e

fix: avoid empty lists array

b9e5937

dkoo requested a review from miguelpeixe April 23, 2025 16:27

fix: remove form on any success response

4eb1258

miguelpeixe approved these changes Apr 23, 2025

View reviewed changes

github-actions bot added [Status] Approved The pull request has been reviewed and is ready to merge and removed [Status] Needs Review The issue or pull request needs to be reviewed labels Apr 23, 2025

dkoo merged commit 2295277 into trunk Apr 23, 2025
8 checks passed

dkoo deleted the feat/ga-events-newsletter-signup branch April 23, 2025 17:24

github-actions bot added the needs-changelog label Apr 23, 2025

matticbot added the released on @alpha label Apr 23, 2025

leogermani removed the needs-changelog label Apr 25, 2025

matticbot added the released label May 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ga4): np_newsletter_subscribed event upon front-end signup #3938

feat(ga4): np_newsletter_subscribed event upon front-end signup #3938

Uh oh!

dkoo commented Apr 21, 2025 •

edited

Loading

Uh oh!

miguelpeixe left a comment

Uh oh!

miguelpeixe Apr 22, 2025

Uh oh!

dkoo Apr 23, 2025 •

edited

Loading

Uh oh!

dkoo commented Apr 23, 2025

Uh oh!

miguelpeixe left a comment

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025

Uh oh!

matticbot commented Apr 23, 2025

Uh oh!

matticbot commented May 8, 2025

Uh oh!

matticbot commented May 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat(ga4): np_newsletter_subscribed event upon front-end signup #3938

feat(ga4): np_newsletter_subscribed event upon front-end signup #3938

Uh oh!

Conversation

dkoo commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

Uh oh!

miguelpeixe left a comment

Choose a reason for hiding this comment

Uh oh!

miguelpeixe Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

dkoo Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dkoo commented Apr 23, 2025

Uh oh!

miguelpeixe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025

Uh oh!

matticbot commented Apr 23, 2025

Uh oh!

matticbot commented May 8, 2025

Uh oh!

matticbot commented May 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dkoo commented Apr 21, 2025 •

edited

Loading

dkoo Apr 23, 2025 •

edited

Loading