site-kit-wp icon indicating copy to clipboard operation
site-kit-wp copied to clipboard
verified publisher icon google

Rename "conversions" for consistency with Google Analytics

Open aaemnnosttv opened this issue 1 year ago • 1 comments

Feature Description

Google Analytics is in the process of renaming its "conversions" feature to "key events" to disambiguate between a similar concept by the same name in Google Ads. See https://support.google.com/analytics/answer/13965727

We should update our references in the user-facing parts of the SK dashboard for consistency across surfaces.

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

Implementation Brief

  • [ ]

Test Coverage

QA Brief

Changelog entry

aaemnnosttv avatar Oct 04 '24 12:10 aaemnnosttv

I created a task to cover this one, to accommodate any website changes.

jamesozzie avatar Oct 10 '24 15:10 jamesozzie

cc @marrrmarrr

aaemnnosttv avatar Jan 24 '25 20:01 aaemnnosttv

Notes:

I kept the KM_ANALYTICS_TOP_CONVERTING_TRAFFIC_SOURCE widget title the same because "Top key events traffic source" didn't make sense to me, open to suggestions on better naming for this widget. https://github.com/google/site-kit-wp/blob/34a622ae7b1dba524d7e385dccf0740db68b2313/assets/js/components/KeyMetrics/key-metrics-widgets.js#L403-L414

Is this tour still relevant, it mentions a Goals to Conversions migration: https://github.com/google/site-kit-wp/blob/34a622ae7b1dba524d7e385dccf0740db68b2313/assets/js/feature-tours/ga4-reporting.js#L49-L74

benbowler avatar Jan 27 '25 10:01 benbowler

Hi @benbowler, thanks for drafting the IB. There are a few additional cases to consider, please take a look at these. Let's also ask for @aaemnnosttv's thoughts on some of these.

  • Some of the suggested copy reads a bit ambiguously or could otherwise use a tweak.

    • '%s of visits led to key events': This is a bit unclear, I'd suggest "led to key events being triggered", or "led to key events occurring" or something. Here's a Google support article discussing key events for consideration: https://support.google.com/analytics/answer/9267568?hl=en
    • 'Channel which brought in the most visits that resulted in key events': The same point applies here.
    • 'To track the performance of your campaigns, Site Kit will enable enhanced key events tracking.': A minor one, but this would read better as "key event tracking".
    • 'By disabling enhanced key events tracking...': As above, although there's an additional question about this case listed further below for ConfirmDisableConversionTrackingDialog.
    • 'Enhanced Key Events Tracking': This doesn't scan so well. Firstly it should be "Key Event Tracking" rather than "Key Events Tracking". Secondly, though, I've got a related question about whether "Enhanced Conversion Tracking" should remain as a distinct concept/phrase. I suppose if we have regular key event tracking for GA4 then having enhanced key event tracking does make sense though... :thinking:
    • 'To track the performance of your campaigns, Site Kit will enable enhanced key events tracking': As above.

  • GA4 conversions feature tour:

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/feature-tours/ga4-reporting.js#L50-L58

  • GA4 conversions in the Search Funnel widget:

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/CreateConversionCTA.js#L63-L79

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/index.js#L403

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/index.js#L441

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/index.js#L489

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/index.js#L283

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/OptionalCells.js#L73

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/CreateConversionCTA.js#L70

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/index.js#L303

  • The copy in the ConfirmDisableConversionTrackingDialog component is debatable as it applies to both Ads and Analytics. Let's ask @evan's opinion on this one as he created the issue and its AC. I'd also like to get his thoughts on the copy changes mentioned above, and the point below this one.

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/components/conversion-tracking/ConfirmDisableConversionTrackingDialog.js#L42-L63

  • A similar question applies to the ConversionTrackingToggle component as this is used for both Ads and Analytics. Maybe the copy should just be changed for its use in a GA4 context. Or, I'm wondering if references to "enhanced conversion tracking" should remain untouched as this could be seen as its own concept (as per my comment toward the top).

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/components/conversion-tracking/ConversionTrackingToggle.js#L57

  • It's out in the fringes but I wonder about this conversion reporting settings validation copy as it seems this could probably apply to GA4 or Ads conversions:

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/googlesitekit/datastore/user/conversion-reporting-settings.js#L69

  • The SetupEnhancedConversionTrackingNotice in the GA4 SetupForm:

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/assets/js/modules/analytics-4/components/setup/SetupForm.js#L141

  • Another fringe consideration, I'm not sure if this Site Health label could apply to GA4 key events... :thinking:

https://github.com/google/site-kit-wp/blob/6812093081d15dc656a03b5d48dc15857a03778f/includes/Core/Site_Health/Debug_Data.php#L639

techanvil avatar Jan 27 '25 15:01 techanvil

Oh, one more thing - please provide an estimate once this is ready for review again :)

techanvil avatar Jan 27 '25 15:01 techanvil

Thanks @techanvil & @benbowler ! In retrospect, I think this issue has been interpreted to be a bit more complicated than originally intended, and I should have been more specific about this change being about Analytics Conversions rather than conversions in general, since we do have some blending of the term where I think it could still be appropriate.

That is, "key events" in GA have a concrete definition – events in GA which have been created or toggled as Key Events. Since we don't mark any events as Key Events via SK, these are managed by the user (or use defaults). We only surface this within the Search Funnel widget in 1 report as "Conversions". This is the primary thing to change here since these are the only true key events we surface or refer to. Importantly, there are also deprecations to action here in terms of the endpoints for listing conversion events as well as the metric for conversions (conversions isn't even listed in the catalog of all core metrics anymore – only keyEvents is present).

Everywhere else where we refer to "conversions" is probably okay to remain as-is, at least for now, since this mostly refers to events which are/relate-to conversions on the Ads side which can also be tracked in GA. That is, someone could have submit_lead_form as an event which they are using as a conversion to optimize for in Ads while also tracking it in GA if both are connected, and it can still be a valid conversion (in Ads) without being marked as a Key Event in GA. It's a bit confusing, and perhaps we should simply remove key events from GA entirely from GA in SK since they don't provide much value for us. Let's keep this issue focused on the above for now and revisit the question of KE in SK in the future.

To be explicit, this issue should not touch "enhanced conversion tracking" or anything which is not directly referring to a real "key event" in GA. I'll update the AC to be a bit more clear.

aaemnnosttv avatar May 05 '25 18:05 aaemnnosttv

Thanks for the clarification, @aaemnnosttv!

techanvil avatar May 06 '25 14:05 techanvil

Hey @benbowler, thanks for updating the IB. A few points:

  • Update the datapoint to GET:key-events.

Let's be clear that we're talking about renaming GET:conversion-events here.

  • Replace the analytics call with getKeyEvents().

It would be useful to be more specific here, too. It looks like we should be replacing $analyticsadmin->properties_conversionEvents->listPropertiesConversionEvents( ... ) with $analyticsadmin->properties_keyEvents->listPropertiesKeyEvents( ... ) in create_data_request(), and $response->getConversionEvents() with $response->getKeyEvents() in parse_data_response(), right?

It also looks like there are a few other places that will need updating. Within the SearchFunnelWidgetGA4 we have the following, please review to verify their relevance and update accordingly:

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/CreateConversionCTA.js#L70

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/DataBlocks.js#L187

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/DataBlocks.js#L165-L167

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Chart.js#L85

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Chart.js#L121

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/CreateConversionCTA.js#L63

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/CreateConversionCTA.js#L79

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/OptionalCells.js#L75

We also have the TopConvertingTrafficSourceWidget, it looks like the metric that its report currently uses, sessionConversionRate has also been deprecated/removed and replaced with sessionKeyEventRate (see https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics).

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/components/KeyMetrics/key-metrics-widgets.js#L402-L406

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/analytics-4/components/widgets/TopConvertingTrafficSourceWidget.js#L126

https://github.com/google/site-kit-wp/blob/93c098cde7795defe07d569ce19a3ddebbe21649/assets/js/modules/analytics-4/components/widgets/TopConvertingTrafficSourceWidget.js#L60-L64

We'll also want to replace conversions and sessionConversationRate with their key event equivalents in assets/js/modules/analytics-4/utils/data-mock.js and includes/Modules/Analytics_4/Report/RequestHelpers.php.

There will probably be additional tests to update as a result of these changes too.

techanvil avatar May 13 '25 11:05 techanvil

Thanks for updating the IB, @benbowler. LGTM!

IB ✅

techanvil avatar May 14 '25 11:05 techanvil

QA Update ✅

  • Tested on dev environment.
  • Verified Conversions in Google Analytics renamed to "key events" in user facing elements.
  • Verified the Search Funnel widget as per the AC.
  • Confirmed that the "Conversions" label has been successfully replaced with "Key Events" in both the column and the chart.
  • Checked both scenarios: --- When no key events are set up – the "Set up Key Events" CTA is displayed as expected. --- When key events are set up and data is available (tested using oi.ie) – the widget displays the updated "Key Events" label with data correctly.
  • Also, tested view only dashboard.
  • Smoke tested the KMW and Search funnel Key events widget both are working as expected.

Without Events

Image

Image

https://github.com/user-attachments/assets/da8189e9-f553-4411-a45a-c0d046870075

Site with Key Events

Image

Image

Image

Image

Image

KMW

Image

mohitwp avatar Jun 04 '25 13:06 mohitwp