AppsFlyerLib

Overview

AppsFlyerLib adalah kelas utama dari SDK Android AppsFlyer dan merangkum sebagian besar metode.

Untuk mengimpor AppsFlyerLib:

// AppDelegate.h
#import <AppsFlyerLib/AppsFlyerLib.h>

@interface AppDelegate : UIResponder <UIApplicationDelegate, AppsFlyerLibDelegate>

@end

import AppsFlyerLib

Kembali ke indeks referensi SDK .

Properti

advertisingIdentifier (read-only)

Deklarasi properti

@property(nonatomic, strong, readonly) NSString *advertisingIdentifier

Deskripsi
SDK AppsFlyer mengumpulkan semua milik Apple advertisingIdentifier if the AdSupport.framework termasuk dalam SDK.
Anda dapat menonaktifkan perilaku ini dengan mengatur disableAdvertisingIdentifier to true.

anonymizeUser

Deklarasi properti

@property(atomic) BOOL anonymizeUser;

Deskripsi
Menonaktifkan pencatatan untuk pengguna tertentu

appInviteOneLinkID

Deklarasi properti

@property(nonatomic, strong, nullable, setter = setAppInviteOneLink:) NSString * appInviteOneLinkID

Deskripsi
Atur ID OneLink Anda dari konfigurasi OneLink. Digunakan di Undangan Pengguna untuk membuat OneLink.

appleAppID

Deklarasi properti

@property(nonatomic, strong) NSString * appleAppID

Deskripsi
Gunakan properti ini untuk mengatur ID Apple aplikasi Anda (diambil dari laman aplikasi di iTunes Connect)

appsFlyerDevKey

Deklarasi properti

@property(nonatomic, strong) NSString * appsFlyerDevKey

Deskripsi
Gunakan properti ini untuk mengatur Kode pengembang AppsFlyerAnda.

currencyCode

Deklarasi properti

@property(nonatomic, strong, nullable) NSString *currencyCode

Deskripsi
Dalam hal event pembelian in app, Anda dapat mengatur kode mata uang yang digunakan pengguna untuk melakukan pembelian.
Kode mata uangnya adalah 3 kode huruf menurut standar ISO.

Contoh penggunaan

[[AppsFlyerLib shared] setCurrencyCode:@"USD"];

AppsFlyerLib.shared().currencyCode = "USD"

customData

📘

Pengaturan customData before first launch will have the additional data included in installs, sessions, as well as in-app events.

Deklarasi properti

@property(nonatomic, strong, nullable, setter = setAdditionalData:) NSDictionary * customData

Deskripsi
Gunakan untuk menambah data kustom ke payload event. Anda akan menerimanya dalam laporan data lengkap.

customerUserID

Deklarasi properti

@property(nonatomic, strong, nullable) NSString * customerUserID

Deskripsi
Jika Anda menggunakan ID pengguna Anda sendiri di aplikasi Anda, Anda dapat mengatur properti ini ke ID tersebut.
Memungkinkan Anda untuk melakukan rujukan silang ID unik milik Anda dengan ID unik AppsFlyer serta ID perangkat lainnya

deepLinkDelegate

Deklarasi properti

@property(weak, nonatomic) id<AppsFlyerDeepLinkDelegate> deepLinkDelegate

Deskripsi
Mendelegasikan properti objek yang sesuai dengan protokol DeepLinkDelegate dan menerapkan metodenya.

Contoh penggunaan

AppsFlyerLib.shared().deepLinkDelegate = self

deepLinkTimeout

Deskripsi
Tidak ada respons (Request Time Out/RTO) untuk Deep linking yang ditangguhkan/Deferred Deeplinking.

Satuan dalam milidetik.

Deklarasi properti

@property(nonatomic) NSUInteger deepLinkTimeout

delegate

Deskripsi
Delegasi AppsFlyer. Lihat AppsFlyerLibDelegate.
Deklarasi properti

@property (nonatomic, weak) id<AppsFlyerLibDelegate> delegate;

disableAdvertisingIdentifier

Deklarasi properti

@property (nonatomic) int disableAdvertisingIdentifier;

Deskripsi
jika AdSupport.framework tidak dinonaktifkan, SDK mengumpulkan Apple advertisingIdentifier.
Anda dapat menonaktifkan perilaku ini dengan mengatur properti berikut ke YES.

disableAppleAdsAttribution

Deklarasi properti

@property(nonatomic) BOOL disableAppleAdsAttribution

Deskripsi
Disables AdServices framework-based attribution for Apple Search Ads.

disableCollectASA

Deklarasi properti

@property(atomic) BOOL disableCollectASA;

Deskripsi
Disables the collection of data from the iAd Framework. This API has no effect in v6.12.3 and above, where the iAd Framework is no longer in use.

disableIDFVCollection

Deklarasi properti

@property(nonatomic) BOOL disableIDFVCollection;

Deskripsi
Untuk menonaktifkan pengumpulan pengenal vendor aplikasi (app vendor identifier - IDFV), atur disableIDFVCollection to YES.

disableSKAdNetwork

Deklarasi properti

@property(nonatomic) BOOL disableSKAdNetwork

Deskripsi

facebookDeferredAppLink

Deklarasi properti

@property (nonatomic, nullable) int *facebookDeferredAppLink;

Deskripsi
Atur tautan aplikasi tertunda Facebook secara manual.

host (read-only)

Deklarasi properti

@property(nonatomic, strong, readonly) NSString *host

Deskripsi
Properti ini menerima nilai string yang mewakili nama host untuk semua titik akhir. Untuk mengatur host, gunakan setHost.

Untuk menggunakan titik akhir SDK – setel nilai ke nil.

hostPrefix (read-only)

Deklarasi properti

@property(nonatomic, strong, readonly) NSString *hostPrefix

Deskripsi
Properti ini menerima nilai string yang mewakili nama awalan host untuk semua titik akhir. Untuk mengatur host, gunakan setHost.

isDebug

Deklarasi properti

@property(nonatomic) BOOL isDebug;

Deskripsi
Cetak pesan SDK ke log konsol. Harus dinonaktifkan untuk build produksi Anda.

isStopped

Deklarasi properti

@property(atomic) BOOL isStopped;

📘

SDK Restart

Atur isStopped = true and then set isStopped = false

No need to call start()

Deskripsi
API to shut down all SDK activities. This will disable all requests from the SDK except for those related to fetching SKAd Network data from the server.

minTimeBetweenSessions

Deklarasi properti

@property(atomic) NSUInteger minTimeBetweenSessions;

Deskripsi
Atur nilai khusus untuk waktu minimum yang dibutuhkan antar sesi.

Argumen input

oneLinkCustomDomains

Deklarasi properti

@property(nonatomic, nullable) NSArray<NSString *> *oneLinkCustomDomains;

Deskripsi
Untuk pengiklan yang menggunakan OneLinks vanity.

phoneNumber

Deklarasi properti

@property(nonatomic, nullable) NSString *phoneNumber

Deskripsi

resolveDeepLinkURLs

Deklarasi properti

@property(nonatomic, nullable) NSArray<NSString *> *resolveDeepLinkURLs;

Deskripsi

Contoh penggunaan
Beberapa layanan pihak ke-3 seperti penyedia layanan email (ESP) menggabungkan link di dalam email dengan domain pencatatan klik mereka sendiri. Beberapa diantaranya bahkan memungkinkan Anda untuk mengatur domain pencatatan klik Anda sendiri. Jika OneLink digabungkan dalam domain seperti itu, fungsinya mungkin terbatas.

Untuk mengatasi masalah ini, gunakan setResolveDeepLinkURLs untuk mendapatkan OneLink dari domain klik yang meluncurkan aplikasi. Pastikan Anda memanggil API ini sebelum inisialisasi SDK.

Misalnya, Anda memiliki tiga domain klik yang mengarahkan ulang ke OneLink Anda yaitu https://mysubdomain.onelink.me/abCD. Gunakan API ini untuk mendapatkan OneLink yang dialihkan oleh domain klik Anda. Metode API ini menerima daftar domain yang diselesaikan oleh SDK.

[AppsFlyerLib shared].resolveDeepLinkURLs = @[@"example.com",@"click.example.com"];

AppsFlyerLib.shared().resolveDeepLinkURLs = ["example.com", "click.example.com"]

Ini memungkinkan Anda menggunakan domain klik Anda sambil mempertahankan fungsionalitas OneLink. Domain klik bertanggung jawab untuk meluncurkan aplikasi. Kemudian, API akan mendapatkan OneLink dari domain klik ini, lalu Anda dapat menggunakan data dari OneLink ini untuk deep linking dan menyesuaikan konten user.

sharingFilter

Deklarasi properti

@property(nonatomic, nullable) NSArray<NSString *> *sharingFilter;

Deskripsi

shouldCollectDeviceName

Deklarasi properti

@property(nonatomic) BOOL shouldCollectDeviceName;

Deskripsi
Setel flag ini ke YES, untuk mengumpulkan nama perangkat saat ini (mis. “iPhone saya”).

useReceiptValidationSandbox

Deklarasi properti

@property (nonatomic) BOOL useReceiptValidationSandbox;

Deskripsi
Validasi tanda terima pembelian in-app di lingkungan Apple (produksi atau sandbox).

useUninstallSandbox

Deklarasi properti

@property (nonatomic) BOOL useUninstallSandbox;

Deskripsi
Setel flag ini untuk menguji uninstall di lingkungan Apple (produksi atau sandbox).

Metode

addPushNotificationDeepLinkPath

Signature metode

- (void)addPushNotificationDeepLinkPath:(NSArray<NSString *> *)deepLinkPath;

addPushNotificationDeepLinkPath(deepLinkPath: [String])

Deskripsi
Menambahkan larik kode, yang digunakan untuk menyusun jalur kode untuk menyelesaikan deep link dari payload notifikasi push.

Argumen input

Kembali
void.

Contoh penggunaan
Konfigurasi dasar:

[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"af_push_link"]]

AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["af_push_link"])

Konfigurasi lanjutan:

[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"deeply", @"nested", @"deep_link"]]

AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["deeply", "nested", "deep_link"])

Panggilan ini sesuai dengan struktur payload berikut:

{
  "deeply": {
      "nested": {
          “deep_link”: “https://yourdeeplink2.onelink.me”
      }
  }
}

appendParametersToDeepLinkingURL

Signature metode

(void)appendParametersToDeepLinkingURLWithString:(NSString *)containsString parameters:(NSDictionary<NSString *, NSString*> *)parameters;

appendParametersToDeeplinkURL(contains: String, parameters: [String : String])

Deskripsi
Mencocokkan URL yang memuat contains sebagai substring dan menambahkan parameter kueri ke URL tersebut. Jika URL tidak cocok, parameter tidak ditambahkan ke URL tersebut.

🚧

Memanggil metode ini sebelum memanggil start

Argumen input

Kembali
void.

continue

Signature metode

- (id)continueUserActivity:(id)userActivity
restorationHandler:
(void (^_Nullable)(int *_Nullable))restorationHandler;

AppsFlyerLib.shared().continue(userActivity: NSUserActivity?, restorationHandler: (([Any]?) -> Void)?)

Deskripsi
Mengizinkan AppsFlyer untuk menangani pemulihan dari `NSUserActivity. Gunakan metode ini untuk menangani tautan Universal.

Argumen input

Kembali
void.

enableFacebookDeferderedApplinks

Signature metode

- (void)enableFacebookDeferredApplinksWithClass:(Class _Nullable)facebookAppLinkUtilityClass;

enableFacebookDeferredApplinks(with:AnyClass?)

Deskripsi
Aktifkan pengumpulan Tautan Aplikasi Tertunda Facebook.

• Memerlukan SDK Facebook dan aplikasi Facebook pada perangkat target/klien.
• API ini harus dipanggil sebelum menginisialisasi AppsFlyer SDK agar dapat berfungsi dengan baik

Argumen input

Kembali
void.

enableTCFDataCollection

Signature metode

- (void)enableTCFDataCollection:(BOOL)flag;

func enableTCFDataCollection(_ flag: Bool)

Deskripsi
Enables the collection of Transparency and Consent Framework (TCF) data from NSUserDefaults. The data was placed in UserDefaults by the device's TCF v2.2 compatible Consent Management Platform (CMP).

Argumen input

Kembali
void.

getAppsFlyerUID

Signature metode

- (NSString *)getAppsFlyerUID;

getAppsFlyerUID()

Deskripsi
Dapatkan ID perangkat unik AppsFlyer. SDK menghasilkan ID perangkat unik AppsFlyer setelah penginstalan aplikasi. Ketika SDK dimulai, ID ini dicatat sebagai ID dari penginstalan aplikasi pertama.

Argumen input
Metode ini tidak memerlukan argumen input.

Kembali

getSDKVersion

Signature metode

- (NSString *)getSDKVersion;

getSDKVersion()

Deskripsi
Dapatkan versi SDK.

Argumen input
Metode ini tidak memerlukan argumen input.

Kembali

handleOpen

Signature metode

- (void)handleOpenUrl:(id)url options:(id)options;

AppsFlyerLib.shared().handleOpen(url: URL?, options: [AnyHashable : Any]?)

Deskripsi
Panggil metode ini dari dalam AppDelegate Anda openURL method.
This method handles URI-scheme for iOS 9 and above.

Argumen input

Kembali
void.

handlePushNotification

Signature metode

- (void)handlePushNotification:(NSDictionary * _Nullable)pushPayload;

AppsFlyerLib.shared().handlePushNotification(pushPayload: [AnyHashable : Any]?)

Deskripsi
Aktifkan AppsFlyer untuk menangani notifikasi push.

Argumen input

Kembali
void.

logAdRevenue

Added in v6.15.0

Signature metode

-(void)logAdRevenue:(AFAdRevenueData *)adRevenueData additionalParameters:(NSDictionary * **_Nullable**)additionalParameters;

Deskripsi

The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.

Parameter input

Kembali

void.

AFAdRevenueData

An object that encapsulates all mandatory adRevenue data received from the mediation network.

Definition

AFAdRevenueData {
	(NSString * **_Nonnull**)monetizationNetwork
	(AppsFlyerAdRevenueMediationNetworkType)mediationNetwork
	(NSString * **_Nonnull**)currencyIso4217Code
	(NSNumber * **_Nonnull**)eventRevenue
}

AFAdRevenueData parameters

AppsFlyerAdRevenueMediationNetworkType

logEvent

Signature metode

- (void)logEvent:(NSString *)eventName withValues:(NSDictionary * _Nullable)values;

logEvent(eventName: String, withValues: [AnyHashable : Any]?)

Deskripsi
Gunakan metode ini untuk mencatat event dengan parameter event.

Argumen input

Kembali
void.

logEvent

Signature metode

- (void)logEventWithEventName:(NSString *)eventName
  eventValues:(NSDictionary<NSString * , id> * _Nullable)eventValues
  completionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;

logEvent(eventName: String, withValues: [AnyHashable : Any]?, completionHandler:(([String : Any]?, Error?) -> Void)?)

Deskripsi
Gunakan metode ini untuk mencatat event dengan parameter event, dan sertakan pengendali penyelesaian untuk menangani keberhasilan dan kegagalan pengiriman event.

Argumen input

Kembali
void.

logLocation

Signature metode

- (void)logLocation:(double)longitude latitude:(double)latitude;

logLocation(longitude: Double, latitude: Double)

Deskripsi
Untuk mencatat lokasi untuk geo-fencing. Melakukan hal yang sama seperti kode di bawah ini.

Argumen input

Kembali
void.

performOnAppAttribution

Signature metode

- (void)performOnAppAttributionWithURL:(NSURL * _Nullable)URL;

performOnAppAttribution(with:URL?)

Deskripsi
Digunakan untuk memicu secara manual onAppOpenAttribution delegate.

Argumen input

Kembali
void.

registerUninstall

Signature metode

- (void)registerUninstall:(NSData * _Nullable)deviceToken;

registerUninstall(deviceToken: Data?)

Deskripsi
Daftar uninstall - Anda harus mendaftar untuk notifikasi push dan memberikan token perangkat untuk notifikasi push kepada AppsFlyer.

Argumen input

Kembali
void.

setConsentData

Signature metode

.setConsentData(afConsent: AppsFlyerConsent)

- (void)setConsentData:(AppsFlyerConsent) afConsent

Deskripsi

Transfers consent data to the SDK.

Argumen input

setCurrentDeviceLanguage

Signature metode

- (void)setCurrentDeviceLanguage:(NSString *)currentDeviceLanguage

Deskripsi
Gunakan metode ini untuk mengatur bahasa perangkat di SDK dan meneruskannya ke AppsFlyer.

Argumen input

Contoh penggunaan

NSString *language = [[NSLocale preferredLanguages] objectAtIndex:0]
    [[AppsFlyerLib shared] setCurrentDeviceLanguage: @language];

let language = NSLocale.current.languageCode
AppsFlyerLib.shared().currentDeviceLanguage = language

setHost

Signature metode

(void)setHost:(NSString *)host withHostPrefix:(NSString *)hostPrefix;

setHost(host: String, withHostPrefix: String)

Deskripsi
Fungsi ini mengatur nama host dan awalan nama host untuk semua titik akhir.

Note: Starting with SDK V6.11, if the host value is empty or null, the API call will be ignored.

Argumen input

Kembali
void.

Contoh penggunaan

[[AppsFlyerLib shared] setHost:@"example.com" withHostPrefix:@"my_host_prefix"];

AppsFlyerLib.shared().setHost("example.com", withHostPrefix: "my_host_prefix")

setPartnerData

Signature metode

- (void)setPartnerDataWithPartnerId:(NSString * _Nullable)partnerId partnerInfo:(NSDictionary<NSString *, id> * _Nullable)partnerInfo;

setPartnerData(partnerId: String?, partnerInfo: [String : Any]?)

Deskripsi
Memungkinkan pengiriman data khusus untuk tujuan integrasi mitra.

Argumen input

Kembali
void.

Contoh penggunaan

NSDictionary *partnerInfo = @{
 @"puid": @"123456789",
};

[[AppsFlyerLib shared] setPartnerDataWithPartnerId: @"test_int" partnerInfo:partnerInfo];

let partnerInfo = [
  "puid":"123456789",
]

AppsFlyerLib.shared().setPartnerData(partnerId:"test_int", partnerInfo:partnerInfo)

setSharingFilterForPartners

Ditambahkan di V6.4
Signature metode

- (void)setSharingFilterForPartners:(NSArray<NSString *> * _Nullable)sharingFilter;

This function replaces the deprecated setSharingFilterForAllPartners

Deskripsi
Memungkinkan Anda mengonfigurasi mitra mana yang harus dikecualikan SDK dari berbagi data.

Argumen input

Catatan:
To find out the required partner IDs:

1. Run the Get active integrations API for a list of all active integrations
2. Gunakan media_source_name values from the API response as input values to the method partners array.

Exceptions:

• For Apple Search Ads use Apple Search Ads (and not iossearchads_int).
• For Twitter, use twitter (and not twitter_int)

Contoh penggunaan

[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int"]]; // 1 partner
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int", @"examplePartner2_int"]]; // multiple partners
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"all"]]; // All partners
[[AppsFlyerLib shared] setSharingFilterForPartners:nil]; // Reset list (default)

AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner1_int"]) // 1 partner
AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner2_int", "examplePartner1_int"]) // multiple partners
AppsFlyerLib.shared().setSharingFilterForPartners(["all"]) // All partners
AppsFlyerLib.shared().setSharingFilterForPartners(nil) // Reset list (default)

setSharingFilterForAllPartners

Tidak digunakan lagi di V6.4
Signature metode

- (void)setSharingFilterForAllPartners;

setSharingFilterForAllPartners()

This function is deprecated and has been replaced by setSharingFilterForPartners

Deskripsi
Block an event from being shared with integrated partners.

Argumen input
Metode ini tidak memerlukan argumen input.

Kembali
void

setUserEmails

Signature metode

- (void)setUserEmails:(NSArray<NSString *> * _Nullable)userEmails withCryptType:(EmailCryptType)type;

setUserEmails(userEmails: [String]?, with: EmailCryptType)

Deskripsi
Use this to set the user email(s).
Note: MD-5 and SHA-1 encryption types are deprecated starting with SDK V6.9.0. Currently, only SHA-256 and NONE are supported.

Argumen input

Kembali
void.

shared

Signature metode

(AppsFlyerLib *)shared;

Deskripsi
Mendapat contoh tunggal dari AppsFlyerLib kelas, menciptakan hal tersebut jika perlu.

Contoh penggunaan

AppsFlyerLib.shared()

start

Signature metode

- (void)start;

(void) start()

Deskripsi
Memulai SDK.

Argumen input
Metode ini tidak memerlukan argumen input.

Kembali
void.

start

Signature metode

- (void)startWithCompletionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;

start(completionHandler: (([String : Any]?, Error?) -> Void)?)

Deskripsi
Memulai SDK dengan penangan penyelesaian.

Argumen input

Kembali
void.

validateAndLogInAppPurchase

(Supported from SDK v.6.14.1)

Signature metode

typedef void (^AFSDKValidateAndLogCompletion)(AFSDKValidateAndLogResult * _Nullable result);
- (void)validateAndLogInAppPurchase:(AFSDKPurchaseDetails *)details
                   extraEventValues:(NSDictionary * _Nullable)extraEventValues
                  completionHandler:(AFSDKValidateAndLogCompletion)completionHandler NS_AVAILABLE(10_7, 7_0);

Deskripsi

The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase event to AppsFlyer.

See detailed instructions in Validate and log in-app purchase.

Parameter input

Kembali
void.

AFSDKPurchaseDetails

An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase metode.

AFSDKPurchaseDetails parameters

validateAndLogInAppPurchase (LEGACY)

(Supported until SDK v.6.14.0)

Signature metode

- (void)validateAndLogInAppPurchase:(id)productIdentifier
price:(id)price
 currency:(id)currency
transactionId:(id)transactionId
additionalParameters:(id)params
success:(void (^_Nullable)(int *))successBlock
failure:
(void (^_Nullable)(int *_Nullable,
 id _Nullable))failedBlock;

validateAndLog(inAppPurchase: String?, price: String?, currency: String?, transactionId: String?, additionalParameters: [AnyHashable : Any]?, success: ([AnyHashable : Any]) -> Void)?, failure: ((Error?, Any?) -> Void)?)

Deskripsi
Untuk mencatat dan memvalidasi pembelian dalam aplikasi, Anda dapat memanggil metode ini dari [completeTransaction] metode di SKPaymentTransactionObserver.

Argumen input

Kembali
void.

waitForATTUserAuthorization

Signature metode

- (void)waitForATTUserAuthorizationWithTimeoutInterval:(id)timeoutInterval;

waitForATTUserAuthorization(timeoutInterval:)

Deskripsi
Menunggu permintaan otorisasi pengguna untuk mengakses data terkait aplikasi

Argumen input

Contoh penggunaan

if (@available(iOS 14, *)) {
        [[AppsFlyerLib shared] waitForATTUserAuthorizationWithTimeoutInterval:60];
        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status){
        }];
    }

if #available(iOS 14, *) {
            AppsFlyerLib.shared().waitForATTUserAuthorization(withTimeoutInterval: 60)
            ATTrackingManager.requestTrackingAuthorization { (status) in
            }
        }

Kembali
void.