Skip to content

Commit

Permalink
Update src/Tracking/README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
eason9487 committed Jan 13, 2025
1 parent d05d56e commit 6dd960b
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions src/Tracking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,15 +279,15 @@ Triggered when the save button in contact information page is clicked.
#### Emitters
- [`EditStoreAddress`](../../js/src/pages/settings/edit-store-address.js#L41)

### [`gla_dashboard_edit_program_click`](../../js/src/pages/dashboard/all-programs-table-card/edit-program-button/edit-program-prompt-modal.js#L17)
### [`gla_dashboard_edit_program_click`](../../js/src/pages/dashboard/all-programs-table-card/edit-program-button/edit-program-prompt-modal.js#L16)
Triggered when "continue" to edit program button is clicked.
#### Properties
| name | type | description |
| ---- | ---- | ----------- |
`programId` | `string` | program id
`url` | `string` | url (free or paid)
`url` | `string` | URL for editing the program (paid campaign)
#### Emitters
- [`EditProgramPromptModal`](../../js/src/pages/dashboard/all-programs-table-card/edit-program-button/edit-program-prompt-modal.js#L32) when "Continue to edit" is clicked.
- [`EditProgramPromptModal`](../../js/src/pages/dashboard/all-programs-table-card/edit-program-button/edit-program-prompt-modal.js#L31) when "Continue to edit" is clicked.

### [`gla_datepicker_update`](../../js/src/utils/tracks.js#L135)
Triggered when datepicker (date ranger picker) is updated,
Expand All @@ -305,14 +305,14 @@ Triggered when datepicker (date ranger picker) is updated,
- [`ProductsReportFilters`](../../js/src/pages/reports/products/products-report-filters.js#L41)
- [`ProgramsReportFilters`](../../js/src/pages/reports/programs/programs-report-filters.js#L43)

### [`gla_disconnected_accounts`](../../js/src/pages/settings/linked-accounts.js#L32)
### [`gla_disconnected_accounts`](../../js/src/pages/settings/linked-accounts.js#L31)
Accounts are disconnected from the Setting page
#### Properties
| name | type | description |
| ---- | ---- | ----------- |
`context` | `string` | (`all-accounts`\|`ads-account`) - indicate which accounts have been disconnected.
#### Emitters
- [`exports`](../../js/src/pages/settings/linked-accounts.js#L42)
- [`exports`](../../js/src/pages/settings/linked-accounts.js#L41)

### [`gla_documentation_link_click`](../../js/src/components/app-documentation-link/index.js#L6)
When a documentation link is clicked.
Expand Down Expand Up @@ -349,7 +349,7 @@ When a documentation link is clicked.
- [`FreeAdCredit`](../../js/src/pages/dashboard/summary-section/paid-features/free-ad-credit.js#L19) with `{ context: 'dashboard', link_id: 'free-ad-credit-terms', href: 'https://www.google.com/ads/coupons/terms/' }`
- [`GetStartedCard`](../../js/src/pages/get-started/get-started-card/index.js#L23) with `{ context: 'get-started', linkId: 'wp-terms-of-service', href: 'https://wordpress.com/tos/' }`.
- [`GetStartedWithHeroCard`](../../js/src/pages/get-started/get-started-with-hero-card/index.js#L23) with `{ context: 'get-started-with-hero', linkId: 'wp-terms-of-service', href: 'https://wordpress.com/tos/' }`.
- [`GoogleMCDisclaimer`](../../js/src/pages/onboarding/setup-stepper/setup-accounts/index.js#L37)
- [`GoogleMCDisclaimer`](../../js/src/pages/onboarding/setup-stepper/setup-accounts/index.js#L36)
- with `{ context: 'setup-mc-accounts', link_id: 'comparison-shopping-services', href: 'https://support.google.com/merchants/topic/9080307' }`
- with `{ context: 'setup-mc-accounts', link_id: 'comparison-shopping-partners-find-a-partner', href: 'https://comparisonshoppingpartners.withgoogle.com/find_a_partner/' }`
- [`IssuesTableDataModal`](../../js/src/pages/product-feed/issues-table-card/issues-table-data-modal.js#L21) with { context: 'issues-data-table-modal' }
Expand All @@ -360,9 +360,6 @@ When a documentation link is clicked.
- with `{ context: 'setup-mc-shipping', link_id: 'shipping-read-more', href: 'https://support.google.com/merchants/answer/7050921' }`
- with `{ context: 'setup-mc-shipping', link_id: 'shipping-manual', href: 'https://www.google.com/retail/solutions/merchant-center/' }`
- [`ShippingTimeSection`](../../js/src/components/free-listings/configure-product-listings/shipping-time-section.js#L17) with `{ context: 'setup-mc-shipping', link_id: 'shipping-read-more', href: 'https://support.google.com/merchants/answer/7050921' }`
- [`TaxRate`](../../js/src/components/free-listings/configure-product-listings/tax-rate.js#L22)
- with `{ context: 'setup-mc-tax-rate', link_id: 'tax-rate-read-more', href: 'https://support.google.com/merchants/answer/160162' }`
- with `{ context: 'setup-mc-tax-rate', link_id: 'tax-rate-manual', href: 'https://www.google.com/retail/solutions/merchant-center/' }`
- [`TermsModal`](../../js/src/components/google-ads-account-card/terms-modal/index.js#L36)
- with `{ context: 'setup-ads', link_id: 'shopping-ads-policies', href: 'https://support.google.com/merchants/answer/6149970' }`
- with `{ context: 'setup-ads', link_id: 'google-ads-terms-of-service', href: 'https://support.google.com/adspolicy/answer/54818' }`
Expand Down Expand Up @@ -471,10 +468,10 @@ Clicking on the link to view free ad credit value by country.
#### Emitters
- [`FreeAdCredit`](../../js/src/components/free-ad-credit/index.js#L27) with `{ context: 'setup-ads' }`.

### [`gla_free_campaign_edited`](../../js/src/pages/edit-free-listings/index.js#L30)
Saving changes to the free listings.
### [`gla_free_campaign_edited`](../../js/src/pages/shipping/index.js#L28)
Saving changes of audience and/or shipping settings to the free listings.
#### Emitters
- [`EditFreeListings`](../../js/src/pages/edit-free-listings/index.js#L46)
- [`exports`](../../js/src/pages/shipping/index.js#L44)

### [`gla_google_account_connect_button_click`](../../js/src/utils/tracks.js#L175)
Clicking on the button to connect Google account.
Expand Down Expand Up @@ -590,7 +587,7 @@ A modal is closed.
`action` | `string` | Indicates the modal is closed by what action (e.g. `maybe-later`\|`dismiss` \| `create-another-campaign`) - `maybe-later` is used when the "Maybe later" button on the modal is clicked - `dismiss` is used when the modal is dismissed by clicking on "X" icon, overlay, generic "Cancel" button, or pressing ESC - `create-another-campaign` is used when the button "Create another campaign" is clicked - `create-paid-campaign` is used when the button "Create paid campaign" is clicked - `confirm` is used when the button "Confirm", "Save" or similar generic "Accept" button is clicked
#### Emitters
- [`AttributeMappingTable`](../../js/src/pages/attribute-mapping/attribute-mapping-table.js#L59) When any of the modals is closed
- [`Dashboard`](../../js/src/pages/dashboard/index.js#L34) when CES modal is closed.
- [`Dashboard`](../../js/src/pages/dashboard/index.js#L33) when CES modal is closed.
- [`ReviewRequest`](../../js/src/pages/product-feed/review-request/index.js#L31) with `action: 'request-review-success' | 'maybe-later' | 'dismiss', context: REQUEST_REVIEW`
- [`SubmissionSuccessGuide`](../../js/src/pages/product-feed/submission-success-guide/index.js#L157) with `action: 'create-paid-campaign' | 'maybe-later' | 'view-product-feed' | 'dismiss'`

Expand Down Expand Up @@ -627,15 +624,15 @@ Clicking on the skip paid ads button to complete the onboarding flow.
`billing_method_status` | `string` | The status of billing method of merchant's Google Ads addcount e.g. 'unknown', 'pending', 'approved', 'cancelled'
`campaign_form_validation` | `string` | Whether the entered paid campaign form data are valid, e.g. 'unknown', 'valid', 'invalid'

### [`gla_onboarding_complete_with_paid_ads_button_click`](../../js/src/pages/onboarding/setup-stepper/setup-paid-ads.js#L29)
### [`gla_onboarding_complete_with_paid_ads_button_click`](../../js/src/pages/onboarding/setup-stepper/setup-paid-ads.js#L28)
Clicking on the "Complete setup" button to complete the onboarding flow with paid ads.
#### Properties
| name | type | description |
| ---- | ---- | ----------- |
`budget` | `number` | The budget for the campaign
`audiences` | `string` | The targeted audiences for the campaign
#### Emitters
- [`exports`](../../js/src/pages/onboarding/setup-stepper/setup-paid-ads.js#L42)
- [`exports`](../../js/src/pages/onboarding/setup-stepper/setup-paid-ads.js#L41)

### [`gla_open_ads_account_claim_invitation_button_click`](../../js/src/components/google-ads-account-card/claim-account-button.js#L15)
Clicking on the button to open the invitation page for claiming the newly created Google Ads account.
Expand All @@ -659,7 +656,7 @@ Triggered when moving to another step during creating/editing a campaign.
- [`CreatePaidAdsCampaign`](../../js/src/pages/create-paid-ads-campaign/index.js#L48)
- with `{ context: 'create-ads', triggered_by: 'step1-continue-button', action: 'go-to-step2' }`.
- with `{ context: 'create-ads', triggered_by: 'stepper-step1-button', action: 'go-to-step1' }`.
- [`EditPaidAdsCampaign`](../../js/src/pages/edit-paid-ads-campaign/index.js#L57)
- [`EditPaidAdsCampaign`](../../js/src/pages/edit-paid-ads-campaign/index.js#L69)
- with `{ context: 'edit-ads', triggered_by: 'step1-continue-button', action: 'go-to-step2' }`.
- with `{ context: 'edit-ads', triggered_by: 'stepper-step1-button', action: 'go-to-step1' }`.

Expand Down

0 comments on commit 6dd960b

Please sign in to comment.