AppsFlyer.cs
17.6 KB
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
using System.Collections.Generic;
using UnityEngine;
namespace AppsFlyerSDK
{
public class AppsFlyer : MonoBehaviour
{
public static readonly string kAppsFlyerPluginVersion = "5.4.2";
/// <summary>
/// Initialize the AppsFlyer SDK with your devKey and appID.
/// The dev key is required on all platforms, and the appID is required for iOS.
/// If you app is for Android only pass null for the appID.
/// </summary>
/// <param name="devKey"> AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account under 'App Settings' in the dashboard.</param>
/// <param name="appID">Your app's Apple ID.</param>
/// <example>
/// <code>
/// AppsFlyer.initSDK("K2***********99", "41*****44"");
/// </code>
/// </example>
public static void initSDK(string devKey, string appID)
{
initSDK(devKey, appID, null);
}
/// <summary>
/// Initialize the AppsFlyer SDK with your devKey and appID.
/// The dev key is required on all platforms, and the appID is required for iOS.
/// If you app is for Android only pass null for the appID.
/// </summary>
/// <param name="devKey"> AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account under 'App Settings' in the dashboard.</param>
/// <param name="appID">Your app's Apple ID.</param>
/// <param name="gameObject">pass the script of the game object being used.</param>
/// <example>
/// <code>
/// AppsFlyer.initSDK("K2***********99", 41*****44, this);
/// </code>
/// </example>
public static void initSDK(string devKey, string appID, MonoBehaviour gameObject)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setAppsFlyerDevKey(devKey);
AppsFlyeriOS.setAppleAppID(appID);
if(gameObject != null)
{
AppsFlyeriOS.getConversionData(gameObject.name);
}
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.initSDK(devKey, gameObject);
#else
#endif
}
/// <summary>
/// Once this API is invoked, our SDK will start.
/// Once the API is called a sessions will be immediately sent, and all background forground transitions will send a session.
/// </summary>
public static void startSDK()
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.startSDK();
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.startSDK();
#else
#endif
}
/// <summary>
/// Send an In-App Event.
/// In-App Events provide insight on what is happening in your app.
/// </summary>
/// <param name="eventName">Event Name as String.</param>
/// <param name="eventValues">Event Values as Dictionary.</param>
public static void sendEvent(string eventName, Dictionary<string, string> eventValues)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.sendEvent(eventName, eventValues);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.sendEvent(eventName, eventValues);
#else
#endif
}
/// <summary>
/// Once this API is invoked, our SDK no longer communicates with our servers and stops functioning.
/// In some extreme cases you might want to shut down all SDK activity due to legal and privacy compliance.
/// This can be achieved with the stopSDK API.
/// </summary>
/// <param name="isSDKStopped"> should sdk be stopped.</param>
public static void stopSDK(bool isSDKStopped)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.stopSDK(isSDKStopped);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.stopSDK(isSDKStopped);
#else
#endif
}
// <summary>
/// Was the stopSDK(boolean) API set to true.
/// </summary>
/// <returns>boolean isSDKStopped.</returns>
public static bool isSDKStopped()
{
#if UNITY_IOS && !UNITY_EDITOR
return AppsFlyeriOS.isSDKStopped();
#elif UNITY_ANDROID && !UNITY_EDITOR
return AppsFlyerAndroid.isSDKStopped();
#else
return false;
#endif
}
/// <summary>
/// Get the AppsFlyer SDK version used in app.
/// </summary>
/// <returns>The current SDK version.</returns>
public static string getSdkVersion()
{
#if UNITY_IOS && !UNITY_EDITOR
return AppsFlyeriOS.getSDKVersion();
#elif UNITY_ANDROID && !UNITY_EDITOR
return AppsFlyerAndroid.getSdkVersion();
#else
return "";
#endif
}
/// <summary>
/// Enables Debug logs for the AppsFlyer SDK.
/// Should only be set to true in development / debug.
/// </summary>
/// <param name="shouldEnable">shouldEnable boolean.</param>
public static void setIsDebug(bool shouldEnable)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setIsDebug(shouldEnable);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setIsDebug(shouldEnable);
#else
#endif
}
/// <summary>
/// Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs.
/// This ID is available in AppsFlyer CSV reports along with Postback APIs for cross-referencing with your internal IDs.
/// </summary>
/// <param name="id">Customer ID for client.</param>
public static void setCustomerUserId(string id)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setCustomerUserID(id);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setCustomerUserId(id);
#else
#endif
}
/// <summary>
/// Set the OneLink ID that should be used for User-Invite-API.
/// The link that is generated for the user invite will use this OneLink as the base link.
/// </summary>
/// <param name="oneLinkId">OneLink ID obtained from the AppsFlyer Dashboard.</param>
public static void setAppInviteOneLinkID(string oneLinkId)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setAppInviteOneLinkID(oneLinkId);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setAppInviteOneLinkID(oneLinkId);
#else
#endif
}
/// <summary>
/// Set additional data to be sent to AppsFlyer.
/// </summary>
/// <param name="customData">additional data Dictionary.</param>
public static void setAdditionalData(Dictionary<string, string> customData)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setAdditionalData(customData);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setAdditionalData(customData);
#else
#endif
}
/// <summary>
/// Advertisers can wrap AppsFlyer OneLink within another Universal Link.
/// This Universal Link will invoke the app but any deep linking data will not propagate to AppsFlyer.
/// </summary>
/// <param name="urls">Array of urls.</param>
public static void setResolveDeepLinkURLs(params string[] urls)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setResolveDeepLinkURLs(urls);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setResolveDeepLinkURLs(urls);
#else
#endif
}
/// <summary>
/// Advertisers can use this method to set vanity onelink domains.
/// </summary>
/// <param name="domains">Array of domains.</param>
public static void setOneLinkCustomDomain(params string[] domains)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setOneLinkCustomDomains(domains);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setOneLinkCustomDomain(domains);
#else
#endif
}
/// <summary>
/// Setting user local currency code for in-app purchases.
/// The currency code should be a 3 character ISO 4217 code. (default is USD).
/// You can set the currency code for all events by calling the following method.
/// </summary>
/// <param name="currencyCode">3 character ISO 4217 code.</param>
public static void setCurrencyCode(string currencyCode)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setCurrencyCode(currencyCode);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setCurrencyCode(currencyCode);
#else
#endif
}
/// <summary>
/// Manually record the location of the user.
/// </summary>
/// <param name="latitude">latitude as double.</param>
/// <param name="longitude">longitude as double.</param>
public static void recordLocation(double latitude, double longitude)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.recordLocation(latitude, longitude);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.recordLocation(latitude, longitude);
#else
#endif
}
/// <summary>
/// Anonymize user Data.
/// Use this API during the SDK Initialization to explicitly anonymize a user's installs, events and sessions.
/// Default is false.
/// </summary>
/// <param name = "shouldAnonymizeUser" >shouldAnonymizeUser boolean.</param>
public static void anonymizeUser(bool shouldAnonymizeUser)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.anonymizeUser(shouldAnonymizeUser);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.anonymizeUser(shouldAnonymizeUser);
#else
#endif
}
/// <summary>
/// Get AppsFlyer's unique device ID which is created for every new install of an app.
/// </summary>
/// <returns>AppsFlyer's unique device ID.</returns>
public static string getAppsFlyerId()
{
#if UNITY_IOS && !UNITY_EDITOR
return AppsFlyeriOS.getAppsFlyerId();
#elif UNITY_ANDROID && !UNITY_EDITOR
return AppsFlyerAndroid.getAppsFlyerId();
#else
return "";
#endif
}
/// <summary>
/// Set a custom value for the minimum required time between sessions.
/// By default, at least 5 seconds must lapse between 2 app launches to count as separate 2 sessions.
/// </summary>
/// <param name="seconds">minimum time between 2 separate sessions in seconds.</param>
public static void setMinTimeBetweenSessions(int seconds)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setMinTimeBetweenSessions(seconds);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setMinTimeBetweenSessions(seconds);
#else
#endif
}
/// <summary>
/// Set a custom host.
/// </summary>
/// <param name="hostPrefixName">Host prefix.</param>
/// <param name="hostName">Host name.</param>
public static void setHost(string hostPrefixName, string hostName)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setHost(hostName, hostPrefixName);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setHost(hostPrefixName, hostName);
#else
#endif
}
/// <summary>
/// Set the user emails and encrypt them.
/// cryptMethod Encryption method:
/// EmailCryptType.EmailCryptTypeMD5
/// EmailCryptType.EmailCryptTypeSHA1
/// EmailCryptType.EmailCryptTypeSHA256
/// EmailCryptType.EmailCryptTypeNone
/// </summary>
/// <param name="cryptMethod">Encryption method.</param>
/// <param name="emails">User emails.</param>
public static void setUserEmails(EmailCryptType cryptMethod, params string[] emails)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setUserEmails(cryptMethod, emails.Length, emails);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setUserEmails(cryptMethod, emails);
#else
#endif
}
/// <summary>
/// Set the user phone number.
/// </summary>
/// <param name="phoneNumber">phoneNumber string</param>
public static void setPhoneNumber(string phoneNumber)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setPhoneNumber(phoneNumber);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setPhoneNumber(phoneNumber);
#else
#endif
}
/// <summary>
/// Used by advertisers to exclude all networks/integrated partners from getting data.
/// </summary>
public static void setSharingFilterForAllPartners()
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setSharingFilterForAllPartners();
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setSharingFilterForAllPartners();
#else
#endif
}
/// <summary>
/// Used by advertisers to set some (one or more) networks/integrated partners to exclude from getting data.
/// </summary>
/// <param name="partners">partners to exclude from getting data</param>
public static void setSharingFilter(params string[] partners)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setSharingFilter(partners);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setSharingFilter(partners);
#else
#endif
}
/// <summary>
/// Register a Conversion Data Listener.
/// Allows the developer to access the user attribution data in real-time for every new install, directly from the SDK level.
/// By doing this you can serve users with personalized content or send them to specific activities within the app,
/// which can greatly enhance their engagement with your app.
/// </summary>
/// <example>
/// <code>
/// AppsFlyer.getConversionData(this.name);
/// </code>
/// </example>
public static void getConversionData(string objectName)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.getConversionData(objectName);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.getConversionData(objectName);
#else
#endif
}
/// <summary>
/// Use the following API to attribute the click and launch the app store's app page.
/// </summary>
/// <param name="appID">promoted App ID</param>
/// <param name="campaign">cross promotion campaign</param>
/// <param name="userParams">additional user params</param>
/// <example>
/// <code>
/// Dictionary<string, string> parameters = new Dictionary<string, string>();
/// parameters.Add("af_sub1", "val");
/// parameters.Add("custom_param", "val2");
/// AppsFlyer.attributeAndOpenStore("123456789", "test campaign", parameters, this);
/// </code>
/// </example>
public static void attributeAndOpenStore(string appID, string campaign, Dictionary<string, string> userParams, MonoBehaviour gameObject)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.attributeAndOpenStore(appID, campaign, userParams, gameObject);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.attributeAndOpenStore(appID, campaign, userParams);
#else
#endif
}
/// <summary>
/// To attribute an impression use the following API call.
/// Make sure to use the promoted App ID as it appears within the AppsFlyer dashboard.
/// </summary>
/// <param name="appID">promoted App ID.</param>
/// <param name="campaign">cross promotion campaign.</param>
/// <param name="parameters">parameters Dictionary.</param>
public static void recordCrossPromoteImpression(string appID, string campaign, Dictionary<string, string> parameters)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.recordCrossPromoteImpression(appID, campaign, parameters);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.recordCrossPromoteImpression(appID, campaign, parameters);
#else
#endif
}
/// <summary>
/// The LinkGenerator class builds the invite URL according to various setter methods which allow passing on additional information on the click.
/// See - https://support.appsflyer.com/hc/en-us/articles/115004480866-User-invite-attribution-
/// </summary>
/// <param name="parameters">parameters Dictionary.</param>
public static void generateUserInviteLink(Dictionary<string, string> parameters, MonoBehaviour gameObject)
{
#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.generateUserInviteLink(parameters, gameObject);
#elif UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.generateUserInviteLink(parameters, gameObject);
#else
#endif
}
/// <summary>
/// Helper method to convert json strings to dictionary.
/// </summary>
/// <param name="str">json string</param>
/// <returns>dictionary representing the input json string.</returns>
public static Dictionary<string, object> CallbackStringToDictionary(string str)
{
return AFMiniJSON.Json.Deserialize(str) as Dictionary<string, object>;
}
/// <summary>
/// Helper method to log AppsFlyer events and callbacks.
/// </summary>
/// <param name="methodName">method name</param>
/// <param name="str">message to log</param>
public static void AFLog(string methodName, string str)
{
Debug.Log(string.Format("AppsFlyer_Unity_v{0} {1} called with {2}", kAppsFlyerPluginVersion, methodName, str));
}
}
public enum EmailCryptType
{
// None
EmailCryptTypeNone = 0,
// SHA256
EmailCryptTypeSHA256 = 1,
}
}