REST Resource: players

Ресурс: Игрок

Ресурс игрока.

JSON-представление
{
  "kind": string,
  "playerId": string,
  "displayName": string,
  "avatarImageUrl": string,
  "bannerUrlPortrait": string,
  "bannerUrlLandscape": string,
  "originalPlayerId": string,
  "profileSettings": {
    object (ProfileSettings)
  },
  "name": {
    "familyName": string,
    "givenName": string
  },
  "experienceInfo": {
    object (PlayerExperienceInfo)
  },
  "title": string,
  "friendStatus": enum (FriendStatus),
  "gamePlayerId": string
}
Поля
kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#player

playerId

string

Идентификатор игрока.

displayName

string

Имя, отображаемое для игрока.

avatarImageUrl

string

Базовый URL-адрес изображения, представляющего игрока.

bannerUrlPortrait

string

URL-адрес баннера проигрывателя в портретном режиме.

bannerUrlLandscape

string

URL-адрес изображения баннера проигрывателя в ландшафтном режиме.

originalPlayerId

string

Идентификатор игрока, который использовался для этого игрока при первом входе в рассматриваемую игру. Это значение заполняется только для вызовов player.get для запрашивающего игрока, только если идентификатор игрока впоследствии изменился, и только для клиентов, которые поддерживают переназначение идентификаторов игрока.

profileSettings

object ( ProfileSettings )

Настройки профиля игрока. Определяет, виден ли профиль игрока другим игрокам.

name

object

Объектное представление отдельных компонентов имени игрока. У некоторых игроков эти поля могут отсутствовать.

name.familyName

string

Фамилия этого игрока. В некоторых местах это известно как фамилия.

name.givenName

string

Имя этого игрока. В некоторых местах это имя называют именем.

experienceInfo

object ( PlayerExperienceInfo )

Объект, представляющий информацию об опыте Play Game для игрока.

title

string

Звание игрока, присвоенное за игровую деятельность.

friendStatus

enum ( FriendStatus )

Статус друга данного игрока относительно отправителя запроса. Это значение не установлено, если игрок не делится своим списком друзей с игрой.

gamePlayerId

string

Уникальный идентификатор игрока для каждого приложения.

Настройки профиля

Настройки профиля

JSON-представление
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
Поля
kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#profileSettings .

profileVisible

boolean

Виден ли профиль игрока игроку, вошедшему в систему в данный момент.

friendsListVisibility

enum ( FriendsListVisibility )

Список друзейВидимость

Будет ли список друзей игрока виден этой игре или может быть запрошен. Это поле заполняется только для игрока, вошедшего в систему.

Перечисления
VISIBLE Список друзей в настоящее время виден игре.
REQUEST_REQUIRED У разработчика нет доступа к списку друзей, но он может вызвать API Android, чтобы отобразить диалоговое окно согласия.
UNAVAILABLE Список друзей в настоящее время недоступен для этого пользователя, и в настоящее время невозможно запросить доступ либо потому, что пользователь окончательно отклонил запрос, либо функция друзей ему недоступна. В этом состоянии любые попытки запросить доступ к списку друзей будут безуспешными.

Информация об опыте игрока

Метаданные 1P/3P об опыте игрока.

JSON-представление
{
  "kind": string,
  "currentExperiencePoints": string,
  "lastLevelUpTimestampMillis": string,
  "currentLevel": {
    object (PlayerLevel)
  },
  "nextLevel": {
    object (PlayerLevel)
  }
}
Поля
kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#playerExperienceInfo .

currentExperiencePoints

string ( int64 format)

Текущее количество очков опыта у игрока.

lastLevelUpTimestampMillis

string ( int64 format)

Временная метка повышения уровня игрока, в миллисах, начиная с эпохи Unix (UTC).

currentLevel

object ( PlayerLevel )

Текущий уровень игрока.

nextLevel

object ( PlayerLevel )

Следующий уровень игрока. Если текущий уровень является максимальным, он должен быть таким же, как текущий уровень.

Уровень игрока

Метаданные 1P/3P об уровне пользователя.

JSON-представление
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
Поля
kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#playerLevel .

level

integer

Уровень для пользователя.

minExperiencePoints

string ( int64 format)

Минимальное количество очков опыта для этого уровня.

maxExperiencePoints

string ( int64 format)

Максимальное количество очков опыта для этого уровня.

Статус друга

Определяет дружеские отношения между игроками.

Перечисления
NO_RELATIONSHIP Между игроками нет никаких отношений.
FRIEND Игрок и запрашивающий являются друзьями.

Методы

get

Получает ресурс Player с заданным идентификатором.

getMultipleApplicationPlayerIds

Получите идентификаторы игрока приложения для текущего аутентифицированного игрока во всех запрошенных играх того же разработчика, что и вызывающее приложение.

getScopedPlayerIds

Извлекает идентификаторы игроков для текущего аутентифицированного пользователя.

list

Получите коллекцию игроков для текущего аутентифицированного пользователя.