Tham khảo SDK
Tổng quan SDK
Sao chép trang
Tải Lia SDK, các thuộc tính của đối tượng Lia, cách các cuộc gọi trả lời và thất bại, và một chỉ mục cho mọi phương thức.
#Tải nó
<script src="https://api.lialabs.org/sdk/lia-apps-v1.js"></script>Tải nó từ Lia, trước khi các tập lệnh của bạn. Nó xác định một biến toàn cục, window.Lia, một lần (tải nó hai lần không có gì xảy ra). Nó'giao diện thuần túy JavaScript không có phụ thuộc, và hoạt động với bất kỳ khung nào hoặc không có khung nào. Trang này mô tả phiên bản 1.8.1.
Trong TypeScript, khai báo toàn cục cho đến khi có's về (một điện thoại có sóng tín hiệu, một túi mua sắm), lớn và bóng loáng
declare global {
interface Window { Lia: any }
}
const Lia = window.Lia;#Cách các cuộc gọi được trả lời
- Hầu hết các phương pháp trả về một lời hứa. Nó sẽ trả về câu trả lời được mô tả cho mỗi phương thức, hoặc từ chối với một
Errorcó mộtcode(và mộtmessagebằng tiếng Anh cho bạn, không phải cho người chơi). - Các tham số xấu cũng bị từ chối, với mã như
bad_text, trước khi bất kỳ thứ gì đến Lia. Một số phương thức không'trả về các lời hứa (Lia.inviteLink,Lia.on, các nút' các hàm thiết lập) sẽ ném ra thay vì vậy. - Ngoài ứng dụng Lia), mọi cuộc gọi đều bị từ chối với
not_in_lia.Lia.availablenói với bạn ngay từ đầu. - Lia phải trả lời trong 20 giây, hoặc cuộc gọi từ chối với
timeout. Các cuộc gọi chờ đợi người (bảng thanh toán, quảng cáo, hộp thoại, người bạn chọn, yêu cầu thông báo, máy quét, bảng nhớ, Face ID, chia sẻ) sẽ chờ đợi lâu như cần.
try {
const result = await Lia.pay("extra-lives");
} catch (error) {
switch (error.code) {
case "cancelled": return; // they changed their mind
case "not_in_lia": return showOpenInLia();
default: Lia.toast("Something went wrong", { tone: "error" });
}
}Mỗi mã đều được liệt kê trong Mã lỗi.
#Tính chất
Đọc sau đây Lia.init() đã trả lời; trước đó họ giữ các giá trị mặc định. Hầu hết được cập nhật bởi Lia'sự kiện.
| Tính chất | Loại | Cái gì nó là |
|---|---|---|
Lia.version | chuỗi | Cái SDK'mà phiên bản, ví dụ "1.8.1". |
Lia.available | boolean | true trong ứng dụng Lia. Được biết ngay khi script được tải. |
Lia.platform | chuỗi | "ios" hoặc "android" ("unknown" trước init()). |
Lia.language | chuỗi | Người'ngôn ngữ trong Lia: en, es, pt, fr, tr, ru, vi, id, fil, sw, hi, ar hoặc zh. Xem Ngôn ngữ. |
Lia.rtl | boolean | Liệu ngôn ngữ đó có được đọc từ phải sang trái (tiếng Ả Rập). |
Lia.colorScheme | chuỗi | "light" hoặc "dark". |
Lia.theme | đối tượng | Lia'màu sắc, như bg_color, text_color và phần còn lại. Xem Lia'mà chủ đề. |
Lia.viewport | đối tượng | { height, expanded }: trang của bạn'chiều cao của nó tính bằng px, và liệu một tấm có ở chiều cao tối đa hay không. |
Lia.safeArea | đối tượng | { top, bottom, left, right }: điện thoại'khu vực an toàn tính bằng px. |
Lia.contentSafeArea | đối tượng | { top, bottom, left, right }: cũng xóa Lia'các điều khiển trôi nổi trong chế độ toàn màn hình. |
Lia.display | chuỗi | Cách ứng dụng của bạn được mở: "sheet", "full" hoặc "fullscreen". |
Lia.isFullscreen | boolean | Có phải nó'cạnh sát cạnh ngay bây giờ. |
Lia.startParam | chuỗi hoặc null | Cái gì nó được mở bằng: một lời mời'mà một liên kết'hoặc một thông báo'của startParam. null khi được mở từ Trung tâm Ứng dụng. |
Lia.soundOn | boolean | Liệu người đó có muốn ứng dụng của bạn'âm thanh. |
Lia.notificationsAllowed | boolean | Liệu người đó có cho phép ứng dụng của bạn gửi thông báo cho họ không. |
#Lia.isVersionAtLeast(version)
Liệu SDK có ít nhất phiên bản này, cho các tính năng được thêm sau.
if (Lia.isVersionAtLeast("1.3")) Lia.inviteFriend({ startParam: room });| Tham số | Loại | |
|---|---|---|
version | chuỗi | Thích "1.3" hoặc "1.3.0". |
Trả về một giá trị boolean (không phải là một lời hứa).
#CSS biến
Sau init(), SDK thiết lập những điều này trên trang của bạn'căn bản và giữ chúng cập nhật: Lia'mà chủ đề (--lia-bg-color và phần còn lại), --lia-color-scheme, --lia-viewport-height, --lia-safe-area-inset-* và --lia-content-safe-area-inset-*. Xem Giao diện và cảm giác.
#Mỗi phương pháp
| Khu vực | Phương pháp |
|---|---|
| Khởi động và vòng đời | Lia.init, Lia.ready, Lia.session, Lia.close, Lia.on, Lia.off, Lia.onPause, Lia.onResume |
| Thanh toán và quảng cáo | Lia.pay, Lia.charges, Lia.onCharge, Lia.showAd, Lia.showRewardedAd, Lia.showRewardedInterstitialAd, Lia.showInterstitialAd, Lia.onAd |
| Thông báo và lời mời | Lia.requestNotifications, Lia.inviteFriend, Lia.inviteLink, Lia.share |
| Hộp thoại | Lia.confirm, Lia.showPopup, Lia.showAlert, Lia.showConfirm, Lia.toast |
| Bố cục, màu sắc và nút | Lia.expand, Lia.requestFullscreen, Lia.exitFullscreen, Lia.enableExpand, Lia.disableExpand, Lia.enableVerticalSwipes, Lia.disableVerticalSwipes, Lia.enableClosingConfirmation, Lia.disableClosingConfirmation, Lia.setBackgroundColor, Lia.setHeaderColor, Lia.mainButton, Lia.secondaryButton, Lia.backButton, Lia.settingsButton |
| Thiết bị | Lia.haptic, Lia.scanQr, Lia.copyText, Lia.readClipboard, Lia.openLink, Lia.openLiaLink, Lia.biometric, Lia.accelerometer, Lia.gyroscope, Lia.deviceOrientation |
| Điểm số và lưu trữ | Lia.submitScore, Lia.leaderboard, Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage |
#Đến từ Telegram
Lia's SDK theo dõi Telegram's Ứng dụng Nhỏ ở đâu phù hợp, vì vậy hầu hết ý tưởng đều có thể chuyển tiếp:
| Telegram | Lia |
|---|---|
Telegram.WebApp.initData | Lia.init() câu trả lời với một mã phiên mà máy chủ của bạn xác minh bằng POST /session/verify. |
themeParams, --tg-theme-* | Lia.theme, --lia-* (cùng tên) |
MainButton, SecondaryButton, BackButton, SettingsButton | Lia.mainButton, Lia.secondaryButton, Lia.backButton, Lia.settingsButton |
HapticFeedback | Lia.haptic(kind) |
CloudStorage, DeviceStorage, SecureStorage | Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage (các lời hứa, không phải các callback) |
showPopup, showAlert, showConfirm | Cùng một, như các lời hứa |
openInvoice và các ngôi sao | Lia.pay(productId), được trả bằng $LIA |
start_param | Lia.startParam |
#Phân tích ứng dụng web
Lia.analytics (SDK 1.8) ghi lại việc sử dụng ứng dụng web tùy chọn trong Lia Labs' OpenPanel dự án. Nó hoạt động với các phiên bản hiện tại của iOS và Android. Đây là một tùy chọn đăng ký riêng biệt từ công tắc "Chia sẻ dữ liệu sử dụng" trong ứng dụng gốc.
Khi trang của bạn gọi Lia.ready(), SDK kiểm tra xem liệu phân tích có được bật bởi đội ngũ hay không và hỏi một lần nếu người chơi này chưa chọn cho ứng dụng này. Từ chối sẽ không gửi bất kỳ sự kiện nào. Một nút riêng tư nhỏ cho phép người đó thay đổi lựa chọn của họ sau này. Lựa chọn được lưu trữ theo từng người chơi và ứng dụng web trên máy chủ của Lia. Không có sự kiện phân tích nào được hàng đợi trước khi đồng ý hoặc được phát lại sau khi từ chối.
Lia.analytics.allowed: xem trang này hiện tại có quyền hay không.Lia.analytics.requestConsent(): mở lại lựa chọn riêng tư và trả lờitruechỉ sau khi được phép.Lia.analytics.disable(): dừng ngay lập tức việc gửi của trang này và lưu trữ sự từ chối.Lia.analytics.track(name, properties?): trả lời xem một sự kiện có được gửi hay không; các lần thất bại không bao giờ làm dừng trò chơi của bạn. Tên sử dụng chữ thường, chữ số và gạch dưới, bắt đầu bằng chữ cái và có tối đa 48 ký tự. Các thuộc tính cho phép tối đa 12 giá trị số hoặc boolean, với các khóa xác định chữ thường có tối đa 32 ký tự.
await Lia.init();
Lia.ready();
// Only sends when the person has already agreed. Never prompt during a round.
await Lia.analytics.track("round_finished", { level: 3, score: 120, won: true });Các bản ghi SDK mở và tiếp tục sau khi được đồng ý. Thêm tên sự kiện tĩnh của riêng bạn cho các mốc trò chơi. Không sử dụng tên, email, tin nhắn, URLs, văn bản tự do hoặc các định danh tài khoản làm tên sự kiện. Các thuộc tính văn bản bị từ chối. Bộ thu thập thêm id ứng dụng và chế độ live/test, kiểm tra phiên đã ký, kiểm tra lại sự đồng ý, tuân thủ công tắc phân tích của đội ngũ, và giới hạn sự kiện ở 60 mỗi người chơi mỗi ứng dụng mỗi phút. Nó chuyển tiếp các sự kiện tổng hợp mà không cần id hồ sơ người chơi, trang URLs, giá trị biểu mẫu hoặc địa chỉ IP của người đó.
Trình theo dõi sử dụng POST /api/web-analytics/consent và /track với một phiên đăng nhập ứng dụng mới. Các điểm cuối do SDK sở hữu này không cần khóa API của nhà phát triển. Thông tin xác thực OpenPanel luôn ở trên máy chủ của Lia.
Các phương thức phân tích này có trong SDK được lưu trữ và tải qua thẻ script. Liên kết mời và phòng chờ không tự mở yêu cầu đồng ý; nút quyền riêng tư vẫn luôn sẵn có.
Được dịch tự động. Tiếng Anh là nguồn tin cậy. Đọc bằng tiếng Anh