/
events.go
369 lines (333 loc) · 11.7 KB
/
events.go
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
//
// Copyright (c) 2016-2023 Snowplow Analytics Ltd. All rights reserved.
//
// This program is licensed to you under the Apache License Version 2.0,
// and you may not use this file except in compliance with the Apache License Version 2.0.
// You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the Apache License Version 2.0 is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
//
package tracker
import (
"github.com/snowplow/snowplow-golang-tracker/v3/pkg/common"
"github.com/snowplow/snowplow-golang-tracker/v3/pkg/payload"
)
// --- PageView Event
type PageViewEvent struct {
PageUrl *string // Required
PageTitle *string // Optional
Referrer *string // Optional
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *PageViewEvent) Init() {
if e.PageUrl == nil || *e.PageUrl == "" {
panic("PageURL cannot be nil or empty.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// SetSubjectIfNil will set the event level subject if a Subject isn't already set
func (e *PageViewEvent) SetSubjectIfNil(subject *Subject) {
if e.Subject == nil {
e.Subject = subject
}
}
// Get returns the event payload.
func (e PageViewEvent) Get() payload.Payload {
ep := *payload.Init()
ep.Add(EVENT, common.NewString(EVENT_PAGE_VIEW))
ep.Add(PAGE_URL, e.PageUrl)
ep.Add(PAGE_TITLE, e.PageTitle)
ep.Add(PAGE_REFR, e.Referrer)
ep.Add(TIMESTAMP, common.NewString(common.Int64ToString(e.Timestamp)))
ep.Add(EID, e.EventId)
ep.Add(TRUE_TIMESTAMP, common.NewString(common.Int64ToString(e.TrueTimestamp)))
if e.Subject != nil {
ep.AddDict(e.Subject.Get())
}
return ep
}
// --- Structured Event
type StructuredEvent struct {
Category *string // Required
Action *string // Required
Label *string // Optional
Property *string // Optional
Value *float64 // Optional
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *StructuredEvent) Init() {
if e.Category == nil || *e.Category == "" {
panic("Category cannot be nil or empty.")
}
if e.Action == nil || *e.Action == "" {
panic("Action cannot be nil or empty.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// SetSubjectIfNil will set the event level subject if a Subject isn't already set
func (e *StructuredEvent) SetSubjectIfNil(subject *Subject) {
if e.Subject == nil {
e.Subject = subject
}
}
// Get returns the event payload.
func (e StructuredEvent) Get() payload.Payload {
ep := *payload.Init()
ep.Add(EVENT, common.NewString(EVENT_STRUCTURED))
ep.Add(SE_CATEGORY, e.Category)
ep.Add(SE_ACTION, e.Action)
ep.Add(SE_LABEL, e.Label)
ep.Add(SE_PROPERTY, e.Property)
ep.Add(SE_VALUE, common.NewString(common.Float64ToString(e.Value, 2)))
ep.Add(TIMESTAMP, common.NewString(common.Int64ToString(e.Timestamp)))
ep.Add(EID, e.EventId)
ep.Add(TRUE_TIMESTAMP, common.NewString(common.Int64ToString(e.TrueTimestamp)))
if e.Subject != nil {
ep.AddDict(e.Subject.Get())
}
return ep
}
// --- SelfDescribing Event
type SelfDescribingEvent struct {
Event *SelfDescribingJson // Required
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *SelfDescribingEvent) Init() {
if e.Event == nil {
panic("Event cannot be nil.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// SetSubjectIfNil will set the event level subject if a Subject isn't already set
func (e *SelfDescribingEvent) SetSubjectIfNil(subject *Subject) {
if e.Subject == nil {
e.Subject = subject
}
}
// Get returns the event payload.
func (e SelfDescribingEvent) Get(base64Encode bool) payload.Payload {
sdj := *InitSelfDescribingJson(SCHEMA_UNSTRUCT_EVENT, e.Event.Get())
ep := *payload.Init()
ep.Add(EVENT, common.NewString(EVENT_UNSTRUCTURED))
ep.Add(TIMESTAMP, common.NewString(common.Int64ToString(e.Timestamp)))
ep.Add(EID, e.EventId)
ep.Add(TRUE_TIMESTAMP, common.NewString(common.Int64ToString(e.TrueTimestamp)))
ep.AddJson(sdj.Get(), base64Encode, UNSTRUCTURED_ENCODED, UNSTRUCTURED)
if e.Subject != nil {
ep.AddDict(e.Subject.Get())
}
return ep
}
// --- ScreenView Event
type ScreenViewEvent struct {
Name *string // Optional
Id *string // Optional
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *ScreenViewEvent) Init() {
if (e.Name == nil || *e.Name == "") && (e.Id == nil || *e.Id == "") {
panic("Name and ID cannot both be empty.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// Get returns the event payload.
func (e ScreenViewEvent) Get() SelfDescribingEvent {
ep := *payload.Init()
ep.Add(SV_NAME, e.Name)
ep.Add(SV_ID, e.Id)
sdj := InitSelfDescribingJson(SCHEMA_SCREEN_VIEW, ep.Get())
return SelfDescribingEvent{Event: sdj, Timestamp: e.Timestamp, EventId: e.EventId, TrueTimestamp: e.TrueTimestamp, Contexts: e.Contexts, Subject: e.Subject}
}
// --- Timing Event
type TimingEvent struct {
Category *string // Required
Variable *string // Required
Timing *int64 // Required
Label *string // Optional
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *TimingEvent) Init() {
if e.Category == nil || *e.Category == "" {
panic("Category cannot be nil or empty.")
}
if e.Variable == nil || *e.Variable == "" {
panic("Variable cannot be nil or empty.")
}
if e.Timing == nil {
panic("Timing cannot be nil.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// Get returns the event payload.
func (e TimingEvent) Get() SelfDescribingEvent {
data := map[string]interface{}{
UT_CATEGORY: *e.Category,
UT_VARIABLE: *e.Variable,
UT_TIMING: *e.Timing,
}
if e.Label != nil && *e.Label != "" {
data[UT_LABEL] = *e.Label
}
sdj := InitSelfDescribingJson(SCHEMA_USER_TIMINGS, data)
return SelfDescribingEvent{Event: sdj, Timestamp: e.Timestamp, EventId: e.EventId, TrueTimestamp: e.TrueTimestamp, Contexts: e.Contexts, Subject: e.Subject}
}
// --- EcommerceTransaction Event
type EcommerceTransactionEvent struct {
OrderId *string // Required
TotalValue *float64 // Required
Affiliation *string // Optional
TaxValue *float64 // Optional
Shipping *float64 // Optional
City *string // Optional
State *string // Optional
Country *string // Optional
Currency *string // Optional
Items []EcommerceTransactionItemEvent // Optional
Timestamp *int64 // Optional
EventId *string // Optional
TrueTimestamp *int64 // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *EcommerceTransactionEvent) Init() {
if e.OrderId == nil || *e.OrderId == "" {
panic("OrderID cannot be nil or empty.")
}
if e.TotalValue == nil {
panic("TotalValue cannot be nil.")
}
if e.Timestamp == nil {
e.Timestamp = common.NewInt64(common.GetTimestamp())
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// SetSubjectIfNil will set the event level subject if a Subject isn't already set
func (e *EcommerceTransactionEvent) SetSubjectIfNil(subject *Subject) {
if e.Subject == nil {
e.Subject = subject
}
}
// Get returns the event payload.
func (e EcommerceTransactionEvent) Get() payload.Payload {
ep := *payload.Init()
ep.Add(EVENT, common.NewString(EVENT_ECOMM))
ep.Add(TR_ID, e.OrderId)
ep.Add(TR_TOTAL, common.NewString(common.Float64ToString(e.TotalValue, 2)))
ep.Add(TR_AFFILIATION, e.Affiliation)
ep.Add(TR_TAX, common.NewString(common.Float64ToString(e.TaxValue, 2)))
ep.Add(TR_SHIPPING, common.NewString(common.Float64ToString(e.Shipping, 2)))
ep.Add(TR_CITY, e.City)
ep.Add(TR_STATE, e.State)
ep.Add(TR_COUNTRY, e.Country)
ep.Add(TR_CURRENCY, e.Currency)
ep.Add(TIMESTAMP, common.NewString(common.Int64ToString(e.Timestamp)))
ep.Add(EID, e.EventId)
ep.Add(TRUE_TIMESTAMP, common.NewString(common.Int64ToString(e.TrueTimestamp)))
if e.Subject != nil {
ep.AddDict(e.Subject.Get())
}
return ep
}
// --- EcommerceTransactionItem Event
type EcommerceTransactionItemEvent struct {
Sku *string // Required
Price *float64 // Required
Quantity *int64 // Required
Name *string // Optional
Category *string // Optional
EventId *string // Optional
Contexts []SelfDescribingJson // Optional
Subject *Subject // Optional
}
// Init checks and validates the struct.
func (e *EcommerceTransactionItemEvent) Init() {
if e.Sku == nil || *e.Sku == "" {
panic("Sku cannot be nil or empty.")
}
if e.Price == nil {
panic("Price cannot be nil.")
}
if e.Quantity == nil {
panic("Quantity cannot be nil.")
}
if e.EventId == nil {
e.EventId = common.NewString(common.GetUUID())
}
}
// SetSubjectIfNil will set the event level subject if a Subject isn't already set
func (e *EcommerceTransactionItemEvent) SetSubjectIfNil(subject *Subject) {
if e.Subject == nil {
e.Subject = subject
}
}
// Get returns the event payload.
func (e EcommerceTransactionItemEvent) Get() payload.Payload {
ep := *payload.Init()
ep.Add(EVENT, common.NewString(EVENT_ECOMM_ITEM))
ep.Add(TI_ITEM_SKU, e.Sku)
ep.Add(TI_ITEM_PRICE, common.NewString(common.Float64ToString(e.Price, 2)))
ep.Add(TI_ITEM_QUANTITY, common.NewString(common.Int64ToString(e.Quantity)))
ep.Add(TI_ITEM_NAME, e.Name)
ep.Add(TI_ITEM_CATEGORY, e.Category)
ep.Add(EID, e.EventId)
if e.Subject != nil {
ep.AddDict(e.Subject.Get())
}
return ep
}