AppsFlyerLib
Tổng quan
AppsFlyerLib
là lớp chính của SDK iOS của AppsFlyer và đóng gói hầu hết các phương thức.
Để nhập AppsFlyerLib
:
// AppDelegate.h
#import <AppsFlyerLib/AppsFlyerLib.h>
@interface AppDelegate : UIResponder <UIApplicationDelegate, AppsFlyerLibDelegate>
@end
import AppsFlyerLib
Quay lại phần chỉ mục tham chiếu SDK.
Thuộc tính
advertisingIdentifier (read-only)
Khai báo thuộc tính
@property(nonatomic, strong, readonly) NSString *advertisingIdentifier
Mô tả
SDK AppsFlyer thu thập từ Apple advertisingIdentifier
if the AdSupport.framework
bao gồm trong SDK.
Bạn có thể vô hiệu hóa hoạt động này bằng cách đặt disableAdvertisingIdentifier
to true
.
Loại | Tên |
---|---|
NSString | advertisingIdentifier |
anonymizeUser
Khai báo thuộc tính
@property(atomic) BOOL anonymizeUser;
Mô tả
Chọn không tham gia ghi nhật ký đối với người dùng cụ thể
Loại | Tên |
---|---|
bool | anonymizeUser |
appInviteOneLinkID
Khai báo thuộc tính
@property(nonatomic, strong, nullable, setter = setAppInviteOneLink:) NSString * appInviteOneLinkID
Mô tả
Đặt ID OneLink của bạn từ cấu hình OneLink. Được sử dụng trong Lời mời Người dùng để tạo Liên kết OneLink.
Loại | Tên |
---|---|
NSString | appInviteOneLinkID |
appleAppID
Khai báo thuộc tính
@property(nonatomic, strong) NSString * appleAppID
Mô tả
Sử dụng thuộc tính này để đặt ID Apple cho ứng dụng của bạn (lấy từ trang của ứng dụng trên iTunes Connect)
Loại | Tên |
---|---|
NSString | appleAppID |
appsFlyerDevKey
Khai báo thuộc tính
@property(nonatomic, strong) NSString * appsFlyerDevKey
Mô tả
Sử dụng thuộc tính này để đặt dev key AppsFlyer của bạn.
Loại | Tên | Mô tả |
---|---|---|
NSString | appsFlyerDevKey | Dev key AppsFlyer của bạn. |
currencyCode
Khai báo thuộc tính
@property(nonatomic, strong, nullable) NSString *currencyCode
Mô tả
Trường hợp trong các sự kiện mua trong ứng dụng, bạn có thể đặt mã tiền tệ mà người dùng của bạn đã dùng để mua.
Mã tiền tệ là mã gồm 3 chữ cái theo tiêu chuẩn ISO.
Ví dụ cách dùng
[[AppsFlyerLib shared] setCurrencyCode:@"USD"];
AppsFlyerLib.shared().currencyCode = "USD"
customData
Cài đặt
customData
before first launch will have the additional data included in installs, sessions, as well as in-app events.
Khai báo thuộc tính
@property(nonatomic, strong, nullable, setter = setAdditionalData:) NSDictionary * 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. Bạn sẽ nhận được dữ liệu này trong các báo cáo dữ liệu thô.
Loại | Tên |
---|---|
NSDictionary | customData |
customerUserID
Khai báo thuộc tính
@property(nonatomic, strong, nullable) NSString * customerUserID
Mô tả
Trong trường hợp bạn sử dụng ID người dùng của riêng mình trong ứng dụng, bạn có thể đặt thuộc tính này thành ID đó.
Cho phép bạn tham chiếu chéo ID duy nhất của riêng mình với ID duy nhất của AppsFlyer và ID của các thiết bị khác
Loại | Tên |
---|---|
NSString | customerUserID |
deepLinkDelegate
Khai báo thuộc tính
@property(weak, nonatomic) id<AppsFlyerDeepLinkDelegate> deepLinkDelegate
Mô tả
Ủy nhiệm hàm thuộc tính của một đối tượng, tuân theo giao thức DeepLinkDelegate và triển khai các phương thức của nó.
Loại | Tên |
---|---|
DeepLinkDelegate | deepLinkDelegate |
Ví dụ cách dùng
AppsFlyerLib.shared().deepLinkDelegate = self
deepLinkTimeout
Mô tả
Hết thời gian chờ yêu cầu đối với Deferred Deeplinking.
Đơn vị tính bằng mili giây.
Khai báo thuộc tính
@property(nonatomic) NSUInteger deepLinkTimeout
Loại | Tên |
---|---|
NSUInteger | deepLinkTimeout |
delegate
Mô tả
Ủy nhiệm hàm AppsFlyer. Xem AppsFlyerLibDelegate.
Khai báo thuộc tính
@property (nonatomic, weak) id<AppsFlyerLibDelegate> delegate;
Loại | Tên |
---|---|
AppsFlyerLibDelegate | delegate |
disableAdvertisingIdentifier
Khai báo thuộc tính
@property (nonatomic) int disableAdvertisingIdentifier;
Mô tả
nếu AdSupport.framework
không bị tắt, SDK sẽ thu thập từ Apple advertisingIdentifier
.
Bạn có thể vô hiệu hóa hoạt động này bằng cách đặt thuộc tính sau thành YES
.
Loại | Tên |
---|---|
NSString | advertisingIdentifier |
disableAppleAdsAttribution
Khai báo thuộc tính
@property(nonatomic) BOOL disableAppleAdsAttribution
Mô tả
Disables AdServices framework-based attribution for Apple Search Ads.
Loại | Tên |
---|---|
bool | disableAppleAdsAttribution |
disableCollectASA
Khai báo thuộc tính
@property(atomic) BOOL disableCollectASA;
Mô tả
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.
Loại | Tên |
---|---|
bool | disableCollectASA |
disableIDFVCollection
Khai báo thuộc tính
@property(nonatomic) BOOL disableIDFVCollection;
Mô tả
Để tắt thu thập mã định danh nhà cung cấp ứng dụng (IDFV), hãy đặt disableIDFVCollection
to YES
.
Loại | Tên |
---|---|
bool | disableIDFVCollection |
disableSKAdNetwork
Khai báo thuộc tính
@property(nonatomic) BOOL disableSKAdNetwork
Mô tả
Loại | Tên |
---|---|
bool | disableSKAdNetwork |
facebookDeferredAppLink
Khai báo thuộc tính
@property (nonatomic, nullable) int *facebookDeferredAppLink;
Mô tả
Đặt liên kết ứng dụng Facebook bị hoãn lại theo cách thủ công.
Loại | Tên |
---|---|
NSString | advertisingIdentifier |
host (read-only)
Khai báo thuộc tính
@property(nonatomic, strong, readonly) NSString *host
Mô tả
Thuộc tính này chấp nhận một giá trị chuỗi đại diện cho tên máy chủ đối với tất cả các điểm cuối. Để thiết lập máy chủ, hãy sử dụng setHost.
Để sử dụng điểm cuối SDK mặc định – hãy đặt giá trị thành nil
.
Loại | Tên |
---|---|
NSString | host |
hostPrefix (read-only)
Khai báo thuộc tính
@property(nonatomic, strong, readonly) NSString *hostPrefix
Mô tả
Thuộc tính này chấp nhận một giá trị chuỗi đại diện cho tên máy chủ tiền tố đối với tất cả các điểm cuối. Để thiết lập máy chủ, hãy sử dụng setHost.
Loại | Tên |
---|---|
NSString | hostPrefix |
isDebug
Khai báo thuộc tính
@property(nonatomic) BOOL isDebug;
Mô tả
In thông báo SDK vào nhật ký bảng điều khiển. Nên bị vô hiệu hóa đối với các bản dựng phát triển.
Loại | Tên |
---|---|
bool | isDebug |
isStopped
Khai báo thuộc tính
@property(atomic) BOOL isStopped;
SDK Restart
Đặt
isStopped = true
and then setisStopped = false
No need to call
start()
Mô tả
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.
Loại | Tên |
---|---|
bool | isStopped |
minTimeBetweenSessions
Khai báo thuộc tính
@property(atomic) NSUInteger minTimeBetweenSessions;
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ại | Tên | Mô tả |
---|---|---|
NSUInteger | minTimeBetweenSessions | Đặ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 |
oneLinkCustomDomains
Khai báo thuộc tính
@property(nonatomic, nullable) NSArray<NSString *> *oneLinkCustomDomains;
Mô tả
Đối với các nhà quảng cáo sử dụng OneLinks chỉ của cá nhân.
Loại | Tên |
---|---|
NSArray<NSString *> | oneLinkCustomDomains |
phoneNumber
Khai báo thuộc tính
@property(nonatomic, nullable) NSString *phoneNumber
Mô tả
Loại | Tên |
---|---|
NSString | phoneNumber |
resolveDeepLinkURLs
Khai báo thuộc tính
@property(nonatomic, nullable) NSArray<NSString *> *resolveDeepLinkURLs;
Mô tả
Loại | Tên |
---|---|
NSArray<NSString *> | resolveDeepLinkURLs |
Ví dụ cách dùng
Một số dịch vụ của bên thứ ba như nhà cung cấp dịch vụ email (ESP) gói liên kết vào email với tên miền ghi nhận lượt nhấp của riêng họ. Một số dịch vụ thậm chí cho phép bạn thiết lập các miền ghi nhận lượt nhấp của riêng bạn. Nếu OneLink được gói trong các miền như vậy, điều này có thể giới hạn chức năng của nó.
Để khắc phục vấn đề này, hãy sử dụng setResolveDeepLinkURLs
để lấy OneLink từ các miền nhấp chuột khởi chạy ứng dụng. Đảm bảo gọi ra API này trước khi khởi tạo SDK.
Ví dụ, bạn có ba tên miền nhấp chuột chuyển hướng đến OneLink của bạn, đó là https://mysubdomain.onelink.me/abCD. Sử dụng API này để nhận OneLink mà miền nhấp chuột của bạn chuyển hướng đến. Phương thức API này nhận được danh sách các miền mà SDK giải quyết.
[AppsFlyerLib shared].resolveDeepLinkURLs = @[@"example.com",@"click.example.com"];
AppsFlyerLib.shared().resolveDeepLinkURLs = ["example.com", "click.example.com"]
Điều này cho phép bạn sử dụng tên miền nhấp chuột của mình trong khi vẫn duy trì chức năng OneLink. Các miền nhấp chuột có trách nhiệm khởi chạy ứng dụng. Còn API sẽ nhận được OneLink từ những miền nhấp chuột và sau đó bạn có thể sử dụng dữ liệu từ OneLink này để liên kết sâu và tùy chỉnh nội dung người dùng.
sharingFilter
Khai báo thuộc tính
@property(nonatomic, nullable) NSArray<NSString *> *sharingFilter;
Mô tả
Loại | Tên |
---|---|
NSArray<NSString *> | sharingFilter |
shouldCollectDeviceName
Khai báo thuộc tính
@property(nonatomic) BOOL shouldCollectDeviceName;
Mô tả
Đặt cờ này thành YES (Có), để thu thập tên thiết bị hiện tại (ví dụ: “iPhone của tôi”).
Loại | Tên |
---|---|
bool | shouldCollectDeviceName |
useReceiptValidationSandbox
Khai báo thuộc tính
@property (nonatomic) BOOL useReceiptValidationSandbox;
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).
Loại | Tên |
---|---|
bool | useReceiptValidationSandbox |
useUninstallSandbox
Khai báo thuộc tính
@property (nonatomic) BOOL useUninstallSandbox;
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).
Loại | Tên |
---|---|
bool | useUninstallSandbox |
Phương thức
addPushNotificationDeepLinkPath
Chữ ký phương thức
- (void)addPushNotificationDeepLinkPath:(NSArray<NSString *> *)deepLinkPath;
addPushNotificationDeepLinkPath(deepLinkPath: [String])
Mô tả
Thêm mảng mã khóa, được sử dụng để tạo đường dẫn mã khóa nhằm giải quyết liên kết sâu từ tải trọng thông báo đẩy.
Đối số đầu vào
Loại | Tên |
---|---|
NSArray<NSString *> | deepLinkPath |
Kết quả trả về
void
.
Ví dụ cách dùng
Cấu hình cơ bản
[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"af_push_link"]]
AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["af_push_link"])
Cấu hình nâng cao
[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"deeply", @"nested", @"deep_link"]]
AppsFlyerLib.shared().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”
}
}
}
appendParametersToDeepLinkingURL
Chữ ký phương thức
(void)appendParametersToDeepLinkingURLWithString:(NSString *)containsString parameters:(NSDictionary<NSString *, NSString*> *)parameters;
appendParametersToDeeplinkURL(contains: String, parameters: [String : String])
Mô tả
So khớp các URL chứa contains
dưới dạng một chuỗi con và thêm các thông số truy vấn vào chúng. Trong trường hợp URL không khớp, các thông số sẽ không được thêm vào nó.
Gọi ra phương thức này trước khi gọi
start
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | contains | Chuỗi kiểm tra trong URL. |
NSDictionary | parameters | Các thông số để thêm vào url liên kết sâu sau khi nó xác thực thành công. |
Kết quả trả về
void
.
continue
Chữ ký phương thức
- (id)continueUserActivity:(id)userActivity
restorationHandler:
(void (^_Nullable)(int *_Nullable))restorationHandler;
AppsFlyerLib.shared().continue(userActivity: NSUserActivity?, restorationHandler: (([Any]?) -> Void)?)
Mô tả
Cho phép AppsFlyer xử lý việc khôi phục từ một `NSUserActivity
. Sử dụng phương thức này để xử lý các Liên kết chung.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSUserActivity | userActivity | The NSUserActivity đã được chuyển cho ủy nhiệm hàm ứng dụng của bạn |
void (^_Nullable)(int *_Nullable) | restorationHandler | chuyển nil |
Kết quả trả về
void
.
enableFacebookDeferderedApplinks
Chữ ký phương thức
- (void)enableFacebookDeferredApplinksWithClass:(Class _Nullable)facebookAppLinkUtilityClass;
enableFacebookDeferredApplinks(with:AnyClass?)
Mô tả
Bật bộ tính năng thu thập Liên kết ứng dụng gián tiếp 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ại | Tên | Mô tả |
---|---|---|
FBSDKAppLinkUtility | facebookAppLinkUtilityClass |
Kết quả trả về
void
.
enableTCFDataCollection
Chữ ký phương thức
- (void)enableTCFDataCollection:(BOOL)flag;
func enableTCFDataCollection(_ flag: Bool)
Mô tả
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).
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
Bool | flag | A Boolean value to enable or disable the collection of TCF data. |
Kết quả trả về
void
.
getAppsFlyerUID
Chữ ký phương thức
- (NSString *)getAppsFlyerUID;
getAppsFlyerUID()
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
Phương thức này không có đối số đầu vào.
Kết quả trả về
Loại | Mô tả |
---|---|
NSString | ID nội bộ của AppsFlyer. |
getSDKVersion
Chữ ký phương thức
- (NSString *)getSDKVersion;
getSDKVersion()
Mô tả
Nhận phiên bản SDK.
Đối số đầu vào
Phương thức này không có đối số đầu vào.
Kết quả trả về
Loại | Mô tả |
---|---|
NSString | Phiên bản SDK AppsFlyer. |
handleOpen
Chữ ký phương thức
- (void)handleOpenUrl:(id)url options:(id)options;
AppsFlyerLib.shared().handleOpen(url: URL?, options: [AnyHashable : Any]?)
Mô tả
Gọi ra phương thức này từ bên trong phương thức AppDelegate openURL
method.
This method handles URI-scheme for iOS 9 and above.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSURL | url | URL đã được chuyển cho ủy nhiệm hàm ứng dụng của bạn. |
AnyHashable | options | Từ điển tùy chọn đã được chuyển đến AppDelegate của bạn. |
Kết quả trả về
void
.
handlePushNotification
Chữ ký phương thức
- (void)handlePushNotification:(NSDictionary * _Nullable)pushPayload;
AppsFlyerLib.shared().handlePushNotification(pushPayload: [AnyHashable : Any]?)
Mô tả
Bật AppsFlyer để xử lý thông báo đẩy.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
AnyHashable | pushPayload | The userInfo từ thông báo từ xa nhận được. Trừ khi sử dụng addPushNotificationDeepLinkPath , dữ liệu phải nằm trong mã khóa @“af” . |
Kết quả trả về
void
.
logAdRevenue
Added in v6.15.0
Chữ ký phương thức
-(void)logAdRevenue:(AFAdRevenueData *)adRevenueData additionalParameters:(NSDictionary * **_Nullable**)additionalParameters;
Mô tả
The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.
Thông số đầu vào
Tên | Loại | Mô tả |
---|---|---|
adRevenueData | AFAdRevenueData* | An object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method. |
additionalParameters | NSDictionary * _Nullable | An optional dictionary containing additional parameters to log with the adRevenue event. |
Kết quả trả về
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
Tên | Loại | Mô tả |
---|---|---|
monetizationNetwork | chuỗi | The monetization network name. |
mediationNetwork | AppsFlyerAdRevenueMediationNetworkType | The mediation network enum. |
currencyIso4217Code | chuỗi | The ad revenue event currency is a String validated against currencyIso4217Code |
eventRevenue | Double | The ad revenue event amount. |
AppsFlyerAdRevenueMediationNetworkType
Tên | Loại | Comments |
---|---|---|
ironsource | chuỗi | |
applovinmax | chuỗi | |
googleadmob | chuỗi | |
fyber | chuỗi | |
appodeal | chuỗi | |
admost | chuỗi | |
topon | chuỗi | |
tradplus | chuỗi | |
yandex | chuỗi | |
chartboost | chuỗi | |
unity | chuỗi | |
customMediation | chuỗi | Giải pháp hòa giải không nằm trong danh sách các đối tác hòa giải được hỗ trợ. |
directMonetizationNetwork | chuỗi | Ứng dụng tích hợp trực tiếp với các mạng kiếm tiền mà không cần qua mạng trung gian. |
logEvent
Chữ ký phương thức
- (void)logEvent:(NSString *)eventName withValues:(NSDictionary * _Nullable)values;
logEvent(eventName: String, withValues: [AnyHashable : Any]?)
Mô tả
Sử dụng phương thức này để ghi nhật ký một sự kiện với các thông số sự kiện.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | eventName | Chứa tên sự kiện có thể được cung cấp từ các hằng số xác định trước |
AnyHashable | withValues | từ điển các giá trị để xử lý bởi backend |
Kết quả trả về
void
.
logEvent
Chữ ký phương thức
- (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)?)
Mô tả
Sử dụng phương thức này để ghi nhật ký một sự kiện với các thông số sự kiện và chuyển một trình xử lý hoàn thành để xử lý việc gửi sự kiện thành công và thất bại.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | eventName | Chứa tên sự kiện có thể được cung cấp từ các hằng số xác định trước |
AnyHashable | withValues | từ điển các giá trị để xử lý bởi backend |
(^ _Nullable)(NSDictionary<NSString _, id> _ _Nullable dictionary, NSError * _Nullable error)) | completionHandler |
Kết quả trả về
void
.
logLocation
Chữ ký phương thức
- (void)logLocation:(double)longitude latitude:(double)latitude;
logLocation(longitude: Double, latitude: Double)
Mô tả
Để ghi nhật ký vị trí cho hàng rào địa lý. Làm giống như đoạn mã dưới đây.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
Double | longitude | Kinh độ vị trí |
Double | latitude | Vĩ độ vị trí |
Kết quả trả về
void
.
performOnAppAttribution
Chữ ký phương thức
- (void)performOnAppAttributionWithURL:(NSURL * _Nullable)URL;
performOnAppAttribution(with:URL?)
Mô tả
Được sử dụng để kích hoạt ủy nhiệm hàm onAppOpenAttribution
delegate.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSURL | URL | Thông số cần phân giải thành - [AppsFlyerLibDelegate onAppOpenAttribution:] |
Kết quả trả về
void
.
registerUninstall
Chữ ký phương thức
- (void)registerUninstall:(NSData * _Nullable)deviceToken;
registerUninstall(deviceToken: Data?)
Mô tả
Đăng ký lượt gỡ cài đặt - bạn nên đăng ký nhận thông báo từ xa và cung cấp cho AppsFlyer token thiết bị đẩy.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSData | deviceToken | The deviceToken là từ didRegisterForRemoteNotificationsWithDeviceToken . |
Kết quả trả về
void
.
setConsentData
Chữ ký phương thức
.setConsentData(afConsent: AppsFlyerConsent)
- (void)setConsentData:(AppsFlyerConsent) afConsent
Mô tả
Transfers consent data to the SDK.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
AppsFlyerConsent | afConsent | An object containing user consent data |
setCurrentDeviceLanguage
Chữ ký phương thức
- (void)setCurrentDeviceLanguage:(NSString *)currentDeviceLanguage
Mô tả
Sử dụng phương thức này để đặt ngôn ngữ thiết bị trong SDK và chuyển nó đến AppsFlyer.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | currentDeviceLanguage | Ngôn ngữ hiện tại của thiết bị. |
Ví dụ cách dùng
NSString *language = [[NSLocale preferredLanguages] objectAtIndex:0]
[[AppsFlyerLib shared] setCurrentDeviceLanguage: @language];
let language = NSLocale.current.languageCode
AppsFlyerLib.shared().currentDeviceLanguage = language
setHost
Chữ ký phương thức
(void)setHost:(NSString *)host withHostPrefix:(NSString *)hostPrefix;
setHost(host: String, withHostPrefix: String)
Mô tả
Hàm này đặt tên máy chủ và tên máy chủ tiền tố cho tất cả các điểm cuối.
Note: Starting with SDK V6.11, if the host value is empty or null, the API call will be ignored.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | host | tên máy chủ. |
NSString | withHostPrefix | Bắt buộc. tiền tố máy chủ. |
Kết quả trả về
void
.
Ví dụ cách dùng
[[AppsFlyerLib shared] setHost:@"example.com" withHostPrefix:@"my_host_prefix"];
AppsFlyerLib.shared().setHost("example.com", withHostPrefix: "my_host_prefix")
setPartnerData
Chữ ký phương thức
- (void)setPartnerDataWithPartnerId:(NSString * _Nullable)partnerId partnerInfo:(NSDictionary<NSString *, id> * _Nullable)partnerInfo;
setPartnerData(partnerId: String?, partnerInfo: [String : Any]?)
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ại | Tên | Mô tả |
---|---|---|
NSString | partnerId | ID của đối tác (thường có hậu tố _int ) |
NSDictionary<NSString _, id> _ _Nullable | partnerInfo | dữ liệu khách hàng, phụ thuộc vào bản chất của tích hợp với đối tác cụ thể |
Kết quả trả về
void
.
Ví dụ cách dùng
NSDictionary *partnerInfo = @{
@"puid": @"123456789",
};
[[AppsFlyerLib shared] setPartnerDataWithPartnerId: @"test_int" partnerInfo:partnerInfo];
let partnerInfo = [
"puid":"123456789",
]
AppsFlyerLib.shared().setPartnerData(partnerId:"test_int", partnerInfo:partnerInfo)
setSharingFilterForPartners
Đã thêm vào V6.4
Chữ ký phương thức
- (void)setSharingFilterForPartners:(NSArray<NSString *> * _Nullable)sharingFilter;
This function replaces the deprecated setSharingFilterForAllPartners
Mô tả
Cho phép bạn cấu hình những đối tác nào mà SDK sẽ loại trừ khỏi việc chia sẻ dữ liệu.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSArray<NSString _> _ _Nullable | sharingFilter | Mộ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 ý:
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:
- Run the Get active integrations API for a list of all active integrations
- Sử dụng phương thức
media_source_name
values from the API response as input values to the methodpartners
array.
Exceptions:
- For Apple Search Ads use
Apple Search Ads
(and notiossearchads_int
). - For Twitter, use
twitter
(and nottwitter_int
)
Ví dụ cách dùng
[[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
Không còn được hỗ trợ trong V6.4
Chữ ký phương thức
- (void)setSharingFilterForAllPartners;
setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
Mô tả
Block an event from being shared with integrated partners.
Đối số đầu vào
Phương thức này không có đối số đầu vào.
Kết quả trả về
void
setUserEmails
Chữ ký phương thức
- (void)setUserEmails:(NSArray<NSString *> * _Nullable)userEmails withCryptType:(EmailCryptType)type;
setUserEmails(userEmails: [String]?, with: EmailCryptType)
Mô tả
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.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSArray<NSString *> | userEmails | Mảng email. |
EmailCryptType | type | Loại mã hóa. |
Kết quả trả về
void
.
shared
Chữ ký phương thức
(AppsFlyerLib *)shared;
Mô tả
Lấy phiên bản singleton của lớp AppsFlyerLib
, tạo ra phiên bản này nếu cần thiết.
Ví dụ cách dùng
AppsFlyerLib.shared()
start
Chữ ký phương thức
- (void)start;
(void) start()
Mô tả
Khởi động SDK.
Đối số đầu vào
Phương thức này không có đối số đầu vào.
Kết quả trả về
void
.
start
Chữ ký phương thức
- (void)startWithCompletionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;
start(completionHandler: (([String : Any]?, Error?) -> Void)?)
Mô tả
Khởi động SDK với trình xử lý hoàn thành.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
void (^ _Nullable)(NSDictionary<NSString _, id> _ _Nullable dictionary, NSError * _Nullable error) | completionHandler |
Kết quả trả về
void
.
validateAndLogInAppPurchase
(Supported from SDK v.6.14.1)
Chữ ký phương thức
typedef void (^AFSDKValidateAndLogCompletion)(AFSDKValidateAndLogResult * _Nullable result);
- (void)validateAndLogInAppPurchase:(AFSDKPurchaseDetails *)details
extraEventValues:(NSDictionary * _Nullable)extraEventValues
completionHandler:(AFSDKValidateAndLogCompletion)completionHandler NS_AVAILABLE(10_7, 7_0);
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.
Thông số đầu vào
Tên | Loại | Mô tả |
---|---|---|
details * | 'AFSDKPurchaseDetails'* | An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method. |
extraEventValues | NSDictionary * _Nullable | An optional dictionary containing additional parameters to log with the purchase event. |
completionHandler * | AFSDKValidateAndLogCompletion | A completion handler block that is called with the result of the purchase validation and logging. |
Kết quả trả về
void
.
AFSDKPurchaseDetails
An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase
.
AFSDKPurchaseDetails parameters
Tên | Loại | Mô tả |
---|---|---|
productId | chuỗi | The product identifier for the purchase. |
price | chuỗi | The price of the product. |
currency | chuỗi | The currency used for the billing operation. |
transactionId | chuỗi | A specific identifier for the transaction. |
validateAndLogInAppPurchase (LEGACY)
(Supported until SDK v.6.14.0)
Chữ ký phương thức
- (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)?)
Mô tả
Để ghi nhật ký và xác thực mua hàng trong ứng dụng, bạn có thể gọi ra phương thức này từ phương thức [completeTransaction
] trong SKPaymentTransactionObserver
.
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSString | productIdentifier | inAppPurchase trong Swift. |
NSString | price | |
NSString | currency | |
NSString | transactionId | |
NSDictionary | additionalParameters | |
void (^_Nullable)(int *))successBlock | successBlock | Trình xử lý hoàn thành cho ghi nhật ký và xác thực thành công. |
void (^_Nullable)(int *_Nullable, id _Nullable)) | failedBlock | Trình xử lý hoàn thành cho ghi nhật ký và xác thực thất bại. |
Kết quả trả về
void
.
waitForATTUserAuthorization
Chữ ký phương thức
- (void)waitForATTUserAuthorizationWithTimeoutInterval:(id)timeoutInterval;
waitForATTUserAuthorization(timeoutInterval:)
Mô tả
Chờ yêu cầu người dùng ủy quyền để truy cập dữ liệu liên quan đến ứng dụng
Đối số đầu vào
Loại | Tên | Mô tả |
---|---|---|
NSInteger | timeoutInterval |
Ví dụ cách dùng
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
}
}
Kết quả trả về
void
.
Đã cập nhật 15 ngày trước