REST Resource: players

Recurso: Jogador

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 player.

avatarImageUrl

string

O URL de 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 do jogador que foi usado na primeira vez que ele fez login no jogo em questão. Só é preenchido para chamadas para player.get para o player solicitante, somente se o ID do jogador tiver sido alterado posteriormente e somente para clientes que aceitam remapeamento de IDs de player.

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 jogadores, esses campos podem não estar presentes.

name.familyName

string

O sobrenome deste jogador. Em alguns lugares, é chamado de sobrenome.

name.givenName

string

O nome deste jogador. Em alguns lugares, é chamado de primeiro nome.

experienceInfo

object (PlayerExperienceInfo)

Um objeto que representa as informações de experiência do Play Games para o jogador.

title

string

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

friendStatus

enum (FriendStatus)

O status de amigo de um determinado jogador, em relação ao solicitante. Essa opção não é definida 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 desse recurso. O valor é sempre a string fixa games#profileSettings.

profileVisible

boolean

Se o perfil do jogador está visível para o jogador conectado no momento.

friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

Se a lista de amigos do jogador está visível para este jogo ou pode ser solicitada. Este 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 do Android para mostrar uma caixa de diálogo de consentimento.
UNAVAILABLE A lista de amigos não está disponível no momento para este usuário e não é possível solicitar acesso no momento, porque o usuário recusou permanentemente ou o recurso de amigos não está disponível para ele. Nesse caso, qualquer tentativa de solicitar acesso à lista de amigos não terá êxito.

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 do Unix em 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 deverá 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)

São 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

Receba 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 jogador com escopo para o usuário autenticado no momento.

list

Mostra o conjunto de players do usuário autenticado no momento.