-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Move "tracks" analytics into a shared calypso-analytics packa…
- Loading branch information
Showing
21 changed files
with
311 additions
and
788 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,45 @@ | ||
Analytics: Tracks | ||
================= | ||
|
||
Moved to the [calypso-analytics package](../../../../packages/calypso-analytics/README.md) | ||
Automatticians may refer to internal documentation for more information about Tracks. | ||
|
||
## Usage | ||
|
||
Note: In most situations it is best to use the [Analytics Middleware](https://github.com/Automattic/wp-calypso/tree/master/client/state/analytics), which has no direct browser dependencies and therefore will not complicate any unit testing of the modules where it is used. | ||
|
||
### `recordGoogleEvent( name, properties )` | ||
|
||
```js | ||
import { recordTracksEvent } from 'state/analytics/actions'; | ||
|
||
dispatch( recordTracksEvent( 'calypso_checkout_coupon_apply', { 'coupon_code': 'abc123' } ) ); | ||
``` | ||
|
||
### `analytics.tracks.recordEvent( name, properties )` (Deprecated) | ||
|
||
_Note: Unless you have a strong reason to call `analytics.tracks` directly, you should use the Analytics Middleware instead._ | ||
|
||
Record an event with optional properties: | ||
|
||
```js | ||
analytics.tracks.recordEvent( 'calypso_checkout_coupon_apply', { | ||
'coupon_code': 'abc123' | ||
} ); | ||
``` | ||
|
||
## Naming Conventions | ||
|
||
To be recorded, event names originating from Calypso must be prefixed by `calypso_`, and each token in the event and property names must be separated by an underscore (`_`). | ||
|
||
_Note: Events not prefixed by `calypso_`, with words not separated by underscore (e.g. by spaces or dashes), or written in camel case, **will be discarded**._ | ||
|
||
In order to keep similar events grouped together when sorted in an alphabetized list (as is typical with analytics tools), put the verb at _the end_ of the event name: | ||
|
||
- `calypso_cart_product_add` | ||
- `calypso_cart_product_remove` | ||
|
||
If we had instead used `calypso_add_cart_product` and `calypso_remove_cart_product`, then they'd likely be separated in a list of all the event names. | ||
|
||
Finally, for consistency, the verb at the end should be in a non-conjugated form like `add`, `remove`, `view`, or `click`, and _not_ `adds`, `added`, or `adding`. | ||
|
||
With the exception of separating tokens with underscores, these rules do not apply to property names. `coupon_code` is perfectly fine. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.