Lấy paywall và sản phẩm cho paywall remote config trong Kotlin Multiplatform SDK

Trước khi trình bày Remote Config và các paywall tùy chỉnh, bạn cần tải thông tin về chúng. Lưu ý rằng chủ đề này đề cập đến Remote Config và các paywall tùy chỉnh. Để được hướng dẫn về cách tải các flow hoặc paywall được tùy chỉnh trong Flow Builder hoặc Paywall Builder, vui lòng tham khảo Lấy flow & paywall.

Trước khi bắt đầu tải flow và sản phẩm trong ứng dụng mobile của bạn (nhấn để mở rộng)

1. Tạo sản phẩm của bạn trong Adapty Dashboard.

2. Tạo flow hoặc paywall và thêm sản phẩm vào đó trong Adapty Dashboard.

3. Tạo placement và thêm flow hoặc paywall vào placement trong Adapty Dashboard.

4. Cài đặt Adapty SDK trong ứng dụng mobile của bạn.

Lấy thông tin flow

Trong Adapty, một sản phẩm là sự kết hợp của các sản phẩm từ App Store và Google Play. Các sản phẩm đa nền tảng này được tích hợp vào các flow và paywall, cho phép bạn hiển thị chúng tại các placement cụ thể trong ứng dụng di động.

Để hiển thị các sản phẩm, bạn cần lấy một AdaptyFlow từ một trong các placement của mình bằng phương thức getFlow.

Adapty.getFlow(
    placementId = "YOUR_PLACEMENT_ID", 
    fetchPolicy = AdaptyPaywallFetchPolicy.Default,
    loadTimeout = 5.seconds
).onSuccess { flow ->
    // the requested flow
}.onError { error ->
    // handle the error
}

Tham số	Bắt buộc	Mô tả
placementId	bắt buộc	Định danh của Placement. Đây là giá trị bạn đã chỉ định khi tạo placement trong Adapty Dashboard.
fetchPolicy	mặc định: AdaptyPaywallFetchPolicy.Default	Theo mặc định, SDK sẽ cố tải dữ liệu từ server và trả về dữ liệu đã cache nếu thất bại. Chúng tôi khuyến nghị dùng tùy chọn này vì nó đảm bảo người dùng luôn nhận được dữ liệu mới nhất. Tuy nhiên, nếu bạn cho rằng người dùng của mình thường xuyên gặp sự cố kết nối internet không ổn định, hãy cân nhắc sử dụng AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad để trả về dữ liệu đã cache nếu có. Trong trường hợp này, người dùng có thể không nhận được dữ liệu mới nhất tuyệt đối, nhưng thời gian tải sẽ nhanh hơn bất kể kết nối internet có chập chờn đến đâu. Cache được cập nhật thường xuyên nên hoàn toàn an toàn khi sử dụng trong phiên làm việc để tránh các yêu cầu mạng. Lưu ý rằng cache vẫn còn nguyên sau khi khởi động lại ứng dụng và chỉ bị xóa khi cài đặt lại ứng dụng hoặc xóa thủ công. Adapty SDK lưu trữ flow và paywall ở hai lớp: cache được cập nhật thường xuyên như mô tả ở trên và paywall dự phòng. Chúng tôi cũng sử dụng CDN để tải flow và paywall nhanh hơn cùng với một server dự phòng độc lập trong trường hợp CDN không thể truy cập. Hệ thống này được thiết kế để đảm bảo bạn luôn nhận được phiên bản mới nhất của flow và paywall, đồng thời duy trì độ tin cậy ngay cả khi kết nối internet kém.
loadTimeout	mặc định: 5 giây	Giá trị này giới hạn thời gian chờ cho phương thức này. Nếu hết thời gian chờ, dữ liệu đã cache hoặc fallback cục bộ sẽ được trả về. Lưu ý rằng trong một số trường hợp hiếm gặp, phương thức này có thể hết thời gian chờ trễ hơn một chút so với giá trị được chỉ định trong loadTimeout, do thao tác này có thể bao gồm nhiều yêu cầu khác nhau bên dưới.

Đừng hardcode ID sản phẩm! Vì flow được cấu hình từ xa, các sản phẩm hiện có, số lượng sản phẩm và các ưu đãi đặc biệt (chẳng hạn như dùng thử miễn phí) có thể thay đổi theo thời gian. Hãy đảm bảo code của bạn xử lý được các tình huống này.

Ví dụ: nếu ban đầu bạn lấy được 2 sản phẩm, ứng dụng của bạn nên hiển thị 2 sản phẩm đó. Tuy nhiên, nếu sau này bạn lấy được 3 sản phẩm, ứng dụng của bạn nên hiển thị cả 3 mà không cần thay đổi code. Thứ duy nhất bạn phải hardcode là placement ID.

Tham số phản hồi:

Tham số	Mô tả
Flow	Một đối tượng AdaptyFlow bao gồm: mã định danh flow, các biến thể paywall (paywalls — mỗi biến thể có mã định danh sản phẩm riêng), danh sách remoteConfigs (một mục cho mỗi ngôn ngữ đã cấu hình), và một số thuộc tính khác. Để lấy sản phẩm cho flow, hãy gọi getPaywallProducts(flow).

Lấy danh sách sản phẩm

Sau khi có flow, bạn có thể truy vấn mảng sản phẩm tương ứng với flow đó:

Adapty.getPaywallProducts(flow).onSuccess { products ->
    // the requested products
}.onError { error ->
    // handle the error
}

Tham số phản hồi:

Tham số	Mô tả
Products	Danh sách các đối tượng AdaptyPaywallProduct với: mã định danh sản phẩm, tên sản phẩm, giá, đơn vị tiền tệ, thời hạn gói đăng ký, và một số thuộc tính khác.

Khi triển khai thiết kế flow của riêng bạn, bạn có thể sẽ cần truy cập các thuộc tính từ đối tượng AdaptyPaywallProduct. Dưới đây là các thuộc tính được sử dụng phổ biến nhất, nhưng hãy tham khảo tài liệu được liên kết để biết chi tiết đầy đủ về tất cả các thuộc tính có sẵn.

Thuộc tính	Mô tả
Title	Để hiển thị tiêu đề sản phẩm, sử dụng product.localizedTitle. Lưu ý rằng việc bản địa hóa dựa trên quốc gia cửa hàng mà người dùng đã chọn, chứ không phải ngôn ngữ của thiết bị.
Price	Để hiển thị giá đã được bản địa hóa, sử dụng product.price.localizedString. Việc bản địa hóa này dựa trên thông tin ngôn ngữ của thiết bị. Bạn cũng có thể truy cập giá dưới dạng số bằng product.price.amount. Giá trị sẽ được cung cấp theo đơn vị tiền tệ địa phương. Để lấy ký hiệu tiền tệ tương ứng, sử dụng product.price.currencySymbol.
Subscription Period	Để hiển thị chu kỳ (ví dụ: tuần, tháng, năm, v.v.), sử dụng product.subscriptionDetails?.localizedSubscriptionPeriod. Việc bản địa hóa này dựa trên ngôn ngữ của thiết bị. Để lấy chu kỳ gói đăng ký theo cách lập trình, sử dụng product.subscriptionDetails?.subscriptionPeriod. Từ đó bạn có thể truy cập enum unit để lấy độ dài (tức là DAY, WEEK, MONTH, YEAR, hoặc UNKNOWN). Giá trị numberOfUnits sẽ cho bạn biết số đơn vị chu kỳ. Ví dụ: với gói đăng ký theo quý, bạn sẽ thấy MONTH trong thuộc tính unit và 3 trong thuộc tính numberOfUnits.
Introductory Offer	Để hiển thị huy hiệu hoặc chỉ báo khác cho biết gói đăng ký có ưu đãi giới thiệu, hãy kiểm tra thuộc tính product.subscriptionDetails?.introductoryOfferPhases. Đây là danh sách có thể chứa tối đa hai giai đoạn giảm giá: giai đoạn dùng thử miễn phí và giai đoạn giá ưu đãi giới thiệu. Trong mỗi đối tượng giai đoạn có các thuộc tính hữu ích sau: • paymentMode: enum với các giá trị FREE_TRIAL, PAY_AS_YOU_GO, PAY_UPFRONT và UNKNOWN. Các gói dùng thử miễn phí sẽ có loại FREE_TRIAL. • price: Giá ưu đãi dưới dạng số. Với gói dùng thử miễn phí, giá trị này là 0. • localizedNumberOfPeriods: Chuỗi được bản địa hóa theo ngôn ngữ thiết bị, mô tả độ dài của ưu đãi. Ví dụ: ưu đãi dùng thử ba ngày sẽ hiển thị 3 days trong trường này. • subscriptionPeriod: Ngoài ra, bạn có thể lấy thông tin chi tiết riêng lẻ của chu kỳ ưu đãi bằng thuộc tính này. Nó hoạt động tương tự như mô tả ở phần trước đối với ưu đãi. • localizedSubscriptionPeriod: Chu kỳ gói đăng ký được định dạng theo ngôn ngữ của người dùng.

Tăng tốc tải flow với flow mặc định cho đối tượng mặc định

Thông thường, flow được tải gần như tức thì nên bạn không cần lo lắng về việc tăng tốc quá trình này. Tuy nhiên, trong trường hợp bạn có nhiều đối tượng và placement, và người dùng có kết nối internet yếu, việc tải flow có thể mất nhiều thời gian hơn mong muốn. Trong những tình huống đó, bạn có thể muốn hiển thị một flow mặc định để đảm bảo trải nghiệm người dùng mượt mà thay vì không hiển thị gì cả.

Để giải quyết vấn đề này, bạn có thể dùng phương thức getFlowForDefaultAudience, phương thức này sẽ lấy flow của placement được chỉ định cho đối tượng All Users. Tuy nhiên, điều quan trọng cần hiểu là cách tiếp cận được khuyến nghị là lấy flow bằng phương thức getFlow, như đã mô tả chi tiết trong phần Lấy thông tin flow ở trên.

Adapty.getFlowForDefaultAudience(
    placementId = "YOUR_PLACEMENT_ID",
    fetchPolicy = AdaptyPaywallFetchPolicy.Default
).onSuccess { flow ->
    // the requested flow
}.onError { error ->
    // handle the error
}

Tham số	Bắt buộc	Mô tả
placementId	bắt buộc	Định danh của Placement. Đây là giá trị bạn đã chỉ định khi tạo placement trong Adapty Dashboard.
fetchPolicy	mặc định: AdaptyPaywallFetchPolicy.Default	Theo mặc định, SDK sẽ cố tải dữ liệu từ máy chủ và trả về dữ liệu đã cache trong trường hợp thất bại. Chúng tôi khuyến nghị lựa chọn này vì nó đảm bảo người dùng luôn nhận được dữ liệu mới nhất. Tuy nhiên, nếu bạn cho rằng người dùng của mình thường xuyên gặp kết nối internet không ổn định, hãy cân nhắc sử dụng AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad để trả về dữ liệu đã cache nếu có. Trong trường hợp này, người dùng có thể không nhận được dữ liệu mới nhất tuyệt đối, nhưng thời gian tải sẽ nhanh hơn, bất kể kết nối internet của họ có chập chờn đến đâu. Cache được cập nhật thường xuyên, vì vậy hoàn toàn an toàn khi sử dụng trong suốt phiên làm việc để tránh các yêu cầu mạng. Lưu ý rằng cache vẫn còn nguyên sau khi khởi động lại ứng dụng và chỉ bị xóa khi ứng dụng được cài đặt lại hoặc thông qua việc dọn dẹp thủ công.

Trước khi hiển thị Remote Config và paywall tùy chỉnh, bạn cần lấy thông tin về chúng. Lưu ý rằng chủ đề này đề cập đến Remote Config và paywall tùy chỉnh. Để biết hướng dẫn lấy paywall cho các paywall được tùy chỉnh bằng Paywall Builder, vui lòng tham khảo Lấy paywall Paywall Builder và cấu hình của chúng.

Trước khi bắt đầu lấy paywall và sản phẩm trong ứng dụng của bạn (nhấn để mở rộng)

1. Tạo sản phẩm của bạn trong Adapty Dashboard.

2. Tạo paywall và thêm sản phẩm vào paywall của bạn trong Adapty Dashboard.

3. Tạo placement và thêm paywall vào placement trong Adapty Dashboard.

4. Cài đặt Adapty SDK vào ứng dụng di động của bạn.

Lấy thông tin paywall

Trong Adapty, một sản phẩm là sự kết hợp của các sản phẩm từ App Store và Google Play. Các sản phẩm đa nền tảng này được tích hợp vào các paywall, cho phép bạn hiển thị chúng trong các placement cụ thể của ứng dụng di động.

Để hiển thị các sản phẩm, bạn cần lấy một Paywall từ một trong các placement của mình bằng phương thức getPaywall.

Adapty.getPaywall(
    placementId = "YOUR_PLACEMENT_ID", 
    locale = "en",
    fetchPolicy = AdaptyPaywallFetchPolicy.Default,
    loadTimeout = 5.seconds
).onSuccess { paywall ->
    // the requested paywall
}.onError { error ->
    // handle the error
}

Tham số	Bắt buộc	Mô tả
placementId	bắt buộc	Định danh của Placement. Đây là giá trị bạn đã chỉ định khi tạo placement trong Adapty Dashboard.
locale	tùy chọn mặc định: en	Định danh của bản địa hóa paywall. Tham số này phải là mã ngôn ngữ gồm một hoặc nhiều thẻ con phân cách bằng ký tự dấu trừ (-). Thẻ con đầu tiên là ngôn ngữ, thẻ con thứ hai là vùng. Ví dụ: en là tiếng Anh, pt-br là tiếng Bồ Đào Nha (Brazil).
fetchPolicy	mặc định: AdaptyPaywallFetchPolicy.Default	Theo mặc định, SDK sẽ cố tải dữ liệu từ máy chủ và trả về dữ liệu đã lưu trong bộ nhớ đệm nếu thất bại. Chúng tôi khuyến nghị cách này vì nó đảm bảo người dùng luôn nhận được dữ liệu mới nhất. Tuy nhiên, nếu bạn cho rằng người dùng của mình thường gặp kết nối internet không ổn định, hãy cân nhắc dùng AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad để trả về dữ liệu đã lưu trong bộ nhớ đệm nếu có. Trong trường hợp này, người dùng có thể không nhận được dữ liệu mới nhất tuyệt đối, nhưng sẽ tải nhanh hơn dù kết nối internet kém. Bộ nhớ đệm được cập nhật thường xuyên nên hoàn toàn an toàn khi sử dụng trong phiên để tránh các yêu cầu mạng. Lưu ý rằng bộ nhớ đệm vẫn còn nguyên sau khi khởi động lại ứng dụng và chỉ bị xóa khi gỡ cài đặt ứng dụng hoặc dọn dẹp thủ công. Adapty SDK lưu trữ paywall theo hai lớp: bộ nhớ đệm được cập nhật thường xuyên như mô tả ở trên và paywall dự phòng. Chúng tôi cũng dùng CDN để tải paywall nhanh hơn và một máy chủ dự phòng độc lập trong trường hợp CDN không truy cập được. Hệ thống này được thiết kế để đảm bảo bạn luôn nhận được phiên bản mới nhất của paywall trong khi vẫn đảm bảo độ tin cậy ngay cả khi kết nối internet hạn chế.
loadTimeout	mặc định: 5 giây	Giá trị này giới hạn thời gian chờ cho phương thức này. Nếu hết thời gian chờ, dữ liệu đã lưu trong bộ nhớ đệm hoặc fallback cục bộ sẽ được trả về. Lưu ý rằng trong một số trường hợp hiếm gặp, phương thức này có thể hết thời gian chờ muộn hơn một chút so với giá trị đã chỉ định trong loadTimeout, vì thao tác có thể bao gồm nhiều yêu cầu khác nhau bên dưới.

Đừng hardcode product ID! Vì paywall được cấu hình từ xa, các sản phẩm có sẵn, số lượng sản phẩm và các ưu đãi đặc biệt (như dùng thử miễn phí) có thể thay đổi theo thời gian. Hãy đảm bảo code của bạn xử lý được những tình huống này. Ví dụ: nếu ban đầu bạn lấy được 2 sản phẩm, app cần hiển thị đúng 2 sản phẩm đó. Nhưng nếu sau này lấy được 3 sản phẩm, app phải hiển thị cả 3 mà không cần thay đổi code. Thứ duy nhất bạn phải hardcode là placement ID.

Tham số trả về:

Tham số	Mô tả
Paywall	Đối tượng AdaptyPaywall bao gồm: danh sách ID sản phẩm, định danh paywall, Remote Config và một số thuộc tính khác.

Lấy sản phẩm

Sau khi có paywall, bạn có thể truy vấn mảng sản phẩm tương ứng với nó:

Adapty.getPaywallProducts(paywall).onSuccess { products ->
    // the requested products
}.onError { error ->
    // handle the error
}

Tham số phản hồi:

Parameter	Description
Products	Danh sách các đối tượng AdaptyPaywallProduct bao gồm: mã định danh sản phẩm, tên sản phẩm, giá, đơn vị tiền tệ, thời hạn gói đăng ký, và một số thuộc tính khác.

Khi tự thiết kế paywall, bạn sẽ cần truy cập các thuộc tính từ đối tượng AdaptyPaywallProduct. Dưới đây là các thuộc tính được sử dụng phổ biến nhất — tham khảo tài liệu được liên kết để xem đầy đủ chi tiết về tất cả các thuộc tính có sẵn.

Thuộc tính	Mô tả
Title	Để hiển thị tiêu đề sản phẩm, sử dụng product.localizedTitle. Lưu ý rằng bản địa hóa dựa trên quốc gia cửa hàng mà người dùng đã chọn, chứ không phải ngôn ngữ của thiết bị.
Price	Để hiển thị giá đã được bản địa hóa, sử dụng product.price.localizedString. Bản địa hóa này dựa trên thông tin ngôn ngữ của thiết bị. Bạn cũng có thể truy cập giá dưới dạng số bằng product.price.amount. Giá trị sẽ được cung cấp theo đơn vị tiền tệ địa phương. Để lấy ký hiệu tiền tệ tương ứng, sử dụng product.price.currencySymbol.
Subscription Period	Để hiển thị chu kỳ (ví dụ: tuần, tháng, năm, v.v.), sử dụng product.subscriptionDetails?.localizedSubscriptionPeriod. Bản địa hóa này dựa trên ngôn ngữ của thiết bị. Để lấy chu kỳ gói đăng ký theo cách lập trình, sử dụng product.subscriptionDetails?.subscriptionPeriod. Từ đó bạn có thể truy cập enum unit để lấy độ dài (tức là DAY, WEEK, MONTH, YEAR hoặc UNKNOWN). Giá trị numberOfUnits sẽ cho bạn biết số đơn vị chu kỳ. Ví dụ: với gói đăng ký theo quý, bạn sẽ thấy MONTH trong thuộc tính unit và 3 trong thuộc tính numberOfUnits.
Introductory Offer	Để hiển thị huy hiệu hoặc chỉ báo khác cho thấy gói đăng ký có ưu đãi giới thiệu, hãy kiểm tra thuộc tính product.subscriptionDetails?.introductoryOfferPhases. Đây là danh sách có thể chứa tối đa hai giai đoạn giảm giá: giai đoạn dùng thử miễn phí và giai đoạn giá ưu đãi giới thiệu. Trong mỗi đối tượng giai đoạn có các thuộc tính hữu ích sau: • paymentMode: một enum với các giá trị FREE_TRIAL, PAY_AS_YOU_GO, PAY_UPFRONT và UNKNOWN. Giai đoạn dùng thử miễn phí sẽ có kiểu FREE_TRIAL. • price: Giá giảm dưới dạng số. Với giai đoạn dùng thử miễn phí, giá trị này là 0. • localizedNumberOfPeriods: một chuỗi được bản địa hóa theo ngôn ngữ thiết bị, mô tả độ dài của ưu đãi. Ví dụ: ưu đãi dùng thử ba ngày sẽ hiển thị 3 days trong trường này. • subscriptionPeriod: Ngoài ra, bạn có thể lấy thông tin chi tiết riêng lẻ của chu kỳ ưu đãi bằng thuộc tính này. Cách hoạt động tương tự như phần trước đã mô tả đối với chu kỳ gói đăng ký thông thường. • localizedSubscriptionPeriod: Chu kỳ gói đăng ký được định dạng theo ngôn ngữ của người dùng cho phần giảm giá.

Tăng tốc độ tải paywall với paywall đối tượng mặc định

Thông thường, paywall được tải gần như ngay lập tức, vì vậy bạn không cần lo lắng về việc tăng tốc quá trình này. Tuy nhiên, trong trường hợp bạn có nhiều đối tượng và paywall, và người dùng của bạn có kết nối internet yếu, việc tải paywall có thể mất nhiều thời gian hơn mong muốn. Trong những tình huống như vậy, bạn có thể muốn hiển thị một paywall mặc định để đảm bảo trải nghiệm người dùng mượt mà thay vì không hiển thị paywall nào cả.

Để giải quyết vấn đề này, bạn có thể sử dụng phương thức getPaywallForDefaultAudience, phương thức này sẽ lấy paywall của placement được chỉ định cho đối tượng All Users. Tuy nhiên, điều quan trọng cần hiểu là cách tiếp cận được khuyến nghị là lấy paywall bằng phương thức getPaywall, như đã trình bày chi tiết trong phần Lấy thông tin Paywall ở trên.

Adapty.getPaywallForDefaultAudience(
    placementId = "YOUR_PLACEMENT_ID",
    locale = "en",
    fetchPolicy = AdaptyPaywallFetchPolicy.Default
).onSuccess { paywall ->
    // the requested paywall
}.onError { error ->
    // handle the error
}

Tham số	Bắt buộc	Mô tả
placementId	bắt buộc	Mã định danh của Placement. Đây là giá trị bạn đã chỉ định khi tạo placement trong Adapty Dashboard.
locale	tùy chọn mặc định: en	Mã định danh của bản địa hóa paywall. Tham số này là mã ngôn ngữ gồm một hoặc nhiều subtag được phân tách bằng ký tự dấu trừ (-). Subtag đầu tiên là mã ngôn ngữ, subtag thứ hai là mã vùng. Ví dụ: en là tiếng Anh, pt-br là tiếng Bồ Đào Nha (Brazil).
fetchPolicy	mặc định: AdaptyPaywallFetchPolicy.Default	Theo mặc định, SDK sẽ cố tải dữ liệu từ máy chủ và trả về dữ liệu đã lưu trong bộ nhớ đệm nếu thất bại. Chúng tôi khuyến nghị phương án này vì nó đảm bảo người dùng luôn nhận được dữ liệu mới nhất. Tuy nhiên, nếu bạn cho rằng người dùng của mình thường xuyên gặp kết nối internet không ổn định, hãy cân nhắc dùng AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad để trả về dữ liệu đã lưu trong bộ nhớ đệm nếu có. Trong trường hợp này, người dùng có thể không nhận được dữ liệu mới nhất tuyệt đối, nhưng thời gian tải sẽ nhanh hơn bất kể chất lượng kết nối internet như thế nào. Bộ nhớ đệm được cập nhật thường xuyên, vì vậy hoàn toàn an toàn khi sử dụng trong suốt phiên làm việc để tránh các yêu cầu mạng. Lưu ý rằng bộ nhớ đệm vẫn còn nguyên sau khi khởi động lại ứng dụng và chỉ bị xóa khi cài đặt lại ứng dụng hoặc xóa thủ công.