API Reference

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Этот справочник API организован по типу ресурса. Каждый тип ресурса имеет одно или несколько представлений данных и один или несколько методов.

Типы ресурсов

  1. ДостижениеОпределения
  2. Достижения
  3. Приложения
  4. События
  5. Таблицы лидеров
  6. Метаигра
  7. Игроки
  8. пуштокены
  9. Редакции
  10. Номера
  11. Результаты
  12. Снимки
  13. Статистика
  14. Пошаговые матчи

ДостижениеОпределения

Подробную информацию о ресурсе AchievementDefinitions см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
список GET /achievements Список всех определений достижений для вашего приложения.

Достижения

Подробную информацию о ресурсах достижений см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
приращение POST /achievements/ achievementId /increment Увеличивает шаги достижения с заданным идентификатором для текущего аутентифицированного игрока.

Обязательные параметры запроса: stepsToIncrement

список GET /players/ playerId /achievements Отображает прогресс всех достижений вашего приложения для текущего аутентифицированного игрока.
раскрывать POST /achievements/ achievementId /reveal Устанавливает состояние достижения с данным идентификатором в REVEALED для текущего аутентифицированного игрока.
setStepsAtLeast POST /achievements/ achievementId /setStepsAtLeast Устанавливает шаги для текущего аутентифицированного игрока для разблокировки достижения. Если параметр шагов меньше текущего количества шагов, которые игрок уже набрал за достижение, достижение не модифицируется.

Обязательные параметры запроса: steps

разблокировать POST /achievements/ achievementId /unlock Разблокирует это достижение для текущего аутентифицированного игрока.
обновлениеНесколько POST /achievements/updateMultiple Обновляет несколько достижений для текущего аутентифицированного игрока.

Приложения

Сведения о ресурсах приложений см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /applications/ applicationId Извлекает метаданные приложения с заданным идентификатором. Если запрошенное приложение недоступно для указанного platformType , возвращаемый ответ не будет включать никаких данных экземпляра.
играл POST /applications/played Укажите, что текущий аутентифицированный пользователь играет в ваше приложение.
проверять GET /applications/ applicationId /verify Проверяет, что токен аутентификации, предоставленный с этим запросом, предназначен для приложения с указанным идентификатором, и возвращает идентификатор игрока, для которого он был предоставлен.

События

Сведения о ресурсе Events см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
списокByPlayer GET /events Возвращает список, показывающий текущий ход событий в этом приложении для текущего пользователя, прошедшего проверку подлинности.
listDefinitions GET /eventDefinitions Возвращает список определений событий в этом приложении.
записывать POST /events Записывает пакет изменений количества событий, произошедших для текущего аутентифицированного пользователя этого приложения.

Таблицы лидеров

Подробную информацию о ресурсах списков лидеров см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /leaderboards/ leaderboardId Получает метаданные таблицы лидеров с заданным идентификатором.
список GET /leaderboards Список всех метаданных таблицы лидеров для вашего приложения.

Метаигра

Подробную информацию о ресурсах Metagame см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
getMetagameConfig GET /metagameConfig Верните данные конфигурации метаигры для вызывающего приложения.
списокКатегорийПоИгроку GET /players/ playerId /categories/ collection Список данных воспроизведения, агрегированных по категориям для игрока, соответствующего playerId .

Игроки

Подробную информацию о ресурсах игроков см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /players/ playerId Извлекает ресурс Player с заданным идентификатором. Чтобы получить проигрыватель для текущего аутентифицированного пользователя, установите для playerId значение me .
список GET /players/me/players/ collection Получить коллекцию игроков для текущего аутентифицированного пользователя.

пуштокены

Подробнее о ресурсе Pushtokens см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
удалять POST /pushtokens/remove Удаляет push-токен для текущего пользователя и приложения. Удаление несуществующего push-токена сообщит об успешном выполнении.
обновлять PUT /pushtokens Регистрирует push-токен для текущего пользователя и приложения.

Редакции

Сведения о ресурсе ревизий см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
проверять GET /revisions/check Проверяет, не устарел ли игровой клиент.

Обязательные параметры запроса: clientRevision

Номера

Подробную информацию о ресурсах Rooms см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
создавать POST /rooms/create Создайте комнату. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.
отклонить POST /rooms/ roomId /decline Отклоните приглашение присоединиться к комнате. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.
увольнять POST /rooms/ roomId /dismiss Отклонить приглашение присоединиться к комнате. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.
получать GET /rooms/ roomId Получить данные для комнаты.
присоединиться POST /rooms/ roomId /join Присоединяйтесь к комнате. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.
оставлять POST /rooms/ roomId /leave Оставьте комнату. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.
список GET /rooms Возвращает приглашения присоединиться к комнатам.
отчетСтатус POST /rooms/ roomId /reportstatus Обновления, отправляемые клиентом, сообщающие о состоянии пиров в комнате. Только для внутреннего использования Games SDK. Прямой вызов этого метода не поддерживается.

Результаты

Подробную информацию о ресурсе Scores см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /players/ playerId /leaderboards/ leaderboardId /scores/ timeSpan Получите высокие баллы и, при необходимости, места в списках лидеров для текущего аутентифицированного игрока. Для определенного промежутка времени leaderboardId можно установить значение ALL , чтобы получить данные для всех списков лидеров за данный промежуток времени.
ПРИМЕЧАНИЕ. Вы не можете запрашивать «ВСЕ» списки лидеров и «ВСЕ» интервалы времени в одном запросе; только один параметр может быть установлен на «ВСЕ».
список GET /leaderboards/ leaderboardId /scores/ collection Перечисляет баллы в таблице лидеров, начиная сверху.

Обязательные параметры запроса: timeSpan

списококно GET /leaderboards/ leaderboardId /window/ collection Перечисляет очки в таблице лидеров вокруг (и включая) очков игрока.

Обязательные параметры запроса: timeSpan

представлять на рассмотрение POST /leaderboards/ leaderboardId /scores Отправляет счет в указанную таблицу лидеров.

Обязательные параметры запроса: score

отправитьНесколько POST /leaderboards/scores Отправляет несколько результатов в таблицы лидеров.

Снимки

Сведения о ресурсе моментальных снимков см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /snapshots/ snapshotId Извлекает метаданные для заданного идентификатора моментального снимка.
список GET /players/ playerId /snapshots Получает список снимков, созданных вашим приложением для игрока, соответствующего идентификатору игрока.

Статистика

Подробную информацию о ресурсе статистики см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
получать GET /stats Возвращает статистику взаимодействия и расходов в этом приложении для текущего пользователя, прошедшего проверку подлинности.

Пошаговые матчи

Подробную информацию о ресурсах TurnBasedMatches см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/games/v1, если не указано иное.
отмена PUT /turnbasedmatches/ matchId /cancel Отменить пошаговый матч.
создавать POST /turnbasedmatches/create Создайте пошаговый матч.
отклонить PUT /turnbasedmatches/ matchId /decline Отклоните приглашение сыграть пошаговый матч.
увольнять PUT /turnbasedmatches/ matchId /dismiss Удалить пошаговый матч из списка матчей. Совпадение больше не будет отображаться в списке и не будет генерировать уведомления.
заканчивать PUT /turnbasedmatches/ matchId /finish Завершите пошаговый матч. Каждый игрок должен сделать этот вызов один раз после того, как будут получены все результаты. Только игрок, чья сейчас очередь, может сделать первый вызов Finish и может пройти в состоянии финального матча.
получать GET /turnbasedmatches/ matchId Получите данные для пошагового матча.
присоединиться PUT /turnbasedmatches/ matchId /join Присоединяйтесь к пошаговому матчу.
оставлять PUT /turnbasedmatches/ matchId /leave Выйти из пошагового матча, если сейчас не ход текущего игрока, не отменяя матч.
оставитьПоворот PUT /turnbasedmatches/ matchId /leaveTurn Выйти из пошагового матча во время хода текущего игрока, не отменяя матч.

Обязательные параметры запроса: matchVersion

список GET /turnbasedmatches Возвращает пошаговые матчи, в которых игрок участвует или участвовал.
матч-реванш POST /turnbasedmatches/ matchId /rematch Создайте матч-реванш ранее завершенного матча с теми же участниками. Это может вызвать только один игрок в матче, который все еще находится в их списке; игрок должен сначала объявить Finish. Возвращает только что созданное совпадение; наступит очередь звонящего.
синхронизировать GET /turnbasedmatches/sync Возвращает пошаговые матчи, в которых участвовал или участвовал игрок, которые изменились с момента последнего вызова синхронизации, причем самые последние изменения идут первыми. Совпадения, которые должны быть удалены из локального кеша, будут иметь статус MATCH_DELETED .
принять поворот PUT /turnbasedmatches/ matchId /turn Зафиксировать результаты хода игрока.