Лидерборды

Вы можете показывать на странице игры персонализированные лидерборды (таблицы лидеров) с результатами лучших игроков и местом в рейтинге авторизованного пользователя.

Чтобы у вас заработали описанные ниже запросы, проверьте, что в Консоли разработчика создан лидерборд.

Отправка счета

Примечание

Запрос доступен только для авторизованных пользователей. Рекомендуется заранее воспользоваться авторизацией и использовать лидерборды только если пользователь предоставил персональные данные.

Используйте действие Отправить счет в лидерборд, чтобы отправить новый счет в лидерборд c параметрами:

Параметр

Тип

Описание

Название

string

Техническое название лидерборда.

Счет

number

Счет игрока в лидерборде.

Дополнительные данные

string

Необязательные метаданные, отправляемые вместе со счетом.

Например, отправка счета в лидерборд может выглядеть так:

Примечание

Запрос можно отправлять не чаще, чем раз в секунду, иначе он будет отклонен с ошибкой.

Рекомендуется использовать отправку счета в связке с отложенным событием.

Записи лидербордов

Чтобы начать работать с таблицей лидеров, используйте действие Запросить таблицу лидеров в связке с триггерными условиями При успешной загрузке таблицы лидеров и При ошибке загрузки таблицы лидеров. Действие и условия принимают следующие параметры:

Параметр

Тип

Описание

Название

string

Техническое название лидерборда.

Позиции из топа

number

Количество запрашиваемых записей из топа лидерборда.

Запросить позицию игрока

boolean

Определяет, будет ли позиция пользователя запрошена.

Позиции позиций вокруг игрока

number

Количество запрашиваемых записей ниже и выше пользователя по таблице.

Плагин запросит данные о лидерборде через SDK Яндекс Игр, после чего при успешном запросе начнется цикл. Этот процесс занимает какое-то время.

Рекомендуется оставлять на экране какое-нибудь обозначение загрузки, пока идет процесс.

Важно

Убедитесь, что данный цикл не вызывается постоянно. Рекомендуется использовать его внутри функций или триггеров.

Внутри цикла у вас будет доступ к выражениям из списка Таблицы лидеров.


Примечание

Если при работе с плагином вы столкнулись с проблемой или у вас появился вопрос, обратитесь в сообщество в Телеграме.

Репозиторий