Hướng dẫn tích hợp trình cắm Unity V6—Tham chiếu API

Mô tả

Chữ ký phương thức

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

Ví dụ:

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

Mô tả

Khi API này được gọi ra, SDK sẽ khởi động, các phiên sẽ được gửi ngay lập tức và tất cả các chuyển đổi nền sau-nền trước sẽ ghi nhận một phiên.

Chữ ký phương thức

void startSDK()

Ví dụ:

AppsFlyer.startSDK();

Mô tả

Việc ghi nhận các sự kiện trong ứng dụng được thực hiện bằng cách gọi sendEvent với thông số giá trị và tên sự kiện.

Chữ ký phương thức

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

Ví dụ:

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);

Mô tả

Trong một số trường hợp nghiêm trọng, bạn có thể muốn tắt tất cả các chức năng SDK theo các yêu cầu của các cơ quan quản lý và tuân thủ quyền riêng tư. Để làm như vậy, hãy sử dụng API stopSDK. Sau khi được gọi, SDK không còn giao tiếp với máy chủ AppsFLyer nữa và ngừng hoạt động.

Chữ ký phương thức

void stopSDK(bool isSDKStopped)

Ví dụ:

AppsFlyer.stopSDK(true);

Mô tả

API stopSDK (boolean) có được đặt thành true không.

Chữ ký phương thức

bool isSDKStopped()

Ví dụ:

if (!AppsFlyer.isSDKStopped())
{

}

Mô tả

Tải xuống phiên bản SDK AppsFlyer

Chữ ký phương thức

string getSdkVersion()

Ví dụ:

string version = AppsFlyer.getSdkVersion();

Mô tả

Bật nhật ký gỡ lỗi

Chữ ký phương thức

void setIsDebug(bool shouldEnable)

Ví dụ:

AppsFlyer.setIsDebug(true);

Mô tả

Chữ ký phương thức

void setCustomerUserId(string id)

Ví dụ:

AppsFlyer.setCustomerUserId("custom_user_id");

Mô tả

Chữ ký phương thức

setAppInviteOneLinkID(string oneLinkId)

Ví dụ:

AppsFlyer.setAppInviteOneLinkID("abcd");

Mô tả

Chữ ký phương thức

setAdditionalData(Dictionary<string, string> customData)

Ví dụ:

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

Mô tả

Chữ ký phương thức

setResolveDeepLinkURLs(params string[] urls)

Ví dụ:

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

Mô tả

Các nhà quảng cáo có thể sử dụng phương thức này để đặt các miền OneLink chỉ của cá nhân.

Chữ ký phương thức

void setOneLinkCustomDomain(params string[] domains)

Ví dụ:

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

Mô tả

Ghi nhận vị trí người dùng theo cách thủ công

Chữ ký phương thức

void recordLocation(double latitude, double longitude)

Ví dụ:

AppsFlyer.recordLocation(40.7128, 74.0060);

Mô tả

Sử dụng trong quá trình khởi tạo để ẩn danh rõ ràng lượt cài đặt, sự kiện và phiên của người dùng. Để ngừng ẩn danh, hãy gọi lại anonymizeUser, đặt thành false.

Chữ ký phương thức

void anonymizeUser(bool shouldAnonymizeUser)

Ví dụ:

AppsFlyer.anonymizeUser(true);

Mô tả

Để nhận ID duy nhất của AppsFlyer cho lượt cài đặt mới.

Chữ ký phương thức

string getAppsFlyerId()

Ví dụ:

string uid = AppsFlyer.getAppsFlyerId();

Mô tả

Theo mặc định, phải qua ít nhất 5 giây giữa 2 lần khởi chạy ứng dụng thì mới được tính là các phiên riêng biệt. Đặt giá trị tùy chỉnh cho thời gian bắt buộc tối thiểu giữa các phiên.

Chữ ký phương thức

void setMinTimeBetweenSessions(int seconds)

Ví dụ:

AppsFlyer.setMinTimeBetweenSessions(4);

Mô tả

Đặt email của người dùng và mã hóa chúng.

Chữ ký phương thức

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

Ví dụ:

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

Mô tả

Đặt một máy chủ tùy chỉnh

Chữ ký phương thức

void setHost(string hostPrefixName, string hostName)

Ví dụ:

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

Mô tả

Đăng ký trình nghe dữ liệu chuyển đổi để cho phép truy cập vào dữ liệu phân bổ của người dùng trong thời gian thực cho mỗi lượt cài đặt mới, trực tiếp từ cấp SDK. Bằng cách này, hãy cung cấp cho người dùng nội dung được cá nhân hóa hoặc đưa họ đến các hoạt động cụ thể trong ứng dụng, điều này có thể nâng cao đáng kể mức độ thu hút của họ với ứng dụng của bạn.

Chữ ký phương thức

void getConversionData(string objectName);

Ví dụ:

AppsFlyer.getConversionData(gameObject.name);

Mô tả

Để phân bổ lượt nhấp và khởi chạy trang ứng dụng của cửa hàng ứng dụng.

Chữ ký phương thức

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

Ví dụ:

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);            

Mô tả

Để phân bổ một lượt hiển thị, hãy sử dụng lệnh gọi API sau. Đảm bảo sử dụng ID Ứng dụng được quảng cáo y hệt như ID xuất hiện trong bảng điều khiển của AppsFlyer.

Chữ ký phương thức

void recordCrossPromoteImpression(string appID, string campaign);

Ví dụ:

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

Mô tả

Lớp LinkGenerator xây dựng URL mời theo nhiều phương thức setter khác nhau, cho phép truyền thông tin bổ sung khi nhấp chuột.

Chữ ký phương thức

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

Ví dụ:

AppsFlyer.generateUserInviteLink(params, this);

Mô tả

Chữ ký phương thức

public void onAppOpenAttribution(string validateResult)

Ví dụ:

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

Mô tả

Chữ ký phương thức

public void onAppOpenAttributionFailure (string error)

Ví dụ:

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

Mô tả

Phương thức được sử dụng để nhận dữ liệu chuyển đổi. Hữu ích cho liên kết sâu bị trì hoãn. Tìm hiểu thêm.

• SDK v5 trở về trước: onConversionDataSuccess
• Trước SDK v5: onConversionDataReceived 

Chữ ký phương thức

public void onConversionDataSuccess(string conversionData)

Ví dụ:

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

Mô tả

Chữ ký phương thức

public void onConversionDataFail(string error)

Ví dụ:

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

Mô tả

Gọi lại thành công để tạo URL OneLink.

Chữ ký phương thức

public void onInviteLinkGenerated(string link)

Ví dụ:

public void onInviteLinkGenerated(string link)
            {
            }

Mô tả

Lỗi khi gọi lại để tạo URL OneLink.

Chữ ký phương thức

public void onInviteLinkGeneratedFailure(string error)

Ví dụ:

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

Mô tả

Gọi lại thành công cho API validateAndSendInAppPurchase.

Đối với Android: Gọi lại trả về "Validate success" (Xác thực thành công).
Đối với iOS: Gọi lại trả về một chuỗi JSON từ API verifyReceipt của Apple.

Chữ ký phương thức

public void didFinishValidateReceipt(string result)

Ví dụ:

public void didFinishValidateReceipt(string result)
            {
            }

Mô tả

Lỗi khi gọi lại để xác thực biên lai.

Chữ ký phương thức

public void didFinishValidateReceiptWithError(string error)

Ví dụ:

public void didFinishValidateReceiptWithError(string error)
            {
            }

Mô tả

Được sử dụng để đặt số điện thoại của người dùng.

Chữ ký phương thức

void setPhoneNumber(string phoneNumber)

Ví dụ:

AppsFlyer.setPhoneNumber("4166358181");

Mô tả

Được các nhà quảng cáo sử dụng để không cho tất cả các mạng/đối tác tích hợp được lấy dữ liệu. Tìm hiểu thêm

Chữ ký phương thức

void setSharingFilterForAllPartners()

Ví dụ:

AppsFlyer.setSharingFilterForAllPartners();

Mô tả

Chữ ký phương thức

void setSharingFilter(params string[] partners)

Ví dụ:

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

Mô tả

Bỏ qua Token thiết bị Firebase theo cách thủ công để đo lường lượt gỡ cài đặt.

Chữ ký phương thức

void updateServerUninstallToken(string token)

Ví dụ:

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

Mô tả

Để gửi IMEI đến AppsFlyer một cách rõ ràng.

Chữ ký phương thức

void setImeiData(string imei)

Ví dụ:

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

Mô tả

 Để gửi ID Android đến AppsFlyer một cách rõ ràng.

Chữ ký phương thức

void setAndroidIdData(string androidId)

Ví dụ:

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

Mô tả

Tính năng này bảo đảm rằng SDK không bắt đầu hoạt động cho đến khi customerUserID được cung cấp.

Chữ ký phương thức

void waitForCustomerUserId(bool wait)

Ví dụ:

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

Mô tả

Để cung cấp cho SDK customer user id liên quan và kích hoạt SDK bắt đầu hoạt động thường lệ của mình.

Chữ ký phương thức

void setCustomerIdAndStartSDK(string id)

Ví dụ:

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

Mô tả

Nhận giá trị AF_STORE hiện tại.

Chữ ký phương thức

string getOutOfStore()

Ví dụ:

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

Mô tả

Đặt giá trị AF_STORE theo cách thủ công.

Chữ ký phương thức

void setOutOfStore(string sourceName)

Ví dụ:

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

Mô tả

Lựa chọn không tham gia thu thập ID Android. Nếu ứng dụng KHÔNG chứa Google Play Services, ID Android sẽ được SDK thu thập. Tuy nhiên, các ứng dụng có Google play services nên tránh thu thập ID Android vì điều này vi phạm chính sách của Google Play.

Chữ ký phương thức

void setCollectAndroidID(bool isCollect)

Ví dụ:

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

Mô tả

Lựa chọn không tham gia thu thập IMEI. Nếu ứng dụng KHÔNG chứa Google Play Services, IMEI của thiết bị sẽ được trình cắm thu thập. Tuy nhiên, các ứng dụng có Google play services nên tránh thu thập IMEI vì điều này vi phạm chính sách của Google Play.

Chữ ký phương thức

void setCollectIMEI(bool isCollect)

Ví dụ:

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

Mô tả

Đặt thủ công là ứng dụng đã được cập nhật.

Chữ ký phương thức

void setIsUpdate(bool isUpdate)

Ví dụ:

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

Mô tả

Chỉ định nhà sản xuất hoặc tên nguồn truyền thông mà cài đặt sẵn được phân bổ.

Chữ ký phương thức

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

Ví dụ:

#if UNITY_ANDROID && !UNITY_EDITOR
            AppsFlyerAndroid.setPreinstallAttribution("mediaSource", "campaign", "siteId");
            #endif

Mô tả

Chỉ báo Boolean do nhà sản xuất cài đặt sẵn.

Chữ ký phương thức

bool isPreInstalledApp()

Ví dụ:

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

Mô tả

Nhận ID phân bổ Facebook, nếu có.

Chữ ký phương thức

string getAttributionId()

Ví dụ:

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

Mô tả

Nhận thông báo đẩy được ghi nhận.

Chữ ký phương thức

void handlePushNotifications()

Ví dụ:

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

Mô tả

API để xác minh máy chủ cho mua hàng trong ứng dụng. Sự kiện af_purchase với các giá trị liên quan sẽ được gửi tự động nếu xác thực thành công.

Chữ ký phương thức

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

Ví dụ:

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

Mô tả

Đặt cờ này thành true, để thu thập tên thiết bị hiện tại (ví dụ: "iPhone của tôi"). Giá trị mặc định là "false". 

Chữ ký phương thức

void setShouldCollectDeviceName(bool shouldCollectDeviceName)

Ví dụ:

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

Mô tả

Lựa chọn không tham gia phân bổ Apple Search Ads.

Chữ ký phương thức

void setDisableCollectIAd(bool disableCollectIAd)

Ví dụ:

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

Mô tả

Xác thực biên lai mua hàng trong ứng dụng trong môi trường Apple (sản xuất hoặc sandbox). Giá trị mặc định là "false".

Chữ ký phương thức

void setUseReceiptValidationSandbox(bool useReceiptValidationSandbox)

Ví dụ:

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

Mô tả

Đặt cờ này để thử nghiệm gỡ cài đặt trong môi trường Apple (sản xuất hoặc sandbox). Giá trị mặc định là "false".

Chữ ký phương thức

void setUseUninstallSandbox(bool useUninstallSandbox)

Ví dụ:

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

Mô tả

Để gửi và xác thực mua hàng trong ứng dụng, hãy gọi phương thức này từ phương thức processPurchase.

Chữ ký phương thức

void validateAndSendInAppPurchase
(string productIdentifier, string price, string currency, string tranactionId, 
Dictionary<string, string> additionalParameters, MonoBehaviour gameObject)

Ví dụ:

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

Mô tả

Đăng ký thông báo từ xa và cung cấp cho AppsFlyer token thiết bị đẩy.

Chữ ký phương thức

void registerUninstall(byte[] deviceToken)

Ví dụ:

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

Mô tả

Được sử dụng để ghi nhận liên kết sâu theo cách thủ công.

Chữ ký phương thức

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

Ví dụ:

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

Mô tả

Cho phép bạn sử dụng thành phần StoreKit để mở App Store trong khi vẫn ở trong bối cảnh ứng dụng của bạn. Tìm hiểu thêm.

Chữ ký phương thức

public void onOpenStoreLinkGenerated(string link)

Ví dụ:

public void onOpenStoreLinkGenerated(string link)
            {
            }

Mô tả

Cho phép bạn tắt phân bổ SKAdNetwork. Đặt thành "true" để tắt.

Chữ ký phương thức

bools disableSKAdNetwork(int isDisabled)

Ví dụ:

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

Mô tả

Được sử dụng nếu bạn muốn yêu cầu ủy quyền người dùng thông qua cửa sổ bật lên trước khi truy cập dữ liệu liên quan đến ứng dụng để ghi nhận người dùng hoặc thiết bị (ví dụ: IDFA). Nếu người dùng chọn tham gia, IDFA sẽ được chuyển đến SDK. Khoảng thời gian chờ cấp cho người dùng một khoảng thời gian nhất định để chọn tham gia hoạt động thu thập IDFA. Sau khi bộ định thời hết hạn, IDFA không được thu thập.

Chữ ký phương thức

void waitForATTUserAuthorizationWithTimeoutInterval(int timeoutInterval)

Ví dụ:

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