Panduan integrasi plugin V6 Unity—Referensi API

Sekilas: Deskripsi teknis kelas dan metode yang disertakan dalam SDK AppsFlyer. 

 Bacaan terkait

Untuk gambaran lengkap tentang pengintegrasian plugin Unity dengan aplikasi Anda, pastikan Anda membaca artikel ini:

API Android dan iOS

initSDK

Deskripsi

Inisialisasi plugin dengan kunci pengembang dan ID aplikasi. Kunci pengembang diperlukan untuk semua aplikasi. ID aplikasi diperlukan hanya untuk iOS. Jika aplikasi Anda hanya untuk Android, teruskan null untuk ID aplikasi. Obyek game berisi antarmuka IAppsFlyerConversionData.

Signature metode

void initSDK(string devKey, string appID, MonoBehaviour gameObject)

Contoh

AppsFlyer.initSDK("dev_key", "app_id"); // without deeplinking
            AppsFlyer.initSDK("dev_key", "app_id", this); // with deeplinking

startSDK

Deskripsi

Setelah API diaktifkan, SDK akan dimulai, sesi akan segera dikirim, dan semua transisi latar depan-belakang akan merekam sesi.

Signature metode

void startSDK()

Contoh

AppsFlyer.startSDK();

sendEvent

Deskripsi

Pencatatan in-app event dilakukan dengan memanggil metode trackEvent dengan nama event dan parameter nilai.

Signature metode

void sendEvent(string eventName, Dictionary<string, string> eventValues)

Contoh

Dictionary<string, string> 
 eventValues = new Dictionary<string, string>(); 
 eventValues.Add(AFInAppEvents.CURRENCY, "USD"); 
 eventValues.Add(AFInAppEvents.REVENUE, "0,99"); 
            eventValues.Add("af_quantity", "1"); 
 AppsFlyer.sendEvent(AFInAppEvents.PURCHASE, eventValues);

stopSDK

Deskripsi

Dalam beberapa kasus ekstrem, Anda mungkin ingin mematikan semua fungsi SDK untuk regulator dan persyaratan kepatuhan privasi. Untuk melakukannya gunakan API stopSDK. Setelah dipanggil, SDK tidak lagi berkomunikasi dengan server AppsFLyer dan berhenti berfungsi.

Signature metode

void stopSDK (bool isSDKStopped)

Contoh

AppsFlyer.stopSDK(benar);

isSDKStopped

Deskripsi

Apakah stopSDK (boolean) API diatur ke true.

Signature metode

bool isSDKStopped()

Contoh

if (!AppsFlyer.isSDKStopped())
{

}

getSdkVersion

Deskripsi

Dapatkan versi SDK AppsFlyer

Signature metode

string getSdkVersion()

Contoh

string version = AppsFlyer.getSdkVersion();

setIsDebug

Deskripsi

Mengaktifkan log debug

Signature metode

void setIsDebug (bool shouldEnable)

Contoh

AppsFlyer.setIsDebug(benar);

Mengatur ID Pengguna Pelanggan

Deskripsi

Atur ID pengguna pelanggan (CUID). 

Signature metode

void setCustomerUserId(string id)

Contoh

AppsFlyer.setCustomerUserId("custom_user_id");

setAppInviteOneLink

Deskripsi

Mengatur ID templat OneLink yang digunakan untuk membuat tautan atribusi kustom untuk undangan user.

Signature metode

setAppInviteOneLinkID(string oneLinkId)

Contoh

AppsFlyer.setAppInviteOneLinkID("abcd");

setAdditionalData

Deskripsi

Tambahkan data tambahan untuk mengirim ke platform mitra eksternal.

Signature metode

setAdditionalData(Dictionary<string, string> customData)

Contoh

Dictionary<string, string> customData = new Dictionary<string, string>();
customData.Add("custom1", "someData");
AppsFlyer.setAdditionalData(customData);

setResolveDeepLinkURLs

Deskripsi

Menyelesaikan OneLink dari domain klik. Pelajari lebih menyelesaikan URL tautan dalam yang terhubung.

Signature metode

setResolveDeepLinkURLs(params string[] urls)

Contoh

AppsFlyer.setResolveDeepLinkURLs("example.com", "click.example.com");

setOneLinkCustomDomain

Deskripsi

Pemasang iklan dapat menggunakan metode ini untuk mengatur domain OneLink batil ini.

Signature metode

void setOneLinkCustomDomain(params string[] domain)

Contoh

AppsFlyer.setOneLinkCustomDomain("test.domain", "test2.domain");

setcurrencyCode

Deskripsi

Gunakan untuk event dengan pendapatan. Menerima  kode mata uang ISO.

Signature metode

public void setCurrencyCode(String currencyCode);

Contoh

AppsFlyer.setCurrencyCode("GBP");

recordLocation

Deskripsi

Secara manual merekam lokasi pengguna.

Signature metode

void recordLocation (garis lintang ganda, garis bujur ganda)

Contoh

AppsFlyer.recordLocation(40.7128, 74.0060);

anonymizeUser (anonimkan pengguna)

Deskripsi

Gunakan selama inisialisasi untuk secara eksplisit menganonimkan penginstalan, event, dan sesi pengguna. Untuk berhenti menganonimkan, panggil lagi metode anonymizeUser, setel ke false.

Signature metode

void anonymizeUser(bool shouldAnonymizeUser)

Contoh

AppsFlyer.anonymizeUser(true);

getAppsFlyerId

Deskripsi

Untuk mendapatkan ID Unik AppsFlyer untuk penginstalan baru.

Signature metode

string getAppsFlyerId()

Contoh

string uid = AppsFlyer.getAppsFlyerId();

setMinTimeBetweenSessions

Deskripsi

Secara default, setidaknya membutuhkan jeda 5 detik antara 2 peluncuran aplikasi agar dapat dihitung sebagai sesi terpisah. Atur nilai khusus untuk waktu minimum yang dibutuhkan antar sesi.

Signature metode

void setMinTimeBetweenSessions(int seconds)

Contoh

AppsFlyer.setMinTimeBetweenSessions(4);

setUserEmails

Deskripsi

Atur email pengguna dan enkripsikan email tersebut.

Signature metode

void setUserEmails(EmailCryptType cryptMethod, params string[] emails)

Contoh

AppsFlyer.setUserEmails(EmailCryptType.EmailCryptTypeSHA256, "test1@test1.com", "test2@test2.com");

setHost

Deskripsi

Atur host kustom

Signature metode

void setHost(string hostPrefixName, string hostName)

Contoh

AppsFlyer.setHost("hostPrefixName","hostName");

getConversionData

Deskripsi

Daftarkan pendengar data konversi untuk mengizinkan akses ke data atribusi pengguna secara waktu aktual untuk setiap penginstalan baru, langsung dari level SDK. Dengan demikian, tayangkan konten yang dibuat khusus kepada pengguna atau arahkan mereka ke aktivitas tertentu dalam aplikasi, yang dapat secara signifikan meningkatkan interaksi mereka dengan aplikasi Anda.

Signature metode

void getConversionData(string objectName);

Contoh

AppsFlyer.getConversionData(gameObject.name);

attributeAndOpenStore

Deskripsi

Untuk mengatribusikan klik dan meluncurkan laman aplikasi App Store.

Signature metode

void attributeAndOpenStore
(string appID, string campaign,
Dictionary<string, string> userParams, MonoBehaviour gameObject)

Contoh


Dictionary<string, string> parameters = new Dictionary<string, string>();
parameters.Add("af_sub1", "val");
parameters.Add("custom_param", "val2");
AppsFlyer.attributeAndOpenStore("123456789", "uji kampanye", parameter, ini);            

recordCrossPromoteImpression

Deskripsi

Untuk mengatribusikan tayangan, gunakan panggilan API berikut. Pastikan untuk menggunakan ID Aplikasi yang dipromosikan seperti yang muncul di dashboard AppsFlyer.

Signature metode

void recordCrossPromoteImpression(string appID, string campaign);

Contoh

Dictionary<string, string> parameters = new Dictionary<string, string>();
parameters.Add("af_sub1", "val");
parameters.Add("custom_param", "val2");
AppsFlyer.recordCrossPromoteImpression("appID", "kampanye", parameter);

generateUserInviteLink

Deskripsi

Kelas LinkGenerator membangun URL undangan sesuai dengan berbagai metode pengatur, yang memungkinkan meneruskan informasi tambahan dengan klik.

Signature metode

void generateUserInviteLink
(Dictionary<string, string> parameters, MonoBehaviour gameObject)

Contoh

AppsFlyer.generateUserInviteLink(params, this);

onAppOpenAttribution

Deskripsi

Dapatkan data deep-link ketika aplikasi dibuka melalui deep link.

Signature metode

public void onAppOpenAttribution(string validateResult)

Contoh

public void onAppOpenAttribution(string attributionData)
            { AppsFlyer.AFLog("onAppOpenAttribution", attributionData);
            Dictionary<string, object> attributionDataDictionary = AppsFlyer.CallbackStringToDictionary(attributionData);
            // add direct deeplink logic here }

onAppOpenAttributionFailure

Deskripsi

Dapatkan kesalahan saat mendapatkan data deep-link.

Signature metode

public void onAppOpenAttributionFailure (string error)

Contoh

public void onAppOpenAttributionFailure(string error) 
 {AppsFlyer.AFLog("onAppOpenAttributionFailure", error); }

onConversionDataSuccess

Deskripsi

Metode digunakan untuk mendapat data konversi. Berguna untuk tautan langsung tertunda. Pelajari lebih lanjut .

  • Dari SDK v5: onConversionDataSuccess
  • Sebelum SDK v5: onConversionDataReceived 

Signature metode

public void onConversionDataSuccess(string conversionData)

Contoh

public void onConversionDataSuccess(string conversionData) 
 {
            AppsFlyer.AFLog("onConversionDataSuccess", conversionData);
            Dictionary<string, object> conversionDataDictionary = AppsFlyer.CallbackStringToDictionary(conversionData);
            // add deferred deeplink logic here
            }

onConversionDataFail

Deskripsi

Menangani kesalahan saat gagal mendapatkan data konversi dari instalasi.

Signature metode

public void onConversionDataFail (string error)

Contoh

public void onConversionDataFail(string error) 
 {
            AppsFlyer.AFLog("onConversionDataFail", error);
            }

onInviteLinkGenerated

Deskripsi

Success callback untuk menghasilkan URL OneLink.

Signature metode

public void onInviteLinkGenerated(string link)

Contoh

public void onInviteLinkGenerated(string link) 
 {
            }

onInviteLinkGeneratedFailure

Deskripsi

Error callback untuk menghasilkan URL OneLink.

Signature metode

public void onInviteLinkGeneratedFailure (string error)

Contoh

public void onInviteLinkGeneratedFailure(string error) 
 {
            AppsFlyer.AFLog("onInviteLinkGeneratedFailure", error);
            }

didFinishValidateReceipt

Deskripsi

Success callback untuk validateAndSendInAppPurchase API.

Untuk Android: Callback menampilkan "Validasi keberhasilan".
Untuk iOS: Callback mengembalikan string JSON dari API verifikasiReceipt Apple.

Signature metode

public void didFinishValidateReceipt(hasil string)

Contoh

public void didFinishValidateReceipt(hasil string) 
 {
            }

didFinishValidateReceiptWithError

Deskripsi

Error callback untuk memvalidasi tanda terima.

Signature metode

public void didFinishValidateReceiptWithError (string error)

Contoh

public void didFinishValidateReceiptWithError(string error) 
 {
            }

setPhoneNumber

Deskripsi

Digunakan untuk mengatur nomor telepon pengguna.

Signature metode

void setPhoneNumber(string phoneNumber)

Contoh

AppsFlyer.setPhoneNumber("4166358181");

setSharingFilterForAllPartners

Deskripsi

Digunakan oleh pengiklan untuk mengecualikan semua  jaringan/mitra terintegrasi  dari pengambilan data. Pelajari lebih lanjut

Signature metode

void setSharingFilterForAllPartners()

Contoh

AppsFlyer.setSharingFilterForAllPartners();

setSharingFilter

Deskripsi

Digunakan oleh pengiklan untuk menetapkan  beberapa  (satu atau lebih) jaringan/mitra terintegrasi untuk  dikecualikan dari  pengambilan data.Pelajari lebih lanjut

Signature metode

void setSharingFilter(params string[] partners)

Contoh

AplikasiFlyer.setSharingFilter
("googleadwords_int","snapchat_int","doubleclick_int");

API Android

updateServerUninstallToken

Deskripsi

Teruskan secara manual Token Perangkat Firebase untuk pengukuran uninstall.

Signature metode

void updateServerUninstallToken (token string)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.updateServerUninstallToken("token"); 
            #endif

setImeiData

Deskripsi

Untuk secara eksplisit mengirim IMEI ke AppsFlyer.

Signature metode

batalkan setImeiData(string imei)

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setImeiData("imei");
            #endif

setAndroidIdData

Deskripsi

 Untuk secara eksplisit mengirim ID Android ke AppsFlyer.

Signature metode

void setAndroidIdData(string androidId)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.setAndroidIdData("androidId"); 
            #endif

waitForCustomerUserId

Deskripsi

Fitur ini memastikan SDK tidak mulai berfungsi sampai customerUserID tersedia.

Signature metode

void waitForCustomerUserId (tunggu bool)

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.waitForCustomerUserId(true);
            #endif

setCustomerIdAndStartSDK

Deskripsi

Untuk menyediakan SDK dengan ID pengguna pelanggan yang relevan dan memicu SDK untuk memulai aktivitas normalnya.

Signature metode

void setCustomerIdAndStartSDK (string id)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.setCustomerIdStartSDK("id"); 
            #endif

getOutOfStore

Deskripsi

Get the current AF_STORE value.

Signature metode

string getOutOfStore()

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
            string af_store = AppsFlyerAndroid.getOutOfStore();
            #endif

setOutOfStore

Deskripsi

Atur nilai AF_STORE secara manual.

Signature metode

void setOutOfStore(string sourceName)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.setOutOfStore("sourceName"); 
            #endif

setCollectAndroidID

Deskripsi

Menonaktifkan pengumpulan ID Android. Jika aplikasi TIDAK berisi Layanan Google Play, ID Android dikumpulkan oleh SDK. Namun, aplikasi dengan layanan Google Play harus menghindari pengumpulan ID Android karena melanggar kebijakan Google Play.

Signature metode

void setCollectAndroidID(bool isCollect)

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setCollectAndroidID(true);
            #endif

setCollectIMEI

Deskripsi

Menonaktifkan pengumpulan IMEI. Jika aplikasi TIDAK berisi Layanan Google Play, IMEI perangkat dikumpulkan oleh plugin. Namun, aplikasi dengan layanan Google play harus menghindari pengumpulan IMEI karena ini melanggar kebijakan Google Play.

Signature metode

void setCollectIMEI(bool isCollect)

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
 AppsFlyerAndroid.setCollectAndroidID(true);
            #endif

setIsUpdate

Deskripsi

Atur secara manual bahwa aplikasi telah diperbarui.

Signature metode

void setIsUpdate (bool isUpdate)

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.setIsUpdate(true);
            #endif

setPreinstallAttribution

Deskripsi

Tentukan produsen atau nama sumber media tempat pra-instal diatribusikan.

Signature metode

void setPreinstallAttribution
(string mediaSource, kampanye string, string siteId)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.setPreinstallAttribution("mediaSource", "kampanye", "ID situs"); 
          #endif

isPreInstalledApp

Deskripsi

Indikator Boolean untuk pra-instal oleh produsen.

Signature metode

bool isPreInstalledApp()

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
     if (AppsFlyerAndroid.isPreInstalledApp())
     {
            }
       #endif

 getAttributionId

Deskripsi

Dapatkan ID atribusi Facebook, jika ada.

Signature metode

string getAttributionId()

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
      string attributionId = AppsFlyerAndroid.getAttributionId();
            #endif

handlePushNotifications

Deskripsi

Rekam notifikasi push.

Signature metode

void handlePushNotifications()

Contoh

#if UNITY_ANDROID && !UNITY_EDITOR
AppsFlyerAndroid.handlePushNotifications();
#endif

validateAndSendInAppPurchase

Deskripsi

API untuk verifikasi server pembelian in-app. Event af_purchase dengan nilai yang relevan akan dikirim secara otomatis jika validasi berhasil.

Signature metode

void validateAndSendInAppPurchase
(string publicKey, string signature, string purchaseData,
string price, string currency, Dictionary<string, string> additionalParameters,
MonoBehaviour gameObject)

Contoh

#jika UNITY_ANDROID && !UNITY_EDITOR 
 AppsFlyerAndroid.validateAndSendInAppPurchase( 
            "publicKey", 
"signature",
"purchaseData",
"price",
"currency",
null,
this);
#endif

API iOS

setShouldCollectDeviceName

Deskripsi

Atur flag ini ke true, untuk mengumpulkan nama perangkat saat ini (misalnya, "iPhone Saya"). Nilai defaultnya adalah "false". 

Signature metode

void setShouldCollectDeviceName(bool shouldCollectDeviceName)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.setShouldCollectDeviceName(true);
            #endif

setDisableCollectIAd

Deskripsi

Menonaktifkan atribusi Apple Search Ads (Iklan Penelusuran Apple).

Signature metode

void setDisableCollectIAd (bool disableCollectIAd)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
 AppsFlyeriOS.setDisableCollectIAd(true);
            #endif

setUseReceiptValidationSandbox

Deskripsi

Validasi tanda terima pembelian in-app di lingkungan Apple (produksi atau sandbox). Nilai defaultnya adalah "false".

Signature metode

void setUseReceiptValidationSandbox (bool useReceiptValidationSandbox)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.setUseReceiptValidationSandbox(true);
            #endif

setUseUninstallSandbox

Deskripsi

Atur flag ini untuk menguji uninstall di lingkungan Apple (produksi atau sandbox). Nilai defaultnya adalah "false".

Signature metode

void setUseUninstallSandbox (bool useUninstallSandbox)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
 AppsFlyeriOS.setUseUninstallSandbox(true);
            #endif

validateAndSendInAppPurchase

Deskripsi

Untuk mengirim dan memvalidasi pembelian in-app, panggil metode ini dari metode processPurchase.

Signature metode

batal validasiAndSendInAppPurchase
(string productIdentifier, harga string, mata uang string, string tranactionId,
Kamus<string, string> parameter tambahan, objek permainan MonoBehaviour)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
            AppsFlyeriOS.validateAndSendInAppPurchase(
            "productIdentifier", 
            "price", 
            "currency", 
            "tranactionId", 
            null, 
            this);
            #endif

registerUninstall

Deskripsi

Daftar untuk notifikasi jarak jauh dan berikan AppsFlyer token perangkat push.

Signature metode

void registerUninstall(byte[] deviceToken)

Contoh

token bool pribadi Terkirim; 
 void Update() 
 { 
 #jika UNITY_IOS && !UNITY_EDITOR 
 jika (!tokenSent) 
 { 
 byte[] token = UnityEngine.iOS.NotificationServices.deviceToken; 
            if (token != null) 
 {
            AppsFlyeriOS.registerUninstall(token);
            tokenSent = true;
            } 
      } 
       #endif 
      }

handleOpenUrl

Deskripsi

Digunakan untuk mencatat deep linking secara manual.

Signature metode

void handleOpenUrl(string url, string sourceApplication, string annotation)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.handleOpenUrl(string url, string sourceApplication, string annotation);
       #endif

onOpenStoreLinkGenerated

Deskripsi

Memungkinkan Anda menggunakan komponen StoreKit untuk membuka App Store sambil tetap berada dalam konteks aplikasi Anda. Pelajari lebih lanjut .

Signature metode

public void onOpenStoreLinkGenerated(string link)

Contoh

public void onOpenStoreLinkGenerated(string link)
            {
            }

disableSKAdNetwork

Deskripsi

Memungkinkan Anda menonaktifkan atribusi SKAdNetwork. Atur ke "true" untuk menonaktifkan.

Signature metode

bools disableSKAdNetwork(int isDisabled)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
AppsFlyeriOS.disableSKAdNetwork(true);
#endif

waitForATTUserAuthorizationWithTimeoutInterval

Deskripsi

Digunakan jika Anda ingin meminta otorisasi pengguna via pop-up sebelum mengakses data terkait aplikasi untuk perekaman pengguna atau perangkat (misalnya, IDFA). Jika pengguna menyetujui, IDFA akan diteruskan ke SDK. Interval timeout (waktu tunggu) memberi pengguna jumlah waktu yang ditetapkan untuk menyetujui pengumpulan IDFA. Setelah timer berakhir, IDFA tidak dikumpulkan.

Signature metode

void waitForATTUserAuthorizationWithTimeoutInterval(int timeoutInterval)

Contoh

#if UNITY_IOS && !UNITY_EDITOR
    AppsFlyeriOS.waitForATTUserAuthorizationWithTimeoutInterval(60);
#endif