forked from art-institute-of-chicago/aic-mobile-ios
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AICAnalytics.swift
359 lines (297 loc) · 11.3 KB
/
AICAnalytics.swift
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
/*
Abstract:
Abstracted analytics centralized commands
currently using Google Analytics
*/
import Firebase
class AICAnalytics {
fileprivate enum Event: String {
case appOpen = "app_open"
case languageFirstSelection = "language_first_selection"
case audioPlayed = "audio_played"
case audioStopped = "audio_stopped"
case audioError = "audio_error"
case tourStarted = "tour_started"
case tourLeft = "tour_left"
case eventViewed = "event_viewed"
case eventRegisterLink = "event_register_link"
case exhibitionViewed = "exhibition_viewed"
case exhibitionBuyLink = "exhibition_buy_link"
case exhibitionMap = "exhibition_map"
case search = "search"
case searchNoResults = "search_no_results"
case searchAbandoned = "search_abandoned"
case searchTappedArtwork = "search_tapped_artwork"
case searchTappedTour = "search_tapped_tour"
case searchTappedExhibition = "search_tapped_exhibition"
case searchFacilities = "search_facilities"
case searchArtworkMap = "search_artwork_map"
case searchIconMap = "search_icon_map"
case locationDetected = "location_detected"
case locationHeadingEnabled = "location_heading_enabled"
case memberCardShown = "member_card_shown"
case miscLinkTapped = "misc_link_tapped"
}
enum PlaybackSource: String {
case Map = "Map"
case AudioGuide = "Audio Guide"
case Search = "Search"
case SearchIcon = "Search Icon"
case TourStop = "Tour Stop"
}
enum PlaybackCompletion: String {
case Completed = "Completed"
case Interrupted = "Interrupted"
}
enum Facility: String {
case Dining = "Dining"
case MemberLounge = "Lounge"
case GiftShop = "Gift Shop"
case Restroom = "Restroom"
}
enum LocationState: String {
case Disabled = "Disabled"
case NotNow = "Not Now"
case OffSite = "Off Site"
case OnSite = "On Site"
}
enum SearchTermSource: String {
case TextInput = "Text Input"
case Promoted = "Promoted Text"
case Autocomplete = "Autocomplete Suggestion"
}
enum MiscLink: String {
case InfoPhone = "Info Phone"
case InfoAddress = "Info Address"
case MemberJoin = "MemberJoin"
}
fileprivate enum UserProperty: String {
case membership = "Membership"
case appLanguage = "Language"
case deviceLanguage = "DeviceLanguage"
}
static fileprivate let parameterMaxLength = 95
static fileprivate var previousScreen: String?
static fileprivate var currentScreen: String?
static fileprivate var lastSearchTerm: String = ""
static func configure() {
FirebaseApp.configure()
// Set User Properties
let userDefaults = UserDefaults.standard
let membership = userDefaults.object(forKey: Common.UserDefaults.memberInfoIDUserDefaultsKey) != nil ? "Member" : "None"
let deviceLanguage = NSLocale.preferredLanguages.first!
let languageString: String = Common.stringForLanguage[Common.currentLanguage]!
setUserProperty(property: .membership, value: membership)
setUserProperty(property: .appLanguage, value: languageString)
setUserProperty(property: .deviceLanguage, value: deviceLanguage)
}
// MARK: Track Screens
static func trackScreenView(_ screenName: String, screenClass: String) {
if screenName != currentScreen {
Analytics.setScreenName(screenName, screenClass: screenClass)
previousScreen = currentScreen
currentScreen = screenName
}
}
// MARK: Track Events
private static func trackEvent(_ event: Event, parameters: [String: String]? = nil) {
Analytics.logEvent(event.rawValue, parameters: parameters)
}
// MARK: Set User Property
private static func setUserProperty(property: UserProperty, value: String) {
Analytics.setUserProperty(value, forName: property.rawValue)
}
// MARK: Language
static func sendLanguageFirstSelectionEvent(language: Common.Language) {
let languageString: String = Common.stringForLanguage[language]!
setUserProperty(property: .appLanguage, value: languageString)
let parameters: [String: String] = [
"start_language": languageString
]
trackEvent(.languageFirstSelection, parameters: parameters)
}
static func updateLanguageSelection(language: Common.Language) {
let languageString: String = Common.stringForLanguage[language]!
setUserProperty(property: .appLanguage, value: languageString)
}
// MARK: Location
static func sendLocationEnableHeadingEvent() {
trackEvent(.locationHeadingEnabled)
}
static func sendLocationDetectedEvent(location: LocationState) {
let parameters: [String: String] = [
"location": location.rawValue
]
trackEvent(.locationDetected, parameters: parameters)
}
static func updateUserLocationProperty(isOnSite: Bool?) {
// if isOnSite != nil {
// setUserProperty(property: .onSite, value: isOnSite! ? "Yes" : "No")
// }
// else {
// setUserProperty(property: .onSite, value: "Undefined")
// }
}
// MARK: Audio Player
static func sendAudioPlayedEvent(source: PlaybackSource, language: Common.Language, audio: AICAudioFileModel, artwork: AICObjectModel?, tour: AICTourModel?) {
let languageString: String = Common.stringForLanguage[language]!
var parameters: [String: String] = [
"playback_source": source.rawValue,
"playback_language": languageString,
"audio_title": audio.translations[.english]!.trackTitle.truncate(length: parameterMaxLength)
]
if let artworkModel: AICObjectModel = artwork {
parameters["title"] = artworkModel.title.truncate(length: parameterMaxLength)
}
if let tourModel: AICTourModel = tour {
parameters["tour_title"] = tourModel.translations[.english]!.title.truncate(length: parameterMaxLength)
}
trackEvent(.audioPlayed, parameters: parameters)
}
static func sendAudioStoppedEvent(title: String, audio: AICAudioFileModel, percentPlayed: Int) {
let percent = percentPlayed > 95 ? 100 : percentPlayed
let completion: PlaybackCompletion = percent == 100 ? .Completed : .Interrupted
let parameters: [String: String] = [
"title": title.truncate(length: parameterMaxLength),
"audio_title": audio.translations[.english]!.trackTitle.truncate(length: parameterMaxLength),
"completion": completion.rawValue,
"percent_played": String(percent)
]
trackEvent(.audioStopped, parameters: parameters)
}
// MARK: Audio Errors
static func sendErrorAudioGuideBadNumberEvent(number: Int) {
let parameters: [String: String] = [
"type": "Bad Number",
"code": String(number)
]
trackEvent(.audioError, parameters: parameters)
}
static func sendErrorAudioLoadFailEvent(number: Int) {
let parameters: [String: String] = [
"type": "Audio Load Fail",
"code": String(number)
]
trackEvent(.audioError, parameters: parameters)
}
// MARK: Tours
static func sendTourStartedEvent(tour: AICTourModel, language: Common.Language) {
let languageString: String = Common.stringForLanguage[language]!
let parameters: [String: String] = [
"title": tour.translations[.english]!.title.truncate(length: parameterMaxLength),
"tour_language": languageString
]
trackEvent(.tourStarted, parameters: parameters)
}
static func sendTourLeftEvent(tour: AICTourModel) {
let parameters: [String: String] = [
"title": tour.translations[.english]!.title.truncate(length: parameterMaxLength)
]
trackEvent(.tourLeft, parameters: parameters)
}
// MARK: Exhibitions
static func sendExhibitionViewedEvent(exhibition: AICExhibitionModel) {
let parameters: [String: String] = [
"title": exhibition.title.truncate(length: parameterMaxLength)
]
trackEvent(.exhibitionViewed, parameters: parameters)
}
static func sendExhibitionBuyLinkEvent(exhibition: AICExhibitionModel) {
let parameters: [String: String] = [
"title": exhibition.title.truncate(length: parameterMaxLength)
]
trackEvent(.exhibitionBuyLink, parameters: parameters)
}
static func sendExhibitionMapEvent(exhibition: AICExhibitionModel) {
let parameters: [String: String] = [
"title": exhibition.title.truncate(length: parameterMaxLength)
]
trackEvent(.exhibitionMap, parameters: parameters)
}
// MARK: Events
static func sendEventViewedEvent(event: AICEventModel) {
let parameters: [String: String] = [
"title": event.title.truncate(length: parameterMaxLength)
]
trackEvent(.eventViewed, parameters: parameters)
}
static func sendEventRegisterLinkEvent(event: AICEventModel) {
let parameters: [String: String] = [
"title": event.title.truncate(length: parameterMaxLength)
]
trackEvent(.eventRegisterLink, parameters: parameters)
}
// MARK: Members
static func sendMemberCardShownEvent() {
setUserProperty(property: .membership, value: "Member")
trackEvent(.memberCardShown)
}
// MARK: Misc Links
static func sendMiscLinkTappedEvent(link: MiscLink) {
let parameters: [String: String] = [
"link": link.rawValue
]
trackEvent(.miscLinkTapped, parameters: parameters)
}
// MARK: Search
static func sendSearchNoResultsEvent(searchTerm: String, searchTermSource: SearchTermSource) {
let parameters: [String: String] = [
"search_term": searchTerm.truncate(length: parameterMaxLength),
"search_term_source": searchTermSource.rawValue
]
trackEvent(.searchNoResults, parameters: parameters)
}
static func sendSearchAbandonedEvent(searchTerm: String, searchTermSource: SearchTermSource) {
let parameters: [String: String] = [
"search_term": searchTerm.truncate(length: parameterMaxLength),
"search_term_source": searchTermSource.rawValue
]
trackEvent(.searchAbandoned, parameters: parameters)
}
// MARK: Search Tapped Content
static func sendSearchTappedArtworkEvent(searchedArtwork: AICSearchedArtworkModel, searchTerm: String, searchTermSource: SearchTermSource) {
let parameters: [String: String] = [
"title": searchedArtwork.title.truncate(length: parameterMaxLength),
"search_term": searchTerm.truncate(length: parameterMaxLength),
"search_term_source": searchTermSource.rawValue
]
trackEvent(.searchTappedArtwork, parameters: parameters)
}
static func sendSearchTappedTourEvent(tour: AICTourModel, searchTerm: String, searchTermSource: SearchTermSource) {
let parameters: [String: String] = [
"title": tour.translations[.english]!.title.truncate(length: parameterMaxLength),
"search_term": searchTerm.truncate(length: parameterMaxLength),
"search_term_source": searchTermSource.rawValue
]
trackEvent(.searchTappedTour, parameters: parameters)
}
static func sendSearchTappedExhibitionEvent(exhibition: AICExhibitionModel, searchTerm: String, searchTermSource: SearchTermSource) {
let parameters: [String: String] = [
"title": exhibition.title.truncate(length: parameterMaxLength),
"search_term": searchTerm.truncate(length: parameterMaxLength),
"search_term_source": searchTermSource.rawValue
]
trackEvent(.searchTappedExhibition, parameters: parameters)
}
// MARK: Search Facilities
static func sendSearchFacilitiesEvent(facility: Facility) {
let parameters: [String: String] = [
"facility": facility.rawValue
]
trackEvent(.searchFacilities, parameters: parameters)
}
// MARK: Search Artwork Map
static func sendSearchArtworkMapEvent(searchedArtwork: AICSearchedArtworkModel) {
let parameters: [String: String] = [
"title": searchedArtwork.title.truncate(length: parameterMaxLength)
]
trackEvent(.searchArtworkMap, parameters: parameters)
}
// MARK: Search Icon Map
static func sendSearchIconMapEvent(artwork: AICObjectModel) {
let parameters: [String: String] = [
"title": artwork.title.truncate(length: parameterMaxLength)
]
trackEvent(.searchIconMap, parameters: parameters)
}
}