-
Notifications
You must be signed in to change notification settings - Fork 11
/
google-analytics.brs
221 lines (185 loc) · 7.58 KB
/
google-analytics.brs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
'
' Roku Analytics Tracking Library 2.0 - google-analytics.brs
' (Adapted from Roku Univesal Analytics Tracking Library
' https://github.com/thyngster/roku-universal-analytics)
'
' Examples:
' - Tracker init
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.init("UA-12345678-90")
' OR with multiple tracking ids
' googleAnalytics.init(["UA-12345678-90", ..., "UA-09876543-21"])
'
' - Event tracking
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.trackEvent({ category: "application", action: "launch"})
'
' - Screen tracking
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.trackScreen({ name: "mainScreen" })
'
' - E-Commerce tracking
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.trackTransaction({ id: "OD564", revenue: "10.00"})
' googleAnalytics.trackItem({ transactionId: "OD564", name: "Test01", price: "10.00", code: "TEST001", category: "vod"})
'
' - Timing tracking
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.trackTiming({ category: "category", variable: "timing", time: "1000" })
'
' - Exception tracking
' googleAnalytics = GoogleAnalyticsLib()
' googleAnalytics.trackException({ description: "description", isFatal: "1" })
'
function GoogleAnalyticsLib() as Object
if m.analytics = invalid then
ai = createObject("roAppInfo")
di = createObject("roDeviceInfo")
m.analytics = {
_baseParams: {
v: "1",
cid: di.getChannelClientId(),
an : ai.getTitle(),
av : ai.getVersion(),
ds : "app"
}
_trackingId: invalid
_endpoint: "https://www.google-analytics.com/collect"
_endpointBatch: "https://www.google-analytics.com/batch"
_enabled: false
_port: createObject("roMessagePort")
_sentRequests: {}
init: function(trackingId as Dynamic)
if getInterface(trackingId, "ifArray") = invalid then trackingId = [trackingId]
m._trackingId = trackingId
m._enabled = true
end function
setParams: function(customParams as Object)
m._baseParams.append(customParams)
end function
getPort: function() as Object
return m._port
end function
trackEvent: function(event as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "event"
ec : event.category
ea : event.action
el : event.label
ev : event.value
cd1 : event.dim1
}
return m._send(payload)
end function
trackScreen: function(screen as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "screenview"
cd : screen.name
}
return m._send(payload)
end function
trackTransaction: function(transaction as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "transaction"
ta : transaction.affiliation
ti : transaction.id
tr : transaction.revenue
tt : transaction.tax
ts : transaction.shipping
cu : transaction.currencyCode
}
return m._send(payload)
end function
trackItem: function(item as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "item"
iq : item.quantity
ti : item.transactionId
in : item.name
ip : item.price
cu : item.currencyCode
ic : item.code
iv : item.category
}
return m._send(payload)
end function
trackTiming: function(timing as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "timing"
utc : timing.category
utv : timing.variable
utt : timing.time
plt : timing.loadTime
srt : timing.responseTime
}
return m._send(payload)
end function
trackException: function(exception as Object) as Dynamic
if not m._enabled then return invalid
payload = {
t : "exception"
exd : exception.description
exf : exception.isFatal
}
return m._send(payload)
end function
_send: function(payload as Object)
payload.append(m._baseParams)
encodedPayload = m._encodePayload(payload)
endpoint = m._getEndpoint()
data = m._createPostData(encodedPayload)
req = createObject("roURLTransfer")
req.setMessagePort(m._port)
req.setUrl(endpoint)
req.setRequest("POST")
req.setCertificatesFile("common:/certs/ca-bundle.crt")
req.initClientCertificates()
req.addHeader("X-Roku-Reserved-Dev-Id", "")
req.addHeader("Content-Type", "text/plain")
req.asyncPostFromString(data)
m._sentRequests[req.getIdentity().toStr()] = req
m._cleanupRequests()
end function
_encodePayload: function(params as Object) as String
payload = ""
for each item in params.items()
if item.value <> invalid then
payload = payload + item.key + "=" + item.value.encodeUriComponent() + "&"
end if
end for
payload = payload + "z=" + m._getCacheBuster()
return payload
end function
_getCacheBuster: function()
return createObject("roDateTime").asSeconds().toStr()
end function
_getEndpoint: function() as String
endpoint = m._endpoint
if m._trackingId.count() > 1 then endpoint = m._endpointBatch
return endpoint
end function
_createPostData: function(payload as String) as Object
data = ""
for each id in m._trackingId
data += "tid=" + id.encodeUriComponent() + "&" + payload + chr(10)
end for
return data.left(data.len() - 1)
end function
_cleanupRequests: function()
for each request in m._sentRequests
msg = m._port.getMessage()
if type(msg) = "roUrlEvent" then
requestId = msg.getSourceIdentity().toStr()
if msg.getInt() = 1 then m._sentRequests.delete(requestId)
end if
end for
end function
}
end if
return m.analytics
end function