Set up tracking events for this Price Benchmarks

[joemcgill]

User Story

As a product owner, I want to understand how people are using the Price Benchmarks Reports feature so I can refine it and make it more useful to merchants

Acceptance Criteria

• When PriceBenchmarkSuggestions is shown, record event gla_price_benchmarks_shown with properties:
  • suggestions (int): Count of suggestions visible.
• When the 'Change price' button is clicked, record event gla_price_benchmarks_change-price_clicked with properties:
  • context (string): location of the price change {'price-benchmarks-suggestion' | TBD}
  • productID (string): ID of product to change
• When a merchant changes a price from the change price modal, record event gla_price_benchmarks_change_price_edited with properties:
  • context (string): location the price change originated {'price-benchmarks-suggestion' |
  • productID (string)
  • GTIN (string)
  • previous price (number)
  • recommended price (number)
  • changed price (number)
  • currency (string)
    TBD}
• When the ChangePriceModal is open, record event gla_modal_open with prop:
  • context (string): 'price-benchmarks-change-price-modal'
• When the ChangePriceModal is closed, record event gla_modal_closed with props:
  • context (string): 'price-benchmarks-change-price-modal'
  • action (string): {'close' | 'change-price'}
• All new events are documented in https://github.com/woocommerce/google-listings-and-ads/blob/develop/src/Tracking/README.md.

All new tracking methods have been documented in the Tracking docs

Implementation brief

• For all tracking, the recordGlaEvent function should be used.

  • The contexts for the Price Benchmark feature can be added in js/src/pages/price-benchmark/constants.js:
    • price-benchmark-suggestions
    • price-benchmark-change-price-modal

• All tracking info should be added as comments using the @fires and @event properties.

• Using js/src/pages/price-benchmark/change-price.js:

  • In the handleOnPriceChange, track the gla_modal_closed event with:
    • context: as per the AC
    • action: close
  • Add the following props to the Change Price button:
    • eventName: gla_price_benchmarks_change-price_clicked
    • eventProps: object containing:
      • context (as per the AC)
      • productID (with the product ID as value)

• Using js/src/pages/price-benchmark/change-price-modal/index.js:

  • Track the gla_modal_open and gla_modal_closed events upon component mount with the parameters as per the AC.
  • Add the regularPrice prop to the PriceInputFooter component for tracking purposes (see below).

• Using js/src/pages/price-benchmark/change-price-modal/price-input-footer.js:

  • Add a new regularPrice prop.
  • Update the handleOnPriceChange function to track the gla_price_benchmarks_change_price_edited event as per the AC.
    • The currency can be obtained via the googleAdsAccount object.

• Using js/src/pages/price-benchmark/price-benchmark-suggestions/index.js:

  • Track the gla_price_benchmarks_shown event as per the AC.

• Tracking Docs: https://github.com/woocommerce/google-listings-and-ads/blob/develop/src/Tracking/README.md

• Script for updating docs: https://github.com/woocommerce/grow/tree/trunk/packages/js/tracking-jsdoc

TBD

Additional info

From the PRD:

For this feature, we would like to track:

• % of Merchants who see at least once the report
• Frequency of Use (how many times per week/month)
• % of Merchants who adjust prices after seeing the report
• From those who adjusted prices, the uplift in Conversions
• From those who adjusted prices, the uplift in Conversions Value
• From those who adjusted prices, the uplift in ARPA
• From those who adjusted prices, the uplift in Retention

[joemcgill]

@MatthiasReinholz and @asvinb, let me know what you think of the AC before we define the implementation details.

My assumption for now is that we won't record any of the uplift data for now since we've deprioritized #2845 and #2830.

[asvinb]

AC sounds good to me @joemcgill 👍

[joemcgill]

Added suggestions from @MatthiasReinholz to the AC for the gla_price_benchmarks_change_price_edited action.

[asvinb]

@joemcgill I've added the IB. A couple of things I noticed while working on the IB:

• The event naming is inconsistent — for example, we have both gla_price_benchmarks_change-price_clicked and gla_price_benchmarks_change_price_edited. Notice that the former uses a hyphen (-) between "change" and "price", while the latter uses an underscore (_).
• For the gla_modal_open and gla_modal_closed events, we could consider including the productID to enhance the quality of the analytics data.

Also, I think we should be using "price_benchmark" instead of "price_benchmarks"? 🤔

cc @MatthiasReinholz