AppsFlyeriOS.cs
22.5 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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
using System.Collections.Generic;
using System.Runtime.InteropServices;
using UnityEngine;
namespace AppsFlyerSDK
{
#if UNITY_IOS
public class AppsFlyeriOS
{
/// <summary>
/// Start Session.
/// This will record a session and then record all background forground sessions during the lifecycle of the app.
/// </summary>
public static void startSDK()
{
#if !UNITY_EDITOR
_startSDK();
#endif
}
/// <summary>
/// Send an In-App Event.
/// In-App Events provide insight on what is happening in your app.
/// </summary>
/// <param name="eventName">Name of event.</param>
/// <param name="eventValues">Contains dictionary of values for handling by backend.</param>
public static void sendEvent(string eventName, Dictionary<string, string> eventValues)
{
#if !UNITY_EDITOR
_afSendEvent(eventName, AFMiniJSON.Json.Serialize(eventValues));
#endif
}
/// <summary>
/// Get the conversion data.
/// 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>
public static void getConversionData(string objectName)
{
#if !UNITY_EDITOR
_getConversionData(objectName);
#endif
}
/// <summary>
/// In case you use your own user ID in your app, you can set this property to that ID.
/// Enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs.
/// </summary>
/// <param name="customerUserID">Customer ID for client.</param>
public static void setCustomerUserID(string customerUserID)
{
#if !UNITY_EDITOR
_setCustomerUserID(customerUserID);
#endif
}
/// <summary>
/// In case you use custom data and you want to receive it in the raw reports.
/// see [Setting additional custom data] (https://support.appsflyer.com/hc/en-us/articles/207032066-AppsFlyer-SDK-Integration-iOS#setting-additional-custom-data) for more information.
/// </summary>
/// <param name="customData">additional data Dictionary.</param>
public static void setAdditionalData(Dictionary<string, string> customData)
{
#if !UNITY_EDITOR
_setAdditionalData(AFMiniJSON.Json.Serialize(customData));
#endif
}
/// <summary>
/// Use this method to set your AppsFlyer's dev key.
/// </summary>
/// <param name="appsFlyerDevKey">AppsFlyer's Dev-Key, which is accessible from your AppsFlyer account under 'App Settings' in the dashboard.</param>
public static void setAppsFlyerDevKey(string appsFlyerDevKey)
{
#if !UNITY_EDITOR
_setAppsFlyerDevKey(appsFlyerDevKey);
#endif
}
/// <summary>
/// Use this method to set your app's Apple ID(taken from the app's page on iTunes Connect).
/// </summary>
/// <param name="appleAppID">your app's Apple ID.</param>
public static void setAppleAppID(string appleAppID)
{
#if !UNITY_EDITOR
_setAppleAppID(appleAppID);
#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_EDITOR
_setCurrencyCode(currencyCode);
#endif
}
/// <summary>
/// AppsFlyer SDK collect Apple's `advertisingIdentifier` if the `AdSupport.framework` included in the SDK.
/// You can disable this behavior by setting the following property to true.
/// </summary>
/// <param name="disableCollectAppleAdSupport">boolean to disableCollectAppleAdSupport</param>
public static void setDisableCollectAppleAdSupport(bool disableCollectAppleAdSupport)
{
#if !UNITY_EDITOR
_setDisableCollectAppleAdSupport(disableCollectAppleAdSupport);
#endif
}
/// <summary>
/// Enables Debug logs for the AppsFlyer SDK.
/// Should only be set to true in development / debug.
/// The default value is false.
/// </summary>
/// <param name="isDebug">shouldEnable boolean..</param>
public static void setIsDebug(bool isDebug)
{
#if !UNITY_EDITOR
_setIsDebug(isDebug);
#endif
}
/// <summary>
/// Set this flag to true, to collect the current device name(e.g. "My iPhone"). Default value is false.
/// </summary>
/// <param name="shouldCollectDeviceName">boolean shouldCollectDeviceName.</param>
public static void setShouldCollectDeviceName(bool shouldCollectDeviceName)
{
#if !UNITY_EDITOR
_setShouldCollectDeviceName(shouldCollectDeviceName);
#endif
}
/// <summary>
/// Set the OneLink ID that should be used for User-Invites.
/// The link that is generated for the user invite will use this OneLink as the base link.
/// </summary>
/// <param name="appInviteOneLinkID">OneLink ID obtained from the AppsFlyer Dashboard.</param>
public static void setAppInviteOneLinkID(string appInviteOneLinkID)
{
#if !UNITY_EDITOR
_setAppInviteOneLinkID(appInviteOneLinkID);
#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">boolean shouldAnonymizeUser.</param>
public static void anonymizeUser(bool shouldAnonymizeUser)
{
#if !UNITY_EDITOR
_anonymizeUser(shouldAnonymizeUser);
#endif
}
/// <summary>
/// Opt-out for Apple Search Ads attributions.
/// </summary>
/// <param name="disableCollectIAd">boolean disableCollectIAd.</param>
public static void setDisableCollectIAd(bool disableCollectIAd)
{
#if !UNITY_EDITOR
_setDisableCollectIAd(disableCollectIAd);
#endif
}
/// <summary>
/// In app purchase receipt validation Apple environment(production or sandbox). The default value is false.
/// </summary>
/// <param name="useReceiptValidationSandbox">boolean useReceiptValidationSandbox.</param>
public static void setUseReceiptValidationSandbox(bool useReceiptValidationSandbox)
{
#if !UNITY_EDITOR
_setUseReceiptValidationSandbox(useReceiptValidationSandbox);
#endif
}
/// <summary>
/// Set this flag to test uninstall on Apple environment(production or sandbox). The default value is false.
/// </summary>
/// <param name="useUninstallSandbox">boolean useUninstallSandbox.</param>
public static void setUseUninstallSandbox(bool useUninstallSandbox)
{
#if !UNITY_EDITOR
_setUseUninstallSandbox(useUninstallSandbox);
#endif
}
/// <summary>
/// For advertisers who wrap OneLink within another Universal Link.
/// An advertiser will be able to deeplink from a OneLink wrapped within another Universal Link and also record this retargeting conversion.
/// </summary>
/// <param name="resolveDeepLinkURLs">Array of urls.</param>
public static void setResolveDeepLinkURLs(params string[] resolveDeepLinkURLs)
{
#if !UNITY_EDITOR
_setResolveDeepLinkURLs(resolveDeepLinkURLs.Length,resolveDeepLinkURLs);
#endif
}
/// <summary>
/// For advertisers who use vanity OneLinks.
/// </summary>
/// <param name="oneLinkCustomDomains">Array of domains.</param>
public static void setOneLinkCustomDomains(params string[] oneLinkCustomDomains)
{
#if !UNITY_EDITOR
_setOneLinkCustomDomains(oneLinkCustomDomains.Length, oneLinkCustomDomains);
#endif
}
/// <summary>
/// Set the user emails and encrypt them.
/// cryptMethod Encryption method:
/// EmailCryptType.EmailCryptTypeMD5
/// EmailCryptType.EmailCryptTypeSHA1
/// EmailCryptType.EmailCryptTypeSHA256
/// EmailCryptType.EmailCryptTypeNone
/// </summary>
/// <param name="cryptType">type Hash algoritm.</param>
/// <param name="length">length of userEmails array.</param>
/// <param name="userEmails">userEmails The list of strings that hold mails.</param>
public static void setUserEmails(EmailCryptType cryptType, int length, params string[] userEmails)
{
#if !UNITY_EDITOR
_setUserEmails(cryptType, length, userEmails);
#endif
}
/// <summary>
/// Set the user phone number.
/// </summary>
/// <param name="phoneNumber">User phoneNumber.</param>
public static void setPhoneNumber(string phoneNumber){
#if !UNITY_EDITOR
_setPhoneNumber(phoneNumber);
#endif
}
/// <summary>
/// To send and validate in app purchases you can call this method from the processPurchase method.
/// </summary>
/// <param name="productIdentifier">The product identifier.</param>
/// <param name="price">The product price.</param>
/// <param name="currency">The product currency.</param>
/// <param name="tranactionId">The purchase transaction Id.</param>
/// <param name="additionalParameters">The additional param, which you want to receive it in the raw reports.</param>
public static void validateAndSendInAppPurchase(string productIdentifier, string price, string currency, string tranactionId, Dictionary<string, string> additionalParameters, MonoBehaviour gameObject)
{
#if !UNITY_EDITOR
_validateAndSendInAppPurchase(productIdentifier, price, currency, tranactionId, AFMiniJSON.Json.Serialize(additionalParameters), gameObject ? gameObject.name : null);
#endif
}
/// <summary>
/// To record location for geo-fencing. Does the same as code below.
/// </summary>
/// <param name="longitude">The location longitude.</param>
/// <param name="latitude">The location latitude.</param>
public static void recordLocation(double longitude, double latitude)
{
#if !UNITY_EDITOR
_recordLocation(longitude, latitude);
#endif
}
/// <summary>
/// Get AppsFlyer's unique device ID, which is created for every new install of an app.
/// </summary>
public static string getAppsFlyerId()
{
#if !UNITY_EDITOR
return _getAppsFlyerId();
#else
return "";
#endif
}
/// <summary>
/// Register uninstall - you should register for remote notification and provide AppsFlyer the push device token.
/// </summary>
/// <param name="deviceToken">deviceToken The `deviceToken` from `-application:didRegisterForRemoteNotificationsWithDeviceToken:`.</param>
public static void registerUninstall(byte[] deviceToken)
{
#if !UNITY_EDITOR
_registerUninstall(deviceToken);
#endif
}
/// <summary>
/// Enable AppsFlyer to handle a push notification.
/// </summary>
/// <param name="pushPayload">pushPayload The `userInfo` from received remote notification. One of root keys should be @"af"..</param>
public static void handlePushNotification(Dictionary<string, string> pushPayload)
{
#if !UNITY_EDITOR
_handlePushNotification(AFMiniJSON.Json.Serialize(pushPayload));
#endif
}
/// <summary>
/// Get SDK version.
/// </summary>
public static string getSDKVersion()
{
#if !UNITY_EDITOR
return _getSDKVersion();
#else
return "";
#endif
}
/// <summary>
/// This property accepts a string value representing the host name for all endpoints.
/// Can be used to Zero rate your application’s data usage.Contact your CSM for more information.
/// </summary>
/// <param name="host">Host Name.</param>
/// <param name="host">Host prefix.</param>
public static void setHost(string host, string hostPrefix)
{
#if !UNITY_EDITOR
_setHost(host, hostPrefix);
#endif
}
/// <summary>
/// This property is responsible for timeout between sessions in seconds.
/// Default value is 5 seconds.
/// </summary>
/// <param name="minTimeBetweenSessions">minimum time between 2 separate sessions in seconds.</param>
public static void setMinTimeBetweenSessions(int minTimeBetweenSessions)
{
#if !UNITY_EDITOR
_setMinTimeBetweenSessions(minTimeBetweenSessions);
#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">boolean isSDKStopped.</param>
public static void stopSDK(bool isSDKStopped)
{
#if !UNITY_EDITOR
_stopSDK(isSDKStopped);
#endif
}
// <summary>
/// Was the stopSDK(boolean) API set to true.
/// </summary>
/// <returns>boolean isSDKStopped.</returns>
public static bool isSDKStopped()
{
#if !UNITY_EDITOR
return _isSDKStopped();
#else
return false;
#endif
}
/// <summary>
/// In case you want to track deep linking manually call handleOpenUrl.
/// The continueUserActivity and onOpenURL are implemented in the AppsFlyerAppController.mm class, so
/// only use this method if the other methods do not cover your apps deeplinking needs.
/// </summary>
/// <param name="url">The URL to be passed to your AppDelegate.</param>
/// <param name="sourceApplication">The sourceApplication to be passed to your AppDelegate.</param>
/// <param name="annotation">The annotation to be passed to your app delegate.</param>
public static void handleOpenUrl(string url, string sourceApplication, string annotation)
{
#if !UNITY_EDITOR
_handleOpenUrl(url, sourceApplication, annotation);
#endif
}
/// <summary>
/// Used by advertisers to exclude all networks/integrated partners from getting data.
/// </summary>
public static void setSharingFilterForAllPartners()
{
#if !UNITY_EDITOR
_setSharingFilterForAllPartners();
#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_EDITOR
_setSharingFilter(partners.Length, partners);
#endif
}
/// <summary>
/// To record 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_EDITOR
_recordCrossPromoteImpression(appID, campaign, AFMiniJSON.Json.Serialize(parameters));
#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="parameters">additional user params</param>
public static void attributeAndOpenStore(string appID, string campaign, Dictionary<string, string> parameters, MonoBehaviour gameObject)
{
#if !UNITY_EDITOR
_attributeAndOpenStore(appID, campaign, AFMiniJSON.Json.Serialize(parameters), gameObject ? gameObject.name : null);
#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_EDITOR
_generateUserInviteLink(AFMiniJSON.Json.Serialize(parameters), gameObject ? gameObject.name : null);
#endif
}
/// <summary>
/// It is recommended to generate an in-app event after the invite is sent to record the invites from the senders' perspective.
/// This enables you to find the users that tend most to invite friends, and the media sources that get you these users.
/// </summary>
/// <param name="channel">channel string.</param>
/// <param name="parameters">parameters Dictionary..</param>
public static void recordInvite(string channel, Dictionary<string, string> parameters)
{
#if !UNITY_EDITOR
_recordInvite(channel, AFMiniJSON.Json.Serialize(parameters));
#endif
}
/*
* AppsFlyer ios method mapping
*/
[DllImport("__Internal")]
private static extern void _startSDK();
[DllImport("__Internal")]
private static extern void _getConversionData(string objectName);
[DllImport("__Internal")]
private static extern void _setCustomerUserID(string customerUserID);
[DllImport("__Internal")]
private static extern void _setAdditionalData(string customData);
[DllImport("__Internal")]
private static extern void _setAppsFlyerDevKey(string appsFlyerDevKey);
[DllImport("__Internal")]
private static extern void _setAppleAppID(string appleAppID);
[DllImport("__Internal")]
private static extern void _setCurrencyCode(string currencyCode);
[DllImport("__Internal")]
private static extern void _setDisableCollectAppleAdSupport(bool disableCollectAppleAdSupport);
[DllImport("__Internal")]
private static extern void _setIsDebug(bool isDebug);
[DllImport("__Internal")]
private static extern void _setShouldCollectDeviceName(bool shouldCollectDeviceName);
[DllImport("__Internal")]
private static extern void _setAppInviteOneLinkID(string appInviteOneLinkID);
[DllImport("__Internal")]
private static extern void _anonymizeUser(bool shouldAnonymizeUser);
[DllImport("__Internal")]
private static extern void _setDisableCollectIAd(bool disableCollectIAd);
[DllImport("__Internal")]
private static extern void _setUseReceiptValidationSandbox(bool useReceiptValidationSandbox);
[DllImport("__Internal")]
private static extern void _setUseUninstallSandbox(bool useUninstallSandbox);
[DllImport("__Internal")]
private static extern void _setResolveDeepLinkURLs(int length, params string[] resolveDeepLinkURLs);
[DllImport("__Internal")]
private static extern void _setOneLinkCustomDomains(int length, params string[] oneLinkCustomDomains);
[DllImport("__Internal")]
private static extern void _setUserEmails(EmailCryptType cryptType, int length, params string[] userEmails);
[DllImport("__Internal")]
private static extern void _setPhoneNumber(string phoneNumber);
[DllImport("__Internal")]
private static extern void _afSendEvent(string eventName, string eventValues);
[DllImport("__Internal")]
private static extern void _validateAndSendInAppPurchase(string productIdentifier, string price, string currency, string tranactionId, string additionalParameters, string objectName);
[DllImport("__Internal")]
private static extern void _recordLocation(double longitude, double latitude);
[DllImport("__Internal")]
private static extern string _getAppsFlyerId();
[DllImport("__Internal")]
private static extern void _registerUninstall(byte[] deviceToken);
[DllImport("__Internal")]
private static extern void _handlePushNotification(string pushPayload);
[DllImport("__Internal")]
private static extern string _getSDKVersion();
[DllImport("__Internal")]
private static extern void _setHost(string host, string hostPrefix);
[DllImport("__Internal")]
private static extern void _setMinTimeBetweenSessions(int minTimeBetweenSessions);
[DllImport("__Internal")]
private static extern void _stopSDK(bool isStopSDK);
[DllImport("__Internal")]
private static extern bool _isSDKStopped();
[DllImport("__Internal")]
private static extern void _handleOpenUrl(string url, string sourceApplication, string annotation);
[DllImport("__Internal")]
private static extern void _setSharingFilterForAllPartners();
[DllImport("__Internal")]
private static extern void _setSharingFilter(int length, params string[] partners);
[DllImport("__Internal")]
private static extern void _recordCrossPromoteImpression(string appID, string campaign, string parameters);
[DllImport("__Internal")]
private static extern void _attributeAndOpenStore(string appID, string campaign, string parameters, string gameObject);
[DllImport("__Internal")]
private static extern void _generateUserInviteLink(string parameters, string gameObject);
[DllImport("__Internal")]
private static extern void _recordInvite(string channel, string parameters);
}
#endif
}