REST Resource: players

Recurso: Player

Um recurso do Player.

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 deste recurso. O valor é sempre a string fixa games#player

playerId

string

O ID do jogador.

displayName

string

O nome a ser exibido para o player.

avatarImageUrl

string

É o URL base da imagem que representa o player.

bannerUrlPortrait

string

O URL para a imagem do banner do player no modo retrato.

bannerUrlLandscape

string

O URL para a imagem do banner do player no modo paisagem.

originalPlayerId

string

O ID usado para esse jogador na primeira vez que ele fez login no jogo em questão. Só é preenchido em chamadas de player.get para o jogador solicitante, apenas se o ID do jogador for alterado posteriormente e somente para clientes compatíveis com o remapeamento de IDs de jogador.

profileSettings

object (ProfileSettings)

As configurações de perfil do jogador. Controla se o perfil de um jogador vai aparecer ou não para outros jogadores.

name

object

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

name.familyName

string

O sobrenome do jogador. Em alguns lugares, ele é conhecido como sobrenome.

name.givenName

string

O nome deste jogador. Em alguns lugares, ele é conhecido como o primeiro nome.

experienceInfo

object (PlayerExperienceInfo)

Um objeto para representar as informações da experiência do Play Game para o jogador.

title

string

O título do jogador é recompensado por suas atividades no jogo.

friendStatus

enum (FriendStatus)

O status de amigo do jogador em relação ao solicitante. Essa opção será deixada sem definição se o jogador não estiver compartilhando a lista de amigos com o jogo.

gamePlayerId

string

Identificador exclusivo de jogador por aplicativo.

ProfileSettings

Configurações do perfil

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

string

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

profileVisible

boolean

Indica se o perfil do jogador está visível para o jogador que fez login.

friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

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

Enums
VISIBLE A lista de amigos está visível para o jogo no momento.
REQUEST_REQUIRED O desenvolvedor não tem acesso à lista de amigos, mas pode chamar a API Android para mostrar uma caixa de diálogo de consentimento.
UNAVAILABLE A lista de amigos não está disponível para este usuário e, no momento, não é possível solicitar acesso, seja porque o usuário recusou permanentemente ou porque o recurso de amigos não está disponível para ele. Nesse estado, qualquer tentativa de solicitar acesso à lista de amigos não terá sucesso.

PlayerExperienceInfo

Metadados próprios ou 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 deste 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 o UTC da época Unix.

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 terá que ser igual ao atual.

PlayerLevel

Metadados próprios ou de terceiros sobre o nível do usuário.

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

string

Identifica exclusivamente o tipo deste 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 este nível.

maxExperiencePoints

string (int64 format)

O número máximo de pontos de experiência para este nível.

FriendStatus

Define as relações de amizade entre os jogadores.

Enums
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 Player com o ID fornecido.

getMultipleApplicationPlayerIds

Recebe os IDs de jogador do aplicativo para o jogador autenticado no momento em todos os jogos solicitados pelo mesmo desenvolvedor do aplicativo de chamada.

getScopedPlayerIds

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

list

Recebe a coleção de jogadores do usuário autenticado no momento.