-
Notifications
You must be signed in to change notification settings - Fork 50
/
AnalyticsHelper.m
326 lines (266 loc) · 9.92 KB
/
AnalyticsHelper.m
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
//
// Copyright (c) 2020 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
@import FirebaseAnalytics;
#import "AnalyticsHelper.h"
// Importing simulated 3rd party ad_impressions to ensure this project compiles. Not required to implement Firebase ad_impression tracking
#import "MAAd.h"
#import "ISImpressionData.h"
@implementation AnalyticsHelper
- (void)logInAppPurchase {
// [START ecommerce_purchase]
[FIRAnalytics logEventWithName:kFIREventPurchase
parameters:@{
kFIRParameterCoupon: @"SummerPromo",
kFIRParameterCurrency: @"JPY",
kFIRParameterValue: @10000,
kFIRParameterShipping: @500,
kFIRParameterTransactionID: @"192803301",
}];
// [END ecommerce_purchase]
}
- (void)enhancedEcommerce {
// Implementation
// [START create_items]
// A pair of jeggings
NSMutableDictionary *jeggings = [@{
kFIRParameterItemID: @"SKU_123",
kFIRParameterItemName: @"jeggings",
kFIRParameterItemCategory: @"pants",
kFIRParameterItemVariant: @"black",
kFIRParameterItemBrand: @"Google",
kFIRParameterPrice: @9.99,
} mutableCopy];
// A pair of boots
NSMutableDictionary *boots = [@{
kFIRParameterItemID: @"SKU_456",
kFIRParameterItemName: @"boots",
kFIRParameterItemCategory: @"shoes",
kFIRParameterItemVariant: @"brown",
kFIRParameterItemBrand: @"Google",
kFIRParameterPrice: @24.99,
} mutableCopy];
// A pair of socks
NSMutableDictionary *socks = [@{
kFIRParameterItemID: @"SKU_789",
kFIRParameterItemName: @"ankle_socks",
kFIRParameterItemCategory: @"socks",
kFIRParameterItemVariant: @"red",
kFIRParameterItemBrand: @"Google",
kFIRParameterPrice: @5.99,
} mutableCopy];
// [END create_items]
// Selecting a product from a list
// [START view_item_list]
// Add item indexes
jeggings[kFIRParameterIndex] = @1;
boots[kFIRParameterIndex] = @2;
socks[kFIRParameterIndex] = @3;
// Prepare ecommerce parameters
NSMutableDictionary *itemList = [@{
kFIRParameterItemListID: @"L001",
kFIRParameterItemListName: @"Related products",
} mutableCopy];
// Add items array
itemList[kFIRParameterItems] = @[jeggings, boots, socks];
// Log view item list event
[FIRAnalytics logEventWithName:kFIREventViewItemList parameters:itemList];
// [END view_item_list]
// [START select_item]
// Prepare ecommerce parameters
NSMutableDictionary *selectedItem = [@{
kFIRParameterItemListID: @"L001",
kFIRParameterItemListName: @"Related products",
} mutableCopy];
// Add items array
selectedItem[kFIRParameterItems] = @[jeggings];
// Log select item event
[FIRAnalytics logEventWithName:kFIREventSelectItem parameters:selectedItem];
// [END select_item]
// Viewing product details
// [START view_product_details]
// Prepare ecommerce parameters
NSMutableDictionary *productDetails = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @9.99
} mutableCopy];
// Add items array
productDetails[kFIRParameterItems] = @[jeggings];
// Log view item event
[FIRAnalytics logEventWithName:kFIREventViewItem parameters:productDetails];
// [END view_product_details]
// Adding/Removing a product from shopping cart
// [START add_to_cart_wishlist]
// Specify order quantity
jeggings[kFIRParameterQuantity] = @2;
// Prepare item detail params
NSMutableDictionary *itemDetails = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @19.98
} mutableCopy];
// Add items
itemDetails[kFIRParameterItems] = @[jeggings];
// Log an event when product is added to wishlist
[FIRAnalytics logEventWithName:kFIREventAddToWishlist parameters:itemDetails];
// Log an event when product is added to cart
[FIRAnalytics logEventWithName:kFIREventAddToCart parameters:itemDetails];
// [END add_to_cart_wishlist]
// [START view_cart]
// Specify order quantity
jeggings[kFIRParameterQuantity] = @2;
boots[kFIRParameterQuantity] = @1;
// Prepare order parameters
NSMutableDictionary *orderParameters = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @44.97
} mutableCopy];
// Add items array
orderParameters[kFIRParameterItems] = @[jeggings, boots];
// Log event when cart is viewed
[FIRAnalytics logEventWithName:kFIREventViewCart parameters:orderParameters];
// [END view_cart]
// [START remove_from_cart]
// Specify removal quantity
boots[kFIRParameterQuantity] = @1;
// Prepare params
NSMutableDictionary *removeParams = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @24.99
} mutableCopy];
// Add items
removeParams[kFIRParameterItems] = @[boots];
// Log removal event
[FIRAnalytics logEventWithName:kFIREventRemoveFromCart parameters:removeParams];
// [END remove_from_cart]
// Initiating the checkout process
// [START start_checkout]
// Prepare checkout params
NSMutableDictionary *checkoutParams = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @14.98,
kFIRParameterCoupon: @"SUMMER_FUN"
} mutableCopy];
// Add items
checkoutParams[kFIRParameterItems] = @[jeggings];
// Log checkout event
[FIRAnalytics logEventWithName:kFIREventBeginCheckout parameters:checkoutParams];
// [END start_checkout]
// [START add_shipping]
// Prepare shipping params
NSMutableDictionary *shippingParams = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @14.98,
kFIRParameterCoupon: @"SUMMER_FUN",
kFIRParameterShippingTier: @"Ground"
} mutableCopy];
// Add items
shippingParams[kFIRParameterItems] = @[jeggings];
// Log added shipping info event
[FIRAnalytics logEventWithName:kFIREventAddShippingInfo parameters:shippingParams];
// [END add_shipping]
// [START add_payment]
// Prepare payment params
NSMutableDictionary *paymentParams = [@{
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @14.98,
kFIRParameterCoupon: @"SUMMER_FUN",
kFIRParameterPaymentType: @"Visa"
} mutableCopy];
// Add items
paymentParams[kFIRParameterItems] = @[jeggings];
// Log added payment info event
[FIRAnalytics logEventWithName:kFIREventAddPaymentInfo parameters:paymentParams];
// [END add_payment]
// Making a purchase or issuing a refund
// [START log_purchase]
// Prepare purchase params
NSMutableDictionary *purchaseParams = [@{
kFIRParameterTransactionID: @"T12345",
kFIRParameterAffiliation: @"Google Store",
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @14.98,
kFIRParameterTax: @2.58,
kFIRParameterShipping: @5.34,
kFIRParameterCoupon: @"SUMMER_FUN"
} mutableCopy];
// Add items
purchaseParams[kFIRParameterItems] = @[jeggings];
// Log purchase event
[FIRAnalytics logEventWithName:kFIREventPurchase parameters:purchaseParams];
// [END log_purchase]
// [START log_refund]
// Prepare refund params
NSMutableDictionary *refundParams = [@{
kFIRParameterTransactionID: @"T12345",
kFIRParameterCurrency: @"USD",
kFIRParameterValue: @9.99,
} mutableCopy];
// (Optional) for partial refunds, define the item ID and quantity of refunded items
NSDictionary *refundedProduct = @{
kFIRParameterItemID: @"SKU_123",
kFIRParameterQuantity: @1,
};
// Add items
refundParams[kFIRParameterItems] = @[refundedProduct];
// Log refund event
[FIRAnalytics logEventWithName:kFIREventRefund parameters:refundParams];
// [END log_refund]
// Applying promotions
// [START apply_promo]
// Prepare promotion parameters
NSMutableDictionary *promoParams = [@{
kFIRParameterPromotionID: @"T12345",
kFIRParameterPromotionName: @"Summer Sale",
kFIRParameterCreativeName: @"summer2020_promo.jpg",
kFIRParameterCreativeSlot: @"featured_app_1",
kFIRParameterLocationID: @"HERO_BANNER",
} mutableCopy];
// Add items
promoParams[kFIRParameterItems] = @[jeggings];
// Log event when promotion is displayed
[FIRAnalytics logEventWithName:kFIREventViewPromotion parameters:promoParams];
// Log event when promotion is selected
[FIRAnalytics logEventWithName:kFIREventSelectPromotion parameters:promoParams];
// [END apply_promo]
}
// MARK: ad_impression
// Log ad_impression for sharing advertising impression data.
// [START log_ad_impression_applovin]
- (void)didPayRevenueForAd:(MAAd *)impressionData {
[FIRAnalytics logEventWithName:kFIREventAdImpression
parameters: @{
kFIRParameterAdPlatform: @"AppLovin",
kFIRParameterAdSource: impressionData.networkName,
kFIRParameterAdFormat: impressionData.format,
kFIRParameterAdUnitName: impressionData.adUnitIdentifier,
kFIRParameterCurrency: @"USD", // All Applovin revenue is sent in USD
kFIRParameterValue: impressionData.revenue
}];
}
// [END log_ad_impression_applovin]
// [START log_ad_impression_ironsource]
- (void)impressionDataDidSucceed:(ISImpressionData *)impressionData {
[FIRAnalytics logEventWithName:kFIREventAdImpression
parameters:@{
kFIRParameterAdPlatform: @"ironSource",
kFIRParameterAdSource: impressionData.ad_network,
kFIRParameterAdFormat: impressionData.ad_unit,
kFIRParameterAdUnitName: impressionData.instance_name,
kFIRParameterCurrency: @"USD",
kFIRParameterValue: impressionData.revenue
}];
}
// [END log_ad_impression_ironsource]
@end