REST Resource: players

Recurso: player

Um recurso de jogador.

Representação 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
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#player
playerId

string

O ID do jogador.
displayName

string

O nome a ser exibido para o jogador.
avatarImageUrl

string

O URL base da imagem que representa o player.
bannerUrlPortrait

string

O URL da imagem do banner do player no modo retrato.
bannerUrlLandscape

string

O URL da imagem do banner do player no modo paisagem.
originalPlayerId

string

O ID do jogador usado na primeira vez que ele fez login no jogo em questão. Esse campo só é preenchido para chamadas de player.get para o jogador solicitante, somente se o ID do jogador tiver mudado posteriormente e apenas para clientes que oferecem suporte ao remapeamento de IDs de jogadores.
profileSettings

object (ProfileSettings)

As configurações do perfil do jogador. Controla se o perfil do jogador fica visível para outros jogadores.
name

object

Uma representação de objeto dos componentes individuais do nome do jogador. Para alguns players, esses campos podem não estar presentes.
name.familyName

string

O sobrenome do jogador. Em alguns lugares, isso é conhecido como sobrenome.
name.givenName

string

O nome próprio do jogador. Em alguns lugares, isso é conhecido como nome.
experienceInfo

object (PlayerExperienceInfo)

Um objeto que representa as informações da experiência do jogo para o jogador.
title

string

O título do jogador recompensado pelas atividades no jogo.
friendStatus

enum (FriendStatus)

O status de amigo do jogador em relação ao solicitante. Isso não será definido se o jogador não estiver compartilhando a lista de amigos com o jogo.
gamePlayerId

string

Identificador de jogador exclusivo por aplicativo.

ProfileSettings

Configurações do perfil

Representação JSON 
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#profileSettings.
profileVisible

boolean

Indica se o perfil do jogador está visível para o jogador conectado no momento.
friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

Indica se a lista de amigos do jogador está visível para o jogo ou pode ser solicitada. Esse campo só é preenchido para o jogador conectado no momento.

Enumerações
VISIBLE No momento, a lista de amigos está visível para o jogo.
REQUEST_REQUIRED O desenvolvedor não tem acesso à lista de amigos, mas pode chamar a API do Android para mostrar uma caixa de diálogo de consentimento.
UNAVAILABLE A lista de amigos não está disponível para esse usuário, e não é possível solicitar acesso no momento, porque o usuário recusou a solicitação permanentemente ou o recurso de amigos não está disponível para ele. Nesse estado, todas as tentativas de solicitar acesso à lista de amigos vão falhar.

PlayerExperienceInfo

Metadados próprios/de terceiros sobre a experiência do jogador.

Representação JSON 
{
  "kind": string,
  "currentExperiencePoints": string,
  "lastLevelUpTimestampMillis": string,
  "currentLevel": {
    object (PlayerLevel)
  },
  "nextLevel": {
    object (PlayerLevel)
  }
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#playerExperienceInfo.
currentExperiencePoints

string (int64 format)

O número atual de pontos de experiência do jogador.
lastLevelUpTimestampMillis

string (int64 format)

O carimbo de data/hora em que o jogador subiu de nível, em milissegundos desde a época Unix UTC.
currentLevel

object (PlayerLevel)

O nível atual do jogador.
nextLevel

object (PlayerLevel)

O próximo nível do jogador. Se o nível atual for o máximo, ele será igual ao nível atual.

PlayerLevel

Metadados próprios/de terceiros sobre o nível de um usuário.

Representação JSON 
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#playerLevel.
level

integer

O nível do usuário.
minExperiencePoints

string (int64 format)

Os pontos de experiência mínimos para esse nível.
maxExperiencePoints

string (int64 format)

Os pontos de experiência máximos para esse nível.

FriendStatus

Define relações de amizade entre jogadores.

Enumerações
NO_RELATIONSHIP Não há relação entre os jogadores.
FRIEND O jogador e o solicitante são amigos.

Métodos

get

 Recupera o recurso de jogador com o ID fornecido.

getMultipleApplicationPlayerIds

 Receba os IDs de jogadores do aplicativo para o jogador autenticado em todos os jogos solicitados pelo mesmo desenvolvedor do aplicativo de chamada.

getScopedPlayerIds

 Recupera identificadores de jogadores com escopo para o usuário autenticado.

list

 Receba a coleção de jogadores do usuário autenticado.