Tổng quan

AppsFlyerLib là lớp chính của SDK Android của AppsFlyer và đóng gói hầu hết các phương thức.

Quay lại phần chỉ mục tham chiếu SDK.

Nhập thư viện

import com.appsflyer.AppsFlyerLib;

Truy cập phiên bản SDK

Truy cập phiên bản singleton SDK:

AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();

Phương thức

addPushNotificationDeepLinkPath

Chữ ký phương thức

void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)

Mô tả
Cấu hình cách SDK trích xuất các giá trị liên kết sâu từ các nội dung thông báo đẩy.

Đối số đầu vào

LoạiTênMô tả
String...deepLinkPathMột mảng các Stringtương ứng với đường dẫn JSON của liên kết sâu.

Kết quả trả về
void.

Ví dụ cách dùng
Cấu hình cơ bản

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link")

Cấu hình nâng cao

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link")

Lệnh gọi này khớp với cấu trúc tải trọng sau:

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

anonymizeUser

Chữ ký phương thức

void anonymizeUser(boolean shouldAnonymize)

Mô tả
Ẩn danh cài đặt, sự kiện và các phiên của người dùng.

Đối số đầu vào

LoạiTênMô tả
booleanshouldAnonymizeMặc định là false.

Kết quả trả về
void

Ví dụ cách dùng

AppsFlyerLib.getInstance().anonymizeUser(true);
AppsFlyerLib.getInstance().anonymizeUser(true)

appendParametersToDeepLinkingURL

Chữ ký phương thức

void appendParametersToDeepLinkingURL(java.lang.String contains,
                                                      java.util.Map<java.lang.String,java.lang.String> parameters)

Mô tả
Enables app owners using App Links for deep linking (without OneLink) to attribute sessions initiated via a domain associated with their app.

🚧

Gọi ra phương thức này trước khi gọi start

Bạn phải cung cấp các thông số sau trong parameters Map:

  • pid
  • is_retargeting phải được đặt thành true

Đối số đầu vào

LoạiTênMô tả
Stringcontains Một chuỗi có trong URL liên kết sâu
Map<String, String>parametersThông số phân bổ sẽ được thêm vào các URL phù hợp

Kết quả trả về
void

Ví dụ cách dùng

HashMap<String, String> urlParameters = new HashMap<>();
urlParameters.put("pid", "exampleDomain"); // Required
urlParameters.put("is_retargeting", "true"); // Required
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com", urlParameters);
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com",
mapOf("pid" to "exampleDomain", "is_retargeting" to "true")) // Required

Trong ví dụ trên, URL phân bổ kết quả được gửi đến máy chủ AppsFlyer là:

example.com?pid=exampleDomain&is_retargeting=true

enableFacebookDeferredApplinks

Chữ ký phương thức

void enableFacebookDeferredApplinks(boolean isEnabled)

Mô tả
Bật bộ tính năng thu thập Liên kết Ứng dụng Hoãn lại của Facebook. Yêu cầu SDK Facebook và ứng dụng Facebook trên thiết bị mục tiêu/khách hàng.

API này phải được gọi ra trước khi khởi tạo SDK AppsFlyer để có thể hoạt động bình thường.
Đối số đầu vào

LoạiTênMô tả
booleanisEnabled Các liên kết ứng dụng hoãn lại của Facebook phải được xử lý bởi SDK AppsFlyer.

Kết quả trả về
void

enableLocationCollection

Đã xóa trong V6.8.0

Chữ ký phương thức

AppsFlyerLib enableLocationCollection(boolean flag)

Mô tả
Bật SDK AppsFlyer để thu thập vị trí được xác định gần đây nhất. Yêu cầu ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION Quyền kê khai.

Đối số đầu vào

LoạiTênMô tả
booleanflag

Kết quả trả về
void

enableTCFDataCollection

Chữ ký phương thức

AppsFlyerLib enableTCFDataCollection (boolean flag)

Mô tả

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

Đối số đầu vào

LoạiTênMô tả
booleanflagA boolean value to enable (true) or disable (false) the collection of TCF data. The SDK collects TCF data when the flag is set to true.

Kết quả trả về
void

getAppsFlyerUID

Chữ ký phương thức

java.lang.String getAppsFlyerUID(Context context)

Mô tả
Nhận ID thiết bị duy nhất của AppsFlyer. SDK sẽ tạo ra một ID thiết bị duy nhất của AppsFlyer khi cài đặt ứng dụng. Khi SDK khởi động, ID này sẽ được ghi nhận là ID của lượt cài đặt ứng dụng đầu tiên.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
ID thiết bị duy nhất của AppsFlyer.

Ví dụ cách dùng

String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this)

getAttributionId

Chữ ký phương thức

java.lang.String getAttributionId(Context context)

Mô tả
Nhận ID phân bổ Facebook, nếu có.

Đối số đầu vào

LoạiTênMô tả
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
void

Ví dụ cách dùng

String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)

getHostName

Chữ ký phương thức

java.lang.String getHostName()

Mô tả
Nhận tên máy chủ lưu trữ.
Giá trị mặc định là "appsflyer.com"

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về

LoạiMô tả
StringTên máy chủ được đặt hiện tại.

Ví dụ cách dùng

getHostPrefix

Chữ ký phương thức

java.lang.String getHostPrefix()

Mô tả
Nhận tiền tố máy chủ được đặt tùy chỉnh.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về
Tiền tố máy chủ.

getInstance

Chữ ký phương thức

AppsFlyerLib getInstance()

Mô tả
Trả về phiên bản SDK, qua đó bạn có thể truy cập các phương thức được mô tả trong tài liệu này.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về
Phiên bản singleton AppsFlyerLib.

getOutOfStore

Chữ ký phương thức

java.lang.String getOutOfStore(Context context)

Mô tả
Nhận giá trị liên kết giới thiệu cửa hàng ứng dụng của bên thứ ba.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
AF_Store giá trị.

getSdkVersion

Chữ ký phương thức

java.lang.String getSdkVersion()

Mô tả
Tải phiên bản SDK AppsFlyer được sử dụng trong ứng dụng.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về
Phiên bản SDK AppsFlyer.

init

Chữ ký phương thức

AppsFlyerLib init(java.lang.String key,
                                  AppsFlyerConversionListener conversionDataListener,
                                  Context context)

Mô tả
Sử dụng phương thức này để khởi tạo SDK AppsFlyer. API này nên được gọi ra bên trong phương thức onCreate .

Đối số đầu vào

LoạiTênMô tả
StringkeyDev key AppsFlyer
AppsFlyerConversionDataListenerconversionDataListener(Tùy chọn) triển khai AppsFlyerConversionDataListener để truy cập dữ liệu chuyển đổi của AppsFlyer. Có thể là null.
ContextcontextNgữ cảnh Ứng dụng.

Kết quả trả về
void

Ví dụ cách dùng
Xem phần khởi tạo SDK.

isPreInstalledApp

Chữ ký phương thức

boolean isPreInstalledApp(Context context)

Mô tả
Chỉ báo Boolean cho cài đặt sẵn bởi Nhà sản xuất.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
boolean.

Ví dụ cách dùng

isStopped

Chữ ký phương thức

boolean isStopped()

Mô tả
Kiểm tra xem SDK có bị dừng hay không.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về

LoạiMô tả
boolean true nếu dừng lại, nếu không là false .

Ví dụ cách dùng

logEvent

Chữ ký phương thức

void logEvent(Context context,
                              java.lang.String eventName,
                              java.util.Map<java.lang.String,java.lang.Object> eventValues)

Mô tả
Đăng nhập vào một sự kiện trong ứng dụng.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động
StringeventName Tên của sự kiện
MapeventValues Giá trị của sự kiện

Kết quả trả về
void

Ví dụ cách dùng

logEvent

Chữ ký phương thức

void logEvent(Context context,
                              java.lang.String eventName,
                              java.util.Map<java.lang.String,java.lang.Object> eventValues,
                              AppsFlyerRequestListener listener)

Mô tả
Tương tự như logEvent, với AppsFlyerRequestListener. HttpURLConnection.HTTP_OK từ
máy chủ sẽ gọi ra phương thức AppsFlyerRequestListener#onSuccess()
. AppsFlyerRequestListener#onError(int, String) sẽ trả về
lỗi trong trường hợp xảy ra lỗi

Đối số đầu vào
Hàm này không có thông số.
Kết quả trả về
void

Ví dụ cách dùng

logLocation

Chữ ký phương thức

void logLocation(Context context,
                                 double latitude,
                                 double longitude)

Mô tả
Ghi lại vị trí của người dùng theo cách thủ công.

Phương thức này tạo ra một sự kiện trong ứng dụng af_location_coordinates , với các thông số sự kiện af_lat and af_long .

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động
doublelatitude Vĩ độ
doublelongitude Kinh độ

Kết quả trả về
void

Ví dụ cách dùng

logSession

Chữ ký phương thức

void logSession(Context ctx)

Mô tả
Nếu ứng dụng của bạn là ứng dụng tiện ích chạy ngầm, thì bạn có thể sử dụng API này trong onCreate() của Hoạt động của bạn để ghi nhật ký và gửi phiên theo cách thủ công.

Đối số đầu vào

LoạiTênMô tả
ContextctxNgữ cảnh Ứng dụng / Hoạt động

Ví dụ cách dùng

public void logSession(Context context);
public void logSession(Context context)

Kết quả trả về
void

onPause

Chữ ký phương thức

void onPause(Context context)

Mô tả
Chỉ dành cho nền tảng Cocos2dx
Cocos2dx có sự kiện applicationDidEnterBackground của riêng mình.
Do đó 'onPause' sẽ được JNI gọi ra từ C++

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động

Kết quả trả về
void

Ví dụ cách dùng

performOnAppAttribution

Không còn được hỗ trợ kể từ phiên bản V6.3.2
Chữ ký phương thức

void performOnAppAttribution(Context context,
                                             java.net.URI link)

Mô tả
Được sử dụng để phân giải các liên kết sâu theo cách thủ công.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động
java.net.URIlink Liên kết cần phân giải

Kết quả trả về
void

Ví dụ cách dùng

AppsFlyerLib.getInstance().performOnAppAttribution(context, uri);
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri)

performOnDeepLinking

Được thêm vào V6.3.1+

Chữ ký phương thức

 public void performOnDeepLinking(@NonNull Intent intent, @NonNull Context context);

Mô tả
Cho phép kích hoạt giải pháp liên kết sâu theo cách thủ công. Phương thức này cho phép các ứng dụng đang trì hoãn lệnh gọi start xử lý các liên kết sâu trước khi SDK bắt đầu.

  • Nếu một DeepLinkListener được đăng ký, hỗ trợ cả liên kết sâu bị trì hoãn và liên kết sâu trực tiếp
  • Nếu một AppsFlyerConversionListener được đăng ký, chỉ hỗ trợ liên kết sâu trực tiếp

Bạn nên gọi phương thức này, với một Activity, từ onResume, cho các hoạt động có thể được khởi chạy thông qua liên kết sâu.
Lưu ý: Các liên kết sâu trực tiếp được API này xử lý sẽ không được báo cáo cho máy chủ.

Ví dụ cách dùng

@Override
protected void onResume() {
  super.onResume();

  AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
  appsflyer.performOnDeepLinking(getIntent(),this);
}

Đối số đầu vào

LoạiTênMô tả
Intentintent
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
void

registerConversionListener

Chữ ký phương thức

void registerConversionListener(Context context,
                                                AppsFlyerConversionListener conversionDataListener)

Mô tả
Đăng ký trình nghe dữ liệu chuyển đổi. Bạn cũng có thể sử dụng init để đăng ký trình nghe.

Đối số đầu vào

LoạiTênMô tả
Contextcontext Ngữ cảnh Ứng dụng / Hoạt động.
AppsFlyerConversionListenerconversionDataListenerThe AppsFlyerConversionListener cần đăng ký.

Kết quả trả về
void

Ví dụ cách dùng

// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener);
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener)

Đây là một ví dụ thực hiện của AppsFlyerConversionListener.

registerValidatorListener (LEGACY)

Chữ ký phương thức

void registerValidatorListener(Context context,
                                               AppsFlyerInAppPurchaseValidatorListener validationListener)

Mô tả
Đăng ký một trình nghe xác thực cho API validateAndLogInAppPurchase .

Đối số đầu vào

LoạiTênMô tả
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.
AppsFlyerInAppPurchaseValidatorListenervalidationListenerThe AppsFlyerInAppPurchaseValidatorListener cần đăng ký.

Kết quả trả về
void

Ví dụ cách dùng

sendAdRevenue

Chữ ký phương thức

void sendAdRevenue(Context context,
                                   java.util.Map<java.lang.String,java.lang.Object> eventValues)

Mô tả

Đối số đầu vào

LoạiTênMô tả
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.
Map<String, Object>validationListener

Kết quả trả về
void

sendPushNotificationData

Chữ ký phương thức

void sendPushNotificationData(Activity activity)

Mô tả
Đo lường và nhận dữ liệu từ các chiến dịch thông báo đẩy. Gọi ra phương thức này bên trong phương thức onCreate của các Activityđược khởi chạy từ thông báo đẩy.

Đối số đầu vào

LoạiTênMô tả
ActivityactivityThe Activity được khởi chạy thông qua thông báo.

Kết quả trả về
void.

Ví dụ cách dùng

setAdditionalData

📘

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

Chữ ký phương thức

void setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> customData)

Mô tả
Sử dụng để thêm dữ liệu tùy chỉnh vào tải trọng của sự kiện. Dữ liệu sẽ xuất hiện trong các báo cáo dữ liệu thô.
Đối số đầu vào

LoạiTênMô tả
HashMapcustomData

Kết quả trả về
void.

setAndroidIdData

Chữ ký phương thức

void setAndroidIdData(java.lang.String aAndroidId)

Mô tả
SDK mặc định không thu thập IMEI và ID Android nếu phiên bản Android cao hơn KitKat (4.4) và thiết bị chứa Google Play Services. Sử dụng API này để gửi ID Android đến AppsFlyer một cách cụ thể.

Đối số đầu vào

LoạiTênMô tả
StringaAndroidIdID thiết bị Android.

Kết quả trả về
void

setAppId

Chữ ký phương thức

void setAppId(java.lang.String id)

Mô tả

Đối số đầu vào

LoạiTênMô tả
StringidID Ứng dụng Android.

Kết quả trả về
void

setAppInviteOneLink

Chữ ký phương thức

void setAppInviteOneLink(java.lang.String oneLinkId)

Mô tả
Đặt ID OneLink sẽ được sử dụng để phân bổ Lời mời người dùng. Liên kết được tạo cho lời mời người dùng sẽ sử dụng OneLink này làm liên kết cơ sở. Xem phần cài đặt OneLink để phân bổ lời mời người dùng.

Đối số đầu vào

LoạiTênMô tả
StringoneLinkIdID OneLink thu được từ Bảng điều khiển AppsFlyer.

Kết quả trả về
void.

setCollectAndroidID

Chữ ký phương thức

void setCollectAndroidID(boolean isCollect)

Mô tả
Chọn thu thập ID Android. Buộc SDK thu thập ID Android.

Đối số đầu vào

LoạiTênMô tả
booleanisCollectĐặt thành true để lựa chọn tham gia.

Kết quả trả về
void.

setCollectIMEI

Chữ ký phương thức

void setCollectIMEI(boolean isCollect)

Mô tả
Chọn thu thập IMEI. Buộc SDK thu thập IMEI.

Đối số đầu vào

LoạiTênMô tả
booleanisCollectĐặt thành true để lựa chọn tham gia.

Kết quả trả về
void.

setCollectOaid

Chữ ký phương thức

void setCollectOaid(boolean isCollect)

Mô tả
Chọn thu thập/không thu thập OAID. Theo mặc định, SDK sẽ cố gắng thu thập OAID.

Đối số đầu vào

LoạiTênMô tả
booleanisCollectMặc định là true. Đặt thành false để lựa chọn không tham gia.

Kết quả trả về
void.

setConsentData

Chữ ký phương thức

AppsFlyerLib.getInstance().setConsentData(AppsFlyerConsent afConsent)

Mô tả

Transfers consent data to the SDK.

Đối số đầu vào

LoạiTênMô tả
AppsFlyerConsentafConsentAn object containing user consent data

setCurrencyCode

Chữ ký phương thức

void setCurrencyCode(java.lang.String currencyCode)

Mô tả
Thiết lập đơn vị tiền tệ để mua hàng trong ứng dụng. Mã tiền tệ phải là mã ISO 4217 gồm 3 ký tự.

Đối số đầu vào

LoạiTênMô tả
StringcurrencyCode3 character ISO 4217 code. Defaults to "USD".

Kết quả trả về
void.

setCustomerIdAndLogSession

⚠️

Before calling this method, the method waitForCustomerUserId must be called

Chữ ký phương thức

void setCustomerIdAndLogSession(java.lang.String id,
                                                Context context)

Mô tả
Sử dụng để đặt customer user id và khởi động SDK.

Đối số đầu vào

LoạiTênMô tả
StringidID Khách hàng cho khách hàng.
StringcontextNgữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
void

setCustomerUserId

Chữ ký phương thức

void setCustomerUserId(java.lang.String id)

Mô tả
Việc thiết lập ID khách hàng riêng cho phép bạn tham chiếu chéo ID duy nhất của bạn với ID duy nhất của AppsFlyer và ID của thiết bị khác.
ID này có sẵn trong các báo cáo dữ liệu thô và trong các API Postback lại để tham chiếu chéo với các ID nội bộ của bạn.

Đối số đầu vào

LoạiTênMô tả
StringidID Khách hàng cho khách hàng.

Kết quả trả về
void.

setDebugLog

Chữ ký phương thức

void setDebugLog(boolean shouldEnable)

Mô tả
Bật nhật ký Gỡ lỗi cho SDK AppsFlyer. Chỉ nên được đặt thành true trong môi trường phát triển.

Đối số đầu vào

LoạiTênMô tả
booleanshouldEnableMặc định là false.

Kết quả trả về
void.

Ví dụ cách dùng

setDisableAdvertisingIdentifiers

Đã được thêm vào V6.3.2
Chữ ký phương thức

void setDisableAdvertisingIdentifiers(boolean disable);

Mô tả
Tắt chức năng thu thập các ID quảng cáo khác nhau của SDK. Điều này bao gồm ID quảng cáo Google (GAID), OAID và ID quảng cáo Amazon (AAID).

Đối số đầu vào

LoạiTênMô tả
booleandisableMặc định là false.

Kết quả trả về
void.

setDisableNetworkData

Đã bổ sung vào V6.7.0
Chữ ký phương thức

void setDisableNetworkData(boolean disable);

Mô tả
Sử dụng để chọn không thu thập tên nhà cung cấp dịch vụ mạng (nhà cung cấp dịch vụ) và tên nhà cung cấp dịch vụ SIM từ thiết bị.

Đối số đầu vào

LoạiTênMô tả
booleandisableMặc định là false.

Kết quả trả về
void.

setExtension

Chữ ký phương thức

void setExtension(java.lang.String extension)

Mô tả
Các trình cắm và phần mở rộng SDK sẽ đặt trường này.

Đối số đầu vào

LoạiTênMô tả
StringextensionTên phần mở rộng.

Kết quả trả về
void.

setHost

Chữ ký phương thức

void setHost(java.lang.String hostPrefixName,
                             java.lang.String hostName)

Mô tả
Thiết lập một máy chủ tùy chỉnh. Lưu ý: Bắt đầu từ SDK V6.10, nếu máy chủ được gửi cùng với một giá trị trống hoặc rỗng, lệnh gọi API sẽ bị bỏ qua.

Đối số đầu vào

LoạiTênMô tả
StringhostPrefixNameTiền tố máy chủ.
StringhostNameTên máy chủ.

Kết quả trả về
void.

setImeiData

Chữ ký phương thức

void setImeiData(java.lang.String aImei)

Mô tả
SDK mặc định không thu thập IMEI và Android ID nếu phiên bản OS cao hơn KitKat (4.4) và ứng dụng chứa các Dịch vụ Google Play.

Đối số đầu vào

LoạiTênMô tả
StringaImeiIMEI của thiết bị.

Kết quả trả về
void.

setIsUpdate

Chữ ký phương thức

void setIsUpdate(boolean isUpdate)

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

Đối số đầu vào

LoạiTênMô tả
booleanisUpdate

Kết quả trả về
void.

setLogLevel

Chữ ký phương thức

void setLogLevel(AFLogger.LogLevel logLevel)

Mô tả
Thiết lập mức ghi nhật ký SDK.

Đối số đầu vào

LoạiTênMô tả
StringlogLevelMức ghi nhật ký.

Kết quả trả về
void.

setMinTimeBetweenSessions

Chữ ký phương thức

void setMinTimeBetweenSessions(int seconds)

Mô 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.

Đối số đầu vào

LoạiTênMô tả
intsecondsĐặt thời gian tối thiểu giữa hai lần khởi chạy ứng dụng để được tính là hai phiên riêng biệt. Nếu chưa đặt, thời gian tối thiểu mặc định giữa các phiên sẽ là 5 giây.

Kết quả trả về
void.

setOaidData

Chữ ký phương thức

void setOaidData(java.lang.String oaid)

Mô tả
Theo mặc định, OAID không được SDK thu thập. Sử dụng API này để gửi OAID đến AppsFlyer một cách cụ thể.

Đối số đầu vào

LoạiTênMô tả
StringoaidOAID của thiết bị.

Kết quả trả về
void.

setOneLinkCustomDomain

Chữ ký phương thức

void setOneLinkCustomDomain(java.lang.String... domains)

Mô tả
Để SDK AppsFlyer phân giải thành công các thông số phân bổ ẩn (được giải mã trong ID liên kết rút gọn), thì bất kỳ miền nào được cấu hình làm miền gắn thương hiệu trong Bảng điều khiển AppsFlyer đều phải được cung cấp cho phương thức này.

Đối số đầu vào

LoạiTênMô tả
String...domainsMảng miền mà SDK sẽ coi là miền gắn thương hiệu (SDK sẽ cố gắng phân giải chúng dưới dạng OneLinks).

Kết quả trả về
void.

setOutOfStore

Chữ ký phương thức

void setOutOfStore(java.lang.String sourceName)

Mô tả
Chỉ định cửa hàng ứng dụng thay thế mà ứng dụng được tải xuống từ đó.

Đối số đầu vào

LoạiTênMô tả
StringsourceNameTên cửa hàng ứng dụng của bên thứ ba.

Kết quả trả về
void.

Ví dụ cách dùng

AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")

setPartnerData

Chữ ký phương thức

void setPartnerData(@NonNull String partnerId, Map<String, Object> data);

Mô tả
Cho phép gửi dữ liệu tùy chỉnh cho mục đích tích hợp đối tác.

Đối số đầu vào

LoạiTênMô tả
StringpartnerIdID của đối tác (thường kèm theo "_int").
MapdataDữ liệu khách hàng, phụ thuộc vào cấu hình tích hợp với đối tác cụ thể.

Kết quả trả về
void.

Ví dụ cách dùng

Map<String, Object> partnerData = new HashMap();
partnerData.put("puid", "123456789");
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData);
val partnerData = mapOf("puid" to "123456789")
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData)

setPhoneNumber

Chữ ký phương thức

void setPhoneNumber(java.lang.String phoneNumber)

Mô tả
Sẽ được gửi dưới dạng chuỗi được mã hóa SHA-256.

Đối số đầu vào

LoạiTênMô tả
StringphoneNumber

Kết quả trả về
void.

setPreinstallAttribution

Chữ ký phương thức

void setPreinstallAttribution(java.lang.String mediaSource,
                                              java.lang.String campaign,
                                              java.lang.String siteId)

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ổ.
Đối số đầu vào

LoạiTênMô tả
StringmediaSourceNhà sản xuất hoặc tên nguồn truyền thông cho phân bổ cài đặt sẵn.
StringcampaignTên chiến dịch cho phân bổ cài đặt sẵn.
StringsiteIdID trang web cho phân bổ cài đặt sẵn.

Kết quả trả về
void.

setResolveDeepLinkURLs

Chữ ký phương thức

void setResolveDeepLinkURLs(java.lang.String... urls)

Mô tả
Các nhà quảng cáo có thể ẩn một Liên kết OneLink AppsFlyer trong một Liên kết Chung khác. Liên kết Chung này sẽ gọi ra ứng dụng nhưng mọi dữ liệu liên kết sâu đều sẽ không truyền đến AppsFlyer.

setResolveDeepLinkURLs cho phép bạn cấu hình SDK để phân giải các URL OneLink được ẩn, để liên kết sâu có thể diễn ra chính xác.

Đối số đầu vào

LoạiTênMô tả
String...urlsĐảm bảo cung cấp các URL hiện.

Kết quả trả về
void

Ví dụ cách dùng

AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");

setSharingFilterForPartners

Đã thêm vào V6.4
Chữ ký phương thức

void setSharingFilterForPartners(java.lang.String... partners)

This function replaces the deprecated setSharingFilter and setSharingFilterForAllPartners

Mô tả
Cho phép bạn cấu hình cách SDK loại trừ đối tác khỏi việc chia sẻ dữ liệu.

Đối số đầu vào

LoạiTênMô tả
String...partnersMột hoặc nhiều mã định danh đối tác mà bạn muốn loại trừ. Chỉ được bao gồm các chữ cái/chữ số và dấu gạch dưới. Độ dài ID đối tác tối đa: 45

Lưu ý:
To find out the required partner IDs:

  1. Run the Get active integrations API for a list of all active integrations
  2. Sử dụng phương thức media_source_name values from the API response as input values to the method partners array.

Exceptions:

  • For Twitter, use twitter (and not twitter_int)

Ví dụ cách dùng

AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int"); // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int"); // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all"); // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners(); // Reset list (default)
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int") // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int") // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all") // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("") // Reset list (default)

setSharingFilter

Không còn được hỗ trợ trong V6.4
Chữ ký phương thức

void setSharingFilter(java.lang.String... partners)

This function is deprecated and has been replaced by setSharingFilterForPartners

Mô tả
Stops events from propagating to the specified AppsFlyer partners.
(Deprecated and replaced by setSharingFilterForPartners)
Input arguments

LoạiTênMô tả
String...partnersMột hoặc nhiều mã định danh đối tác. Chỉ được bao gồm các chữ cái/chữ số và dấu gạch dưới. Độ dài tối đa: 45

Kết quả trả về
void

setSharingFilterForAllPartners

Không còn được hỗ trợ trong V6.4
Chữ ký phương thức

void setSharingFilterForAllPartners()

This function is deprecated and has been replaced by setSharingFilterForPartners

Mô tả
Ngăn sự kiện truyền tới tất cả các đối tác của AppsFlyer. Ghi đè setSharingFilter.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về
void

setUserEmails

Chữ ký phương thức

void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
                                   java.lang.String... emails)

Mô tả
Thiết lập email của người dùng và mã hóa chúng.

Đối số đầu vào

LoạiTênMô tả
AppsFlyerProperties.EmailsCryptTypecryptMethodCác phương thức mã hóa:
  • AppsFlyerProperties.EmailsCryptType.NONE
  • AppsFlyerProperties.EmailsCryptType.SHA256
String...emailsMột hoặc nhiều email của người dùng.

Kết quả trả về
void.

start

Chữ ký phương thức

void start(Context context,
                           java.lang.String key,
                           AppsFlyerRequestListener listener)

Mô tả
Khởi động SDK.

Đối số đầu vào

LoạiTênMô tả
ContextcontextLà Ngữ cảnh Ứng dụng nếu là gọi ra trong phương thức onCreate của Ứng dụng, và là Ngữ cảnh Hoạt động nếu gọi ra sau phương thức này của Hoạt động: onResume .
StringkeyDev key AppsFlyer của bạn
AppsFlyerRequestListenerlistener(Tùy chọn) Trình nghe để nhận trạng thái yêu cầu.

Kết quả trả về
void.

Ví dụ cách dùng
Xem phần tích hợp SDK để biết ví dụ về triển khai.

stop

Chữ ký phương thức

void stop(boolean shouldStop,
                          Context context)

Mô tả
Khi API được thu hồi, SDK sẽ không còn giao tiếp được với các máy chủ của chúng tôi và dừng hoạt động.
Hữu ích khi triển khai tính năng chọn tham gia/chọn không tham gia của người dùng.

📘

SDK restart

Sau khi stop(true) was called, you need to call stop(false) and only then call start()

Đối số đầu vào

LoạiTênMô tả
booleanshouldStopphải ngừng ghi nhật ký.
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.

Kết quả trả về
void.

subscribeForDeepLink

Chữ ký phương thức

void subscribeForDeepLink(DeepLinkListener deepLinkListener,
                                          long timeout)

Mô tả

Đối số đầu vào

LoạiTênMô tả
DeepLinkListenerdeepLinkListener
longtimeoutTùy chọn.
Đơn vị tính bằng mili giây

Kết quả trả về
void

unregisterConversionListener

Chữ ký phương thức

void unregisterConversionListener()

Mô tả
Hủy đăng ký đã đăng ký trước đó AppsFlyerConversionListener.

Đối số đầu vào
Hàm này không có thông số.

Kết quả trả về
void

updateServerUninstallToken

Chữ ký phương thức

void updateServerUninstallToken(Context context,
                                                java.lang.String token)

Mô tảĐối với các nhà phát triển sử dụng Firebase cho các mục đích khác ngoài việc đo lường lượt gỡ cài đặt. Để biết thêm thông tin, vui lòng xem đo lường lượt gỡ cài đặt.

Đối số đầu vào

LoạiTênMô tả
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.
StringtokenToken Thiết bị Firebase.

Kết quả trả về
void

Ví dụ cách dùng

AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);

validateAndLogInAppPurchase

(Supported from SDK v.6.14.0)

Chữ ký phương thức

public abstract void validateAndLogInAppPurchase(@NonNull AFPurchaseDetails purchaseDetails,
                                                 @Nullable Map<String, String> additionalParameters,
                                                 @Nullable AppsFlyerInAppPurchaseValidationCallback validationCallback);

Mô tả
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.

Đối số đầu vào

TênLoạiMô tả
purchaseDetails *AFPurchaseDetailsAn object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.
additionalParametersMap<String, String>Additional parameters to log with the purchase.
validationCallback *AppsFlyerInAppPurchaseValidationCallback`A callback for delivering validation results.

Kết quả trả về
void

AFPurchaseDetails

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

data class AFPurchaseDetails(
    val purchaseType: AFPurchaseType,
    val purchaseToken: String,
    val productId: String,
    val price: String,
    val currency: String
)

AFPurchaseDetails parameters

TênLoạiMô tả
purchaseTypeAFPurchaseTypeField to distinguish between one-time purchases and subscriptions. The field can accept either subscription or one-time-purchase.
purchaseTokenchuỗiToken that uniquely identifies a purchase for a given item and user pair. Part of the Billing Library's Purchase class. To retrieve the token call the getPurchaseToken API
productIdchuỗiID of the product item that has been purchased. Also part of the Billing Library's Purchase class.
pricechuỗiThe full price of the one-time purchase or the subscription. Also part of the Billing Library's Purchase class.
currencychuỗiCurrency used to make the purchase.

validateAndLogInAppPurchase (LEGACY)

(Supported until SDK v.6.13.1)

Chữ ký phương thức

void validateAndLogInAppPurchase(Context context,
                                                 java.lang.String publicKey,
                                                 java.lang.String signature,
                                                 java.lang.String purchaseData,
                                                 java.lang.String price,
                                                 java.lang.String currency,
                                                 java.util.Map<java.lang.String,java.lang.String> additionalParameters)

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

Xem hướng dẫn chi tiết trong xác thực mua hàng.

Đối số đầu vào

LoạiTênMô tả
ContextcontextNgữ cảnh Ứng dụng / Hoạt động.
StringpublicKeyMã khóa Cấp phép lấy từ Google Play Console.
Stringsignaturedata.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data)
StringpurchaseDatadata.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data)
StringpriceGiá mua, phải được lấy từ skuDetails.getStringArrayList("DETAILS_LIST")
StringcurrencyĐơn vị tiền tệ mua hàng, phải được lấy từ skuDetails.getStringArrayList("DETAILS_LIST")
Map<String, String>additionalParametersCác thông số tự do được ghi lại cùng giao dịch mua (nếu được xác thực).

Kết quả trả về
void.

waitForCustomerUserId

Chữ ký phương thức

void waitForCustomerUserId(boolean wait)

Mô tả
Phương thức này trì hoãn quá trình khởi tạo SDK, cho đến khi một customerUserID được cung cấp.
Tất cả các sự kiện trong ứng dụng và bất kỳ lệnh gọi API SDK nào khác đều bị loại bỏ cho đến khi customerUserID được cung cấp và ghi lại.

Đối số đầu vào

LoạiTênMô tả
booleanwait

Kết quả trả về
void.

Ví dụ cách dùng

AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);