Skip to content

Commit 39f62b6

Browse files
MillenniumFalconMechanicMillenniumFalconMechanic
committed
Udpated GA/GTM docs. Resolves #1067. (#1152)
1 parent 02c6672 commit 39f62b6

File tree

1 file changed

+232
-36
lines changed

1 file changed

+232
-36
lines changed

‎google-analytics.md‎

Lines changed: 232 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,209 @@
11
### Google Analytics
22

3-
#### Events
3+
#### Custom Dimensions
4+
5+
The following custom dimensions are configured in Google Analytics, allowing additional data (in addition to Category, Action and Label) to be included in each data layer event fired from the front end.
6+
7+
- `entityType`
8+
- `entityUrl`
9+
- `fileType`
10+
- `fileFormat`
11+
- `fileName`
12+
- `releaseName`
13+
- `toolName`
14+
15+
#### Tracked Events
16+
17+
##### Manifest Events
18+
19+
###### Cohort Manifest Request
20+
21+
- Category: "Manifest"
22+
- Action: "Request"
23+
- Label: `query`
24+
25+
26+
- Entity Type: "Cohort Manifest"
27+
28+
###### Cohort Manifest Download
29+
30+
- Category: "Manifest"
31+
- Action: "Download"
32+
- Label: `query`
33+
34+
35+
- Entity Type: "Cohort Manifest Link"
36+
- Entity URL: `http://path/to/download`
37+
38+
###### Cohort Manifest Download Link Copy to Clipboard
39+
40+
- Category: "Manifest"
41+
- Action: "Copy to Clipboard"
42+
- Label: `query`
43+
44+
45+
- Entity Type: "Cohort Manifest Link"
46+
- Entity URL: `http://path/to/download`
47+
48+
###### Cohort Manifest Download
49+
50+
- Category: "Manifest"
51+
- Action: "Download"
52+
- Label: `projectTitle`
53+
54+
55+
- Entity Type: "Project Manifest Link"
56+
- Entity URL: `http://path/to/download`
57+
58+
###### Cohort Manifest Download Link Copy to Clipboard
59+
60+
- Category: "Manifest"
61+
- Action: "Copy to Clipboard"
62+
- Label: `projectTitle`
63+
64+
65+
- Entity Type: "Project Manifest Link"
66+
- Entity URL: `http://path/to/download`
67+
68+
##### Matrix Events
69+
70+
###### Cohort Matrix Request
71+
72+
- Category: "Matrix"
73+
- Action: "Request"
74+
- Label: `query`
75+
76+
77+
- Entity Type: "Cohort Matrix"
78+
- File Format: `fileFormat`
79+
80+
###### Cohort Matrix Download
81+
82+
- Category: "Matrix"
83+
- Action: "Download"
84+
- Label: `query`
85+
86+
87+
- Entity Type: "Cohort Matrix Link"
88+
- Entity URL: `http://path/to/download`
89+
90+
###### Cohort Matrix Download Link Copy to Clipboard
91+
92+
- Category: "Matrix"
93+
- Action: "Copy to Clipboard"
94+
- Label: `query`
95+
96+
97+
- Entity Type: "Cohort Matrix Link"
98+
- Entity URL: `http://path/to/download`
99+
100+
###### Cohort Matrix Download
101+
102+
- Category: "Matrix"
103+
- Action: "Download"
104+
- Label: `projectTitle`
4105

5-
There are currently two release-related events captured by Google Analytics: `Download` and `Visualize`. Both events send core event data (Category, Action and Label) as well as additional event-related data as dimensions (eg Dataset Name, Release Name, Tool Name) every time they are fired.
6106

7-
These two events are fired by the front end according to the Google Tag Manager configuration.
107+
- Entity Type: "Project Matrix Link"
108+
- Entity URL: `http://path/to/download`
8109

9-
##### Download Events
110+
###### Cohort Matrix Download Link Copy to Clipboard
10111

11-
Download events are configured as:
112+
- Category: "Matrix"
113+
- Action: "Copy to Clipboard"
114+
- Label: `projectTitle`
115+
116+
117+
- Entity Type: "Project Matrix Link"
118+
- Entity URL: `http://path/to/download`
119+
120+
##### Terra Events
121+
122+
###### Export Request
123+
124+
- Category: "Export"
125+
- Action: "Request"
126+
- Label: `query`
127+
128+
129+
- Entity Type: "Cohort Export"
130+
- Tool Name: "Terra"
131+
132+
###### Export Launch
133+
134+
- Category: "Export"
135+
- Action: "Launch"
136+
- Label: `query`
137+
138+
139+
- Entity Type: "Cohort Export Link"
140+
- Entity URL: `http://path/to/terra`
141+
- Tool Name: "Terra"
142+
143+
###### Export Link Copy to Clipboard
144+
145+
- Category: "Export"
146+
- Action: "Copy to Clipboard"
147+
- Label: `query`
148+
149+
150+
- Entity Type: "Cohort Export Link"
151+
- Entity URL: `http://path/to/terra`
152+
- Tool Name: "Terra"
153+
154+
##### Release Events
155+
156+
###### Dataset Download
12157

13158
- Category: "Dataset"
14159
- Action: "Download"
15-
- Label: `http://path/to/download`
160+
- Label: `datasetName`
161+
162+
163+
- Entity URL: `http://path/to/download`
164+
- File Format: `fileFormat`
165+
- File Name: `fileName`
166+
- File Type: `fileType`
167+
- Release Name: `releaseName`
168+
169+
###### Dataset Copy to Clipboard
170+
171+
Copy to Clipboard events are configured as:
16172

17-
- Dataset Name: `datasetName`
18-
- File Extension: `fileExtension`
173+
- Category: "Dataset"
174+
- Action: "Copy to Clipboard"
175+
- Label: `datasetName`
176+
177+
178+
- Entity URL: `http://path/to/download`
179+
- File Format: `fileFormat`
19180
- File Name: `fileName`
20181
- File Type: `fileType`
21182
- Release Name: `releaseName`
22183

23-
##### Visualize Events
184+
###### Dataset Visualize
24185

25186
Visualize events are configured as:
26187

27188
- Category: "Dataset"
28189
- Action: "Visualize"
29-
- Label: `http://path/to/visualization-tool`
190+
- Label: `datasetName`
30191

31-
- Dataset Name: `datasetName`
192+
193+
- Entity URL: `http://path/to/visualization-tool`
32194
- Release Name: `releaseName`
33195
- Tool Name: `toolName`
34196

35-
#### Custom Dimensions
36-
37-
The following custom dimensions are configured in Google Analytics, allowing additional data (beyond Category, Action and Label) to be included in each data layer event fired from the front end.
38-
39-
- `datasetName`
40-
- `fileType`
41-
- `fileExtension`
42-
- `fileName`
43-
- `releaseName`
44-
- `toolName`
45197

46198
### GTM "Data Layer" Variables
47199

48-
##### Dataset Name
49-
- Used to capture `datasetName` dimension from front end data layer.
50-
- Corresponds to `datasetName` custom dimension in Google Analytics.
200+
##### Entity Type Name
201+
- Used to capture `entityType` dimension from front end data layer.
202+
- Corresponds to `entityType` custom dimension in Google Analytics.
203+
204+
##### Entity URL Name
205+
- Used to capture `entityUrl` dimension from front end data layer.
206+
- Corresponds to `entityUrl` custom dimension in Google Analytics.
51207

52208
##### Event Action
53209
- Used to capture `eventAction` dimension from front end data layer.
@@ -57,9 +213,9 @@ The following custom dimensions are configured in Google Analytics, allowing add
57213
- Used to capture `eventLabel` dimension from front end data layer.
58214
- Corresponds to the Label value in a Google Analytics event.
59215

60-
##### File Extension
61-
- Used to capture `fileExtension` dimension from front end data layer.
62-
- Corresponds to `fileExtension` custom dimension in Google Analytics.
216+
##### File Format
217+
- Used to capture `fileFormat` dimension from front end data layer.
218+
- Corresponds to `fileFormat` custom dimension in Google Analytics.
63219

64220
##### File Name
65221
- Used to capture `fileName` dimension from front end data layer.
@@ -85,21 +241,61 @@ The following custom dimensions are configured in Google Analytics, allowing add
85241
#### Visualize
86242
- Custom event, listens for events where event name is "Dataset" and event action is "Visualize".
87243

88-
### GTM Tags
244+
### GTM Tags and Triggers
89245

90-
#### Download
91-
- Sends "Download" event to Google Analytics when Download trigger is fired.
92-
- Event data includes Category, Action and Label as well as Dataset Name, File Extension, File Name, File Type and Release Name dimensions.
246+
#### Cohort Manifest Request
247+
- Sends "Cohort Manifest Request" event to Google Analytics when `Cohort Manifest Request` trigger is fired.
248+
- Event data includes Category, Action and Label as well as the Entity Type dimension.
93249

94-
#### Visualize
95-
- Sends "Visualize" event to Google Analytics when Download trigger is fired.
96-
- Event data includes Category, Action and Label as well as Dataset Name, Release Name and Tool Name dimensions.
250+
#### Cohort Manifest Download
251+
- Sends "Cohort Manifest Download" event to Google Analytics when `Cohort Manifest Download` trigger is fired.
252+
- Event data includes Category, Action and Label as well as Entity Type and Entity URL dimensions.
253+
254+
#### Cohort Manifest Download Link Copy to Clipboard
255+
- Sends "Cohort Manifest Copy to Clipboard" event to Google Analytics when `Cohort Manifest Copy to Clipboard` trigger is fired.
256+
- Event data includes Category, Action and Label as well as Entity Type and Entity URL dimensions.
257+
258+
#### Cohort Matrix Request
259+
- Sends "Cohort Matrix Request" event to Google Analytics when `Cohort Matrix Request` trigger is fired.
260+
- Event data includes Category, Action and Label as well as Entity Type and File Format dimensions.
261+
262+
#### Cohort Matrix Download
263+
- Sends "Cohort Matrix Download" event to Google Analytics when `Cohort Matrix Download` trigger is fired.
264+
- Event data includes Category, Action and Label as well as Entity Type and Entity URL dimensions.
265+
266+
#### Cohort Matrix Download Link Copy to Clipboard
267+
- Sends "Cohort Matrix Copy to Clipboard" event to Google Analytics when `Cohort Matrix Copy to Clipboard` trigger is fired.
268+
- Event data includes Category, Action and Label as well as Entity Type and Entity URL dimensions.
269+
270+
#### Export Request
271+
- Sends "Export Request" event to Google Analytics when `Export Request` trigger is fired.
272+
- Event data includes Category, Action and Label as well as Entity Type and Tool Name dimensions.
273+
274+
#### Export Launch
275+
- Sends "Export Launch" event to Google Analytics when `Export Launch` trigger is fired.
276+
- Event data includes Category, Action and Label as well as Entity Type, Entity URL and Tool Name dimensions.
277+
278+
#### Export Copy to Clipboard
279+
- Sends "Export Copy to Clipboard" event to Google Analytics when `Export Copy to Clipboard` trigger is fired.
280+
- Event data includes Category, Action and Label as well as Entity Type, Entity URL and Tool Name dimensions.
281+
282+
#### Dataset Download
283+
- Sends "Download" event to Google Analytics when `Dataset Download` trigger is fired.
284+
- Event data includes Category, Action and Label as well as Entity URL, File Format, File Name, File Type and Release Name dimensions.
285+
286+
#### Dataset Copy to Clipboard
287+
- Sends "Copy to Clipboard" event to Google Analytics when `Dataset Copy to Clipboard` trigger is fired.
288+
- Event data includes Category, Action and Label as well as Entity URL, File Format, File Name, File Type and Release Name dimensions.
289+
290+
#### Dataset Visualize
291+
- Sends "Visualize" event to Google Analytics when `Dataset Visualize` trigger is fired.
292+
- Event data includes Category, Action and Label as well as Release Name and Tool Name dimensions.
97293

98294
### Front End Data Layer Event Configuration
99295

100296
```
101297
{
102-
event: "eventName"
298+
event: "eventName"
103299
eventAction: "eventAction",
104300
eventLabel: "eventLabel",
105301
dimension0: "dimension0Value",
@@ -115,4 +311,4 @@ where:
115311

116312
### Deployment
117313

118-
Currently published to develop, ux-dev, integration, staging.
314+
Currently published to develop, ux-dev, integration, staging and production.

0 commit comments

Comments
 (0)