Sử dụng localization và mã ngôn ngữ trong Kotlin Multiplatform SDK

Tại sao điều này quan trọng

Mã locale được dùng khi Adapty chọn ngôn ngữ hiển thị cho một flow, và khi bạn đọc Remote Config cho một paywall tùy chỉnh.

Mã locale khá phức tạp và có thể khác nhau tùy từng nền tảng, vì vậy Adapty sử dụng một chuẩn nội bộ thống nhất trên mọi nền tảng được hỗ trợ. Hiểu rõ chuẩn đó giúp bạn dự đoán được ngôn ngữ nào người dùng sẽ nhận được.

Tiêu chuẩn mã ngôn ngữ tại Adapty

Đối với mã ngôn ngữ, Adapty sử dụng tiêu chuẩn BCP 47 được chỉnh sửa nhẹ: mỗi mã bao gồm các subtag viết thường, phân cách bằng dấu gạch ngang. Một số ví dụ: en (tiếng Anh), pt-br (tiếng Bồ Đào Nha (Brazil)), zh (tiếng Trung giản thể), zh-hant (tiếng Trung phồn thể).

Khớp mã ngôn ngữ

Khi Adapty tìm kiếm bản địa hóa phù hợp với ngôn ngữ của người dùng, quá trình diễn ra như sau:

  1. Chuỗi ngôn ngữ được chuyển thành chữ thường và tất cả dấu gạch dưới (_) được thay thế bằng dấu gạch ngang (-)
  2. Adapty tìm kiếm bản địa hóa có mã ngôn ngữ khớp hoàn toàn
  3. Nếu không tìm thấy, Adapty lấy chuỗi con trước dấu gạch ngang đầu tiên (pt trong pt-br) và tìm kiếm bản địa hóa phù hợp
  4. Nếu vẫn không tìm thấy, Adapty trả về bản địa hóa mặc định en

Theo cách này, 'pt_BR', pt-BRpt-br đều được ánh xạ đến cùng một bản địa hóa.

Triển khai bản địa hóa

Trong SDK v4, bạn không cần truyền mã ngôn ngữ khi lấy một flow.

  • Paywall từ Flow Builder và Paywall Builder: Adapty tự động xác định bản địa hóa dựa trên thiết bị và các bản địa hóa bạn đã cấu hình trong builder. Render flow bằng createFlowView — không cần mã ngôn ngữ.
  • Paywall tùy chỉnh (Remote Config): getFlow trả về tất cả các bản địa hóa đã cấu hình trong flow.remoteConfigs. Mỗi mục là một AdaptyRemoteConfig với localedataMap. Hãy chọn mục phù hợp với người dùng, tự xử lý logic dự phòng theo ý bạn:

Adapty.getFlow("YOUR_PLACEMENT_ID")
    .onSuccess { flow ->
        val config = flow.remoteConfigs.firstOrNull { it.locale == "en" }
            ?: flow.remoteConfigs.firstOrNull()
        // read your values from config?.dataMap
    }
    .onError { error ->
        // handle the error
    }

Các quy tắc khớp mã locale ở trên mô tả cách Adapty chuẩn hóa các mã locale được lưu trữ trên mỗi Remote Config.

Tại sao điều này quan trọng

Có một số trường hợp mà locale code phát huy vai trò quan trọng — ví dụ, khi bạn cần lấy đúng paywall theo ngôn ngữ hiện tại của ứng dụng.

Vì locale code khá phức tạp và có thể khác nhau giữa các nền tảng, chúng tôi sử dụng một tiêu chuẩn nội bộ thống nhất cho tất cả các nền tảng được hỗ trợ. Tuy nhiên, chính vì sự phức tạp đó, bạn cần hiểu rõ mình đang gửi gì lên server để nhận đúng bản địa hóa, và điều gì xảy ra tiếp theo — để đảm bảo bạn luôn nhận được kết quả như kỳ vọng.

Tiêu chuẩn mã ngôn ngữ tại Adapty

Đối với mã ngôn ngữ, Adapty sử dụng tiêu chuẩn BCP 47 được chỉnh sửa một chút: mỗi mã gồm các subtag viết thường, ngăn cách nhau bằng dấu gạch ngang. Ví dụ: en (tiếng Anh), pt-br (tiếng Bồ Đào Nha (Brazil)), zh (tiếng Trung giản thể), zh-hant (tiếng Trung phồn thể).

Khớp mã ngôn ngữ

Khi Adapty nhận được lệnh gọi từ SDK phía client kèm mã ngôn ngữ và bắt đầu tìm kiếm bản dịch tương ứng của paywall, quá trình diễn ra như sau:

  1. Chuỗi ngôn ngữ đầu vào được chuyển về chữ thường và tất cả dấu gạch dưới (_) được thay bằng dấu gạch ngang (-)
  2. Hệ thống tìm kiếm bản dịch có mã ngôn ngữ khớp hoàn toàn
  3. Nếu không tìm thấy, hệ thống lấy phần chuỗi trước dấu gạch ngang đầu tiên (pt trong pt-br) và tìm kiếm bản dịch khớp với chuỗi đó
  4. Nếu vẫn không tìm thấy, hệ thống trả về bản dịch mặc định en

Bằng cách này, một thiết bị iOS gửi 'pt_BR', một thiết bị Android gửi pt-BR, và một thiết bị khác gửi pt-br đều sẽ nhận được cùng một kết quả.

Nếu bạn đang cân nhắc về bản địa hóa, khả năng cao là bạn đã làm việc với các tệp tài nguyên chuỗi đã được bản địa hóa trong dự án của mình. Nếu vậy, chúng tôi khuyến nghị bạn đặt một cặp key-value với mã locale Adapty tương ứng vào từng tệp tài nguyên cho mỗi bản địa hóa. Sau đó, lấy giá trị của key đó khi gọi SDK của chúng tôi, như sau:

// 1. Add the Adapty locale code to your Compose Multiplatform resources

/*
composeResources/values/strings.xml (default — English)
*/
<string name="adapty_paywalls_locale">en</string>

/*
composeResources/values-es/strings.xml (Spanish)
*/
<string name="adapty_paywalls_locale">es</string>

/*
composeResources/values-pt-rBR/strings.xml (Portuguese — Brazil)
*/
<string name="adapty_paywalls_locale">pt-br</string>

// 2. Extract and use the locale code

suspend fun fetchPaywall() {
    val locale = getString(Res.string.adapty_paywalls_locale)
    Adapty.getPaywall(
        placementId = "YOUR_PLACEMENT_ID",
        locale = locale
    ).onSuccess { paywall ->
        // the requested paywall
    }.onError { error ->
        // handle the error
    }
}

Bằng cách đó, bạn có thể đảm bảo rằng mình hoàn toàn kiểm soát được bản dịch nào sẽ được tải về cho từng người dùng trong ứng dụng.

Nếu bạn không sử dụng Compose Multiplatform resources, ý tưởng tương tự cũng áp dụng cho bất kỳ thư viện localization nào bạn đang dùng (ví dụ: moko-resources) — hãy lưu mã ngôn ngữ Adapty dưới dạng chuỗi trong từng resource bundle của mỗi ngôn ngữ, rồi đọc nó trước khi gọi SDK.

Triển khai bản địa hóa: cách khác

Bạn có thể đạt được kết quả tương tự (nhưng không hoàn toàn giống nhau) mà không cần định nghĩa tường minh mã ngôn ngữ cho từng bản địa hóa. Cách này sẽ trích xuất mã ngôn ngữ trực tiếp từ thiết bị — điều này yêu cầu khai báo expect/actual, vì không có API ngôn ngữ dùng chung trong commonMain:

// commonMain
expect fun currentLocaleTag(): String

// androidMain
actual fun currentLocaleTag(): String = Locale.getDefault().toLanguageTag()

// iosMain
actual fun currentLocaleTag(): String = NSLocale.currentLocale.localeIdentifier

// commonMain — pass the locale code to Adapty

suspend fun fetchPaywall() {
    Adapty.getPaywall(
        placementId = "YOUR_PLACEMENT_ID",
        locale = currentLocaleTag()
    ).onSuccess { paywall ->
        // the requested paywall
    }.onError { error ->
        // handle the error
    }
}

Lưu ý rằng chúng tôi không khuyến nghị cách tiếp cận này vì một số lý do:

  1. Trên iOS, ngôn ngữ ưa thích của người dùng và locale khu vực của thiết bị không giống nhau. NSLocale.currentLocale.localeIdentifier trả về locale khu vực, có thể khác với ngôn ngữ mà người dùng thực sự đọc ứng dụng của bạn. Các ứng dụng iOS sử dụng file chuỗi đã bản địa hóa dựa vào logic phân giải của Apple để kết hợp cả hai — điều này hoạt động tốt ngay từ đầu với cách tiếp cận được khuyến nghị ở trên.
  2. Rất khó dự đoán chính xác thiết bị sẽ trả về gì và liệu nó có khớp với một bản địa hóa trong Adapty hay không. Locale của thiết bị có thể bao gồm các phần mở rộng hoặc mã vùng mà bạn chưa cấu hình trong Adapty, trong trường hợp đó SDK sẽ dự phòng về kết quả khớp với subtag đầu tiên hoặc cuối cùng là về en.

Should you decide to use this approach anyway — make sure you’ve covered all the relevant use cases.