Cài đặt & cấu hình Adapty SDK trong dự án React Native thuần
Hướng dẫn này chỉ áp dụng cho dự án React Native thuần (không dùng Expo). Nếu bạn đang dùng Expo, hãy xem hướng dẫn cài đặt Expo thay thế.
SDK Adapty bao gồm hai module chính để tích hợp liền mạch vào ứng dụng React Native của bạn:
- Core Adapty: Module này là bắt buộc để Adapty hoạt động đúng trong ứng dụng của bạn.
- AdaptyUI: Module này cần thiết nếu bạn sử dụng Adapty Paywall Builder, công cụ không cần code, thân thiện với người dùng để dễ dàng tạo paywall đa nền tảng. AdaptyUI sẽ tự động được kích hoạt cùng với module core.
Bạn muốn xem ví dụ thực tế về cách tích hợp Adapty SDK vào ứng dụng di động? Hãy xem ứng dụng mẫu của chúng tôi, minh họa toàn bộ quá trình thiết lập, bao gồm hiển thị paywall, thực hiện mua hàng và các chức năng cơ bản khác.
Yêu cầu
Adapty React Native SDK yêu cầu iOS 15.0 trở lên.
Để build cho iOS cần có Swift 6.0 hoặc cao hơn. Kids Mode yêu cầu Swift 6.1 hoặc cao hơn.
Từ SDK v3.17 trở đi, Adapty SDK sử dụng Google Play Billing Library v8.0.0 theo mặc định.
Cài đặt SDK là bước 5 trong quá trình thiết lập Adapty. Trước khi các giao dịch mua hàng hoạt động trong ứng dụng, bạn cần kết nối ứng dụng với các cửa hàng, sau đó tạo sản phẩm, paywall và placement trong Adapty Dashboard. Hướng dẫn quickstart sẽ hướng dẫn bạn qua tất cả các bước cần thiết.
Cài đặt Adapty SDK
Kể từ phiên bản v4, Adapty React Native SDK không còn hỗ trợ cài đặt các dependency native thông qua CocoaPods nữa. Nếu bạn cần v4 trở lên (để sử dụng Flow Builder), hãy làm theo hướng dẫn Adapty SDK 4.0 (beta): enable Swift Package Manager bên dưới.
- Cài đặt Adapty SDK (thao tác này cũng tự động cài đặt
@adapty/core):# using npm npm install react-native-adapty # or using yarn yarn add react-native-adapty - Với iOS, cài đặt pods:
cd ios && pod install
Với Android, nếu phiên bản React Native của bạn cũ hơn 0.73.0 (nhấn để mở rộng)
Cập nhật file /android/build.gradle. Đảm bảo rằng có dependency kotlin-gradle-plugin:1.8.0 hoặc phiên bản mới hơn:
...
buildscript {
...
dependencies {
...
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.0"
}
}
...Adapty SDK 4.0 (beta): bật Swift Package Manager
React Native SDK 4.0 — bổ sung hỗ trợ Flow Builder — là phiên bản pre-release yêu cầu React Native 0.75 trở lên. Cài đặt đúng phiên bản (npm không tự phân giải pre-release qua cú pháp caret/tilde):
npm install react-native-adapty@4.0.0-beta.1
# or using yarn
yarn add react-native-adapty@4.0.0-beta.1
v4 kéo các native iOS SDK (Adapty, AdaptyUI, AdaptyPlugin) thông qua Swift Package Manager thay vì các sub-dependency của CocoaPods (kho spec của CocoaPods sẽ chuyển sang chế độ chỉ đọc vào tháng 12 năm 2026). SPM yêu cầu dynamic framework — thêm đoạn sau vào target trong ios/Podfile, rồi cài lại pods:
use_frameworks! :linkage => :dynamic
cd ios && pod install --repo-update
Nếu trước đây bạn đã kéo Adapty, AdaptyUI hoặc AdaptyPlugin dưới dạng sub-dependencies CocoaPods, hãy xóa bất kỳ dòng pod 'Adapty', pod 'AdaptyUI' hoặc pod 'AdaptyPlugin' nào khỏi Podfile của bạn trước.
Việc chuyển từ liên kết tĩnh (static linkage) mặc định sang dynamic frameworks có thể xung đột với các thư viện chưa hỗ trợ modular headers, và không tương thích với Flipper. Xem Migrate Adapty React Native SDK sang v4 để biết thêm chi tiết.
Kích hoạt module Adapty của Adapty SDK
Để lấy Public SDK Key:
- Truy cập Adapty Dashboard và điều hướng đến App settings → General.
- Trong phần Api keys, sao chép Public SDK Key (KHÔNG phải Secret Key).
- Thay thế
"YOUR_PUBLIC_SDK_KEY"trong code.
Hoặc lấy theo cách lập trình, sử dụng Adapty CLI:
npm install -g adapty
adapty auth login
adapty apps list
Hoặc, trực tiếp:
npx adapty auth login
adapty apps list
- Đảm bảo bạn sử dụng Public SDK key để khởi tạo Adapty, Secret key chỉ nên dùng cho server-side API.
- SDK keys là duy nhất cho mỗi ứng dụng, vì vậy nếu bạn có nhiều ứng dụng, hãy đảm bảo chọn đúng key.
Sao chép đoạn code sau vào App.tsx để kích hoạt Adapty:
adapty.activate('YOUR_PUBLIC_SDK_KEY');
Hãy đợi activate hoàn thành trước khi gọi bất kỳ phương thức nào khác của Adapty SDK. Xem Thứ tự gọi trong React Native SDK để biết toàn bộ trình tự.
Bây giờ hãy thiết lập các paywall trong ứng dụng của bạn:
- Nếu bạn dùng Adapty Paywall Builder, hãy xem hướng dẫn nhanh về Paywall Builder.
- Nếu bạn tự xây dựng giao diện paywall, hãy xem hướng dẫn nhanh cho custom paywall.
Để tránh lỗi kích hoạt trong môi trường phát triển, hãy tham khảo các mẹo.
Kích hoạt module AdaptyUI của Adapty SDK
Nếu bạn có kế hoạch sử dụng Paywall Builder, bạn cần module AdaptyUI. Module này được kích hoạt tự động khi bạn kích hoạt module lõi; bạn không cần làm gì thêm.
Cài đặt tùy chọn
Ghi log
Thiết lập hệ thống ghi log
Adapty ghi lại các lỗi và thông tin quan trọng khác để giúp bạn hiểu chuyện gì đang xảy ra. Các cấp độ ghi log hiện có như sau:
| Level | Description |
|---|---|
error | Chỉ ghi lại các lỗi |
warn | Ghi lại các lỗi và thông báo từ SDK không gây ra lỗi nghiêm trọng nhưng đáng chú ý |
info | Ghi lại các lỗi, cảnh báo và nhiều thông báo thông tin khác |
verbose | Ghi lại mọi thông tin bổ sung có thể hữu ích trong quá trình debug, chẳng hạn như các lần gọi hàm, truy vấn API, v.v. |
| Bạn có thể thiết lập mức độ log trong ứng dụng trước hoặc trong quá trình cấu hình Adapty: |
// Set log level before activation
// 'verbose' is recommended for development and the first production release
adapty.setLogLevel('verbose');
// Or set it during configuration
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
logLevel: 'verbose',
});
Chính sách dữ liệu
Adapty không lưu trữ dữ liệu cá nhân của người dùng trừ khi bạn chủ động gửi, nhưng bạn có thể áp dụng thêm các chính sách bảo mật dữ liệu để tuân thủ quy định của cửa hàng hoặc từng quốc gia.
Tắt thu thập và chia sẻ địa chỉ IP
Khi kích hoạt module Adapty, đặt ipAddressCollectionDisabled thành true để tắt tính năng thu thập và chia sẻ địa chỉ IP của người dùng. Giá trị mặc định là false.
Sử dụng tham số này để tăng cường quyền riêng tư cho người dùng, tuân thủ các quy định bảo vệ dữ liệu theo khu vực (như GDPR hoặc CCPA), hoặc giảm thiểu việc thu thập dữ liệu không cần thiết khi các tính năng dựa trên IP không được yêu cầu trong ứng dụng của bạn.
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
ipAddressCollectionDisabled: true,
});
Tắt tính năng thu thập và chia sẻ advertising ID
Khi kích hoạt module Adapty, đặt ios.idfaCollectionDisabled (iOS) hoặc android.adIdCollectionDisabled (Android) thành true để tắt thu thập advertising identifier. Giá trị mặc định là false.
Sử dụng tham số này để tuân thủ chính sách của App Store/Play Store, tránh kích hoạt lời nhắc App Tracking Transparency, hoặc khi ứng dụng của bạn không cần attribution quảng cáo hay analytics dựa trên advertising ID.
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
ios: {
idfaCollectionDisabled: true,
},
android: {
adIdCollectionDisabled: true,
},
});
Thiết lập cấu hình bộ nhớ đệm media cho AdaptyUI
Theo mặc định, AdaptyUI lưu vào bộ nhớ đệm các file media (như hình ảnh và video) để cải thiện hiệu suất và giảm lưu lượng mạng. Bạn có thể tùy chỉnh các cài đặt bộ nhớ đệm bằng cách cung cấp cấu hình tùy chỉnh.
Sử dụng mediaCache để ghi đè các cài đặt bộ nhớ đệm mặc định:
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
mediaCache: {
memoryStorageTotalCostLimit: 200 * 1024 * 1024, // Optional: memory cache size in bytes
memoryStorageCountLimit: 2147483647, // Optional: max number of items in memory
diskStorageSizeLimit: 200 * 1024 * 1024, // Optional: disk cache size in bytes
},
});
| Tham số | Bắt buộc | Mô tả |
|---|---|---|
| memoryStorageTotalCostLimit | tùy chọn | Tổng kích thước cache trong bộ nhớ tính bằng byte. Mặc định theo giá trị riêng của từng nền tảng. |
| memoryStorageCountLimit | tùy chọn | Giới hạn số lượng mục trong bộ nhớ cache. Mặc định theo giá trị riêng của từng nền tảng. |
| diskStorageSizeLimit | tùy chọn | Giới hạn kích thước tệp trên đĩa tính bằng byte. Mặc định theo giá trị riêng của từng nền tảng. |
Bật mức độ truy cập cục bộ (Android)
Theo mặc định, mức độ truy cập cục bộ được bật trên iOS và tắt trên Android. Để bật tính năng này trên Android, hãy đặt localAccessLevelAllowed thành true:
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
android: {
localAccessLevelAllowed: true,
},
});
Xóa dữ liệu khi khôi phục từ backup
Khi clearDataOnBackup được đặt thành true, SDK sẽ phát hiện khi ứng dụng được khôi phục từ bản backup iCloud và xóa toàn bộ dữ liệu SDK được lưu trữ cục bộ, bao gồm thông tin hồ sơ người dùng đã cache, chi tiết sản phẩm và các paywall. Sau đó SDK sẽ khởi tạo lại với trạng thái sạch. Giá trị mặc định là false.
Chỉ có cache SDK cục bộ bị xóa. Lịch sử giao dịch với Apple và dữ liệu người dùng trên máy chủ Adapty vẫn không thay đổi.
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
ios: {
clearDataOnBackup: true
},
});
Mẹo cho môi trường phát triển
Trì hoãn kích hoạt SDK cho mục đích phát triển
Adapty tải trước tất cả dữ liệu người dùng cần thiết ngay khi SDK được kích hoạt, giúp truy cập dữ liệu mới nhanh hơn.
Tuy nhiên, điều này có thể gây ra vấn đề trong iOS simulator, nơi thường xuyên yêu cầu xác thực trong quá trình phát triển. Mặc dù Adapty không thể kiểm soát luồng xác thực StoreKit, nhưng có thể trì hoãn các yêu cầu mà SDK thực hiện để lấy dữ liệu người dùng mới.
Bằng cách bật thuộc tính __debugDeferActivation, lệnh gọi activate sẽ được giữ lại cho đến khi bạn thực hiện lệnh gọi SDK tiếp theo. Điều này giúp tránh các thông báo yêu cầu dữ liệu xác thực không cần thiết khi không cần thiết.
Cần lưu ý rằng tính năng này chỉ dành cho mục đích phát triển, vì nó không bao phủ tất cả các tình huống người dùng tiềm năng. Trong môi trường production, không nên trì hoãn việc kích hoạt, vì các thiết bị thực thường ghi nhớ dữ liệu xác thực và không liên tục yêu cầu nhập thông tin đăng nhập.
Dưới đây là cách tiếp cận được khuyến nghị khi sử dụng:
try {
adapty.activate('PUBLIC_SDK_KEY', {
__debugDeferActivation: isSimulator(), // 'isSimulator' từ thư viện bên thứ ba bất kỳ
});
} catch (error) {
console.error('Không thể kích hoạt Adapty SDK:', error);
// Xử lý lỗi phù hợp với ứng dụng của bạn
}
Khắc phục lỗi kích hoạt SDK khi sử dụng Fast Refresh của React Native
Khi phát triển với Adapty SDK trong React Native, bạn có thể gặp lỗi: Adapty can only be activated once. Ensure that the SDK activation call is not made more than once.
Điều này xảy ra vì tính năng fast refresh của React Native kích hoạt nhiều lần gọi activation trong quá trình phát triển. Để ngăn điều này, hãy sử dụng tùy chọn __ignoreActivationOnFastRefresh được đặt thành __DEV__ (cờ chế độ phát triển của React Native).
try {
adapty.activate('PUBLIC_SDK_KEY', {
__ignoreActivationOnFastRefresh: __DEV__,
});
} catch (error) {
console.error('Failed to activate Adapty SDK:', error);
// Handle the error appropriately for your app
}
Thiết lập chế độ mock để kiểm tra cục bộ
Để phát triển và kiểm thử cục bộ, bạn có thể bật chế độ mock để không cần tài khoản sandbox App Store/Google Play và tăng tốc độ vòng lặp phát triển. Chế độ mock hoàn toàn bỏ qua các module native của Adapty và trả về dữ liệu giả lập.
Chế độ mock không phải là công cụ để kiểm thử giao dịch mua thực tế:
- Nó không mở luồng mua hàng App Store / Google Play và không tạo giao dịch thực.
- Nó không render paywall/onboarding được tạo bằng Adapty Paywall Builder (AdaptyUI).
- Các native module của Adapty bị bỏ qua hoàn toàn—ngay cả khi thiếu file native SDK trong bản build Xcode/Android hoặc API key không hợp lệ cũng sẽ không phát sinh lỗi.
- Không có dữ liệu nào được gửi đến server của Adapty.
Để kiểm tra mua hàng thực và paywall từ Paywall Builder, hãy tắt mock mode và sử dụng tài khoản sandbox.
Để bật mock mode, đặt enableMock thành true:
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
enableMock: true,
});
Khi chế độ mock đang hoạt động:
- Tất cả các phương thức của Adapty trả về dữ liệu mock mà không thực hiện bất kỳ yêu cầu mạng nào đến máy chủ của Adapty.
- Theo mặc định, hồ sơ người dùng mock ban đầu không có gói đăng ký nào đang hoạt động.
- Theo mặc định,
makePurchase(...)mô phỏng một giao dịch mua thành công và cấp quyền truy cập premium.
Bạn có thể tùy chỉnh dữ liệu mock bằng mockConfig trong quá trình kích hoạt. Xem định dạng cấu hình và các tham số được hỗ trợ tại đây.
try {
await adapty.activate('YOUR_PUBLIC_SDK_KEY', {
mockConfig: {
// Customize the initial mock profile (optional)
},
});
} catch (error) {
console.error('Failed to activate Adapty SDK:', error);
}
Nếu bạn cần gọi các phương thức SDK trước khi kích hoạt (chẳng hạn như isActivated() hoặc setLogLevel()), hãy sử dụng enableMock() trước activate(). Nếu bridge đã được khởi tạo, phương thức này sẽ không làm gì cả.
adapty.enableMock(); // Optional: pass mockConfig to customize mock data
// Now you can call methods before activation
await adapty.activate('YOUR_PUBLIC_SDK_KEY');
Xử lý sự cố
Lỗi phiên bản iOS tối thiểu
Nếu bạn gặp lỗi phiên bản iOS tối thiểu, hãy cập nhật Podfile:
-platform :ios, min_ios_version_supported
+platform :ios, '15.0'
Xung đột manifest Android Auto Backup
Một số SDK (bao gồm Adapty) đi kèm với cấu hình Android Auto Backup riêng. Nếu bạn sử dụng nhiều SDK có định nghĩa backup rules, quá trình merge Android manifest có thể thất bại với lỗi liên quan đến android:fullBackupContent, android:dataExtractionRules, hoặc android:allowBackup.
Triệu chứng lỗi thường gặp: Manifest merger failed: Attribute application@dataExtractionRules value=(@xml/your_data_extraction_rules) is also present at [com.other.sdk:library:1.0.0] value=(@xml/other_sdk_data_extraction_rules)
Những thay đổi này cần được thực hiện trong thư mục platform Android của bạn (thường nằm trong thư mục android/ của dự án).
Để khắc phục, bạn cần:
-
Yêu cầu manifest merger sử dụng các giá trị của ứng dụng cho các thuộc tính liên quan đến backup.
-
Tạo các file backup rule kết hợp rules của Adapty với rules từ các SDK khác.
1. Thêm namespace tools vào manifest
Trong file AndroidManifest.xml, hãy đảm bảo thẻ gốc <manifest> có chứa tools:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="com.example.app">
...
</manifest>
2. Ghi đè các thuộc tính backup trong <application>
Trong cùng file AndroidManifest.xml, cập nhật thẻ <application> để ứng dụng của bạn cung cấp các giá trị cuối cùng và yêu cầu manifest merger thay thế các giá trị từ thư viện:
<application
android:name=".App"
android:allowBackup="true"
android:fullBackupContent="@xml/sample_backup_rules"
android:dataExtractionRules="@xml/sample_data_extraction_rules"
tools:replace="android:fullBackupContent,android:dataExtractionRules">
...
</application>
Nếu có SDK nào cũng đặt android:allowBackup, hãy thêm nó vào tools:replace:
tools:replace="android:allowBackup,android:fullBackupContent,android:dataExtractionRules"
3. Tạo các file backup rules đã merge
Tạo các file XML trong thư mục res/xml/ của dự án Android, kết hợp rules của Adapty với rules từ các SDK khác. Android sử dụng các định dạng backup rule khác nhau tùy theo phiên bản OS, vì vậy việc tạo cả hai file đảm bảo tương thích với tất cả các phiên bản Android mà ứng dụng hỗ trợ.
Các ví dụ dưới đây sử dụng AppsFlyer làm SDK bên thứ ba mẫu. Hãy thay thế hoặc bổ sung rules cho các SDK khác mà bạn đang dùng trong ứng dụng.
Dành cho Android 12 trở lên (sử dụng định dạng data extraction rules mới):
<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>
<cloud-backup>
<exclude domain="sharedpref" path="appsflyer-data"/>
<exclude domain="sharedpref" path="appsflyer-purchase-data"/>
<exclude domain="database" path="afpurchases.db"/>
<exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
</cloud-backup>
<device-transfer>
<exclude domain="sharedpref" path="appsflyer-data"/>
<exclude domain="sharedpref" path="appsflyer-purchase-data"/>
<exclude domain="database" path="afpurchases.db"/>
<exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
</device-transfer>
</data-extraction-rules>
Dành cho Android 11 trở xuống (sử dụng định dạng full backup content cũ):
<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
<exclude domain="sharedpref" path="appsflyer-data"/>
<exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
Giao dịch mua thất bại sau khi quay lại từ ứng dụng khác trên Android
Nếu Activity khởi động flow mua hàng sử dụng launchMode không phải mặc định, Android có thể tạo lại hoặc tái sử dụng nó không đúng cách khi người dùng quay lại từ Google Play, ứng dụng ngân hàng hoặc trình duyệt. Điều này có thể khiến kết quả giao dịch bị mất hoặc bị xử lý như đã hủy.
Để đảm bảo quá trình mua hàng hoạt động đúng, hãy chỉ sử dụng chế độ khởi chạy standard hoặc singleTop cho Activity khởi động flow mua hàng, và tránh các chế độ khác.
Trong file AndroidManifest.xml, đảm bảo Activity khởi động flow mua hàng được đặt thành standard hoặc singleTop:
<activity
android:name=".MainActivity"
android:launchMode="standard" />
Lỗi build Swift 6 do Podfile ghi đè SWIFT_VERSION
Khi build ứng dụng React Native cho iOS, bạn có thể gặp lỗi biên dịch Swift 6 trên các pod target của Adapty. Các triệu chứng thường gặp bao gồm: lỗi @Sendable không khớp trong AdaptyUIBuilderLogic, thiếu conformance Sendable trên các kiểu Adapty, hoặc lỗi actor isolation.
Các pod Adapty khai báo s.swift_version = '6.0' và yêu cầu Swift 6 để build. Code của bạn vẫn có thể dùng Swift 5 — chỉ các pod target của Adapty (Adapty, AdaptyUI, AdaptyUIBuilder, AdaptyLogger, AdaptyPlugin) mới cần build bằng Swift 6.
Nguyên nhân phổ biến nhất là hook post_install trong ios/Podfile ghi đè SWIFT_VERSION cho mọi pod target:
post_install do |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '5.9'
end
end
end
Cách sửa: Loại trừ các pod target của Adapty khỏi phần ghi đè:
post_install do |installer|
installer.pods_project.targets.each do |target|
next if %w[Adapty AdaptyUI AdaptyUIBuilder AdaptyLogger AdaptyPlugin].include?(target.name)
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '5.9'
end
end
end
Sau đó chạy pod install từ thư mục ios/ và build lại.
Để xác nhận, mở ios/Pods/Pods.xcodeproj, chọn target pod Adapty → Build Settings → Swift Language Version. Giá trị phải là Swift 6.