REST Resource: players

Ressource: Lecteur

Une ressource "Player".

Représentation 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
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#player

playerId

string

Identifiant du joueur.

displayName

string

Nom à afficher pour le lecteur.

avatarImageUrl

string

URL de base de l'image représentant le joueur.

bannerUrlPortrait

string

URL de l'image de la bannière du lecteur en mode Portrait.

bannerUrlLandscape

string

URL de l'image de la bannière du lecteur en mode Paysage.

originalPlayerId

string

L'identifiant de joueur utilisé lors de sa première connexion au jeu en question. Ce champ n'est renseigné que pour les appels à player.get pour le joueur demandeur, uniquement si l'ID de joueur a été modifié par la suite, et uniquement pour les clients qui prennent en charge le remappage des ID de joueur.

profileSettings

object (ProfileSettings)

Paramètres du profil du joueur Détermine si le profil du joueur est visible ou non par les autres joueurs.

name

object

Représentation d'objet des différents composants du nom du joueur. Pour certains joueurs, ces champs ne sont pas disponibles.

name.familyName

string

Nom de famille de ce joueur. Dans certains endroits, il s'agit du nom de famille.

name.givenName

string

Nom donné à ce joueur. Dans certains endroits, on l'appelle le prénom.

experienceInfo

object (PlayerExperienceInfo)

Objet représentant les informations relatives à l'expérience de jeu Play pour le joueur.

title

string

Titre du joueur récompensé pour ses activités de jeu.

friendStatus

enum (FriendStatus)

Statut d'ami du joueur donné, par rapport au demandeur. Cette option n'est pas définie si le joueur ne partage pas sa liste d'amis avec le jeu.

gamePlayerId

string

Identifiant de joueur unique par application.

ProfileSettings

Paramètres du profil

Représentation JSON
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#profileSettings.

profileVisible

boolean

Indique si le profil du joueur est visible par le joueur actuellement connecté.

friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

Indique si la liste d'amis du joueur est visible pour ce jeu ou peut être demandée. Ce champ n'est renseigné que pour le joueur actuellement connecté.

Enums
VISIBLE La liste d'amis est actuellement visible pour le jeu.
REQUEST_REQUIRED Le développeur n'a pas accès à la liste d'amis, mais peut appeler l'API Android pour afficher une boîte de dialogue de recueil du consentement.
UNAVAILABLE Cet utilisateur ne peut pas consulter la liste d'amis pour le moment. Il ne peut pas demander l'accès à sa liste d'amis pour le moment, soit parce que l'utilisateur a refusé l'invitation de façon permanente, soit parce qu'il n'a pas accès à la fonctionnalité Amis. Dans cet état, toute tentative de demande d'accès à la liste d'amis échouera.

PlayerExperienceInfo

Métadonnées propriétaires/tierces sur l'expérience du joueur.

Représentation JSON
{
  "kind": string,
  "currentExperiencePoints": string,
  "lastLevelUpTimestampMillis": string,
  "currentLevel": {
    object (PlayerLevel)
  },
  "nextLevel": {
    object (PlayerLevel)
  }
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#playerExperienceInfo.

currentExperiencePoints

string (int64 format)

Nombre actuel de points d'expérience pour le joueur.

lastLevelUpTimestampMillis

string (int64 format)

Code temporel du passage au niveau supérieur du joueur, exprimé en millisecondes depuis l'epoch Unix (UTC).

currentLevel

object (PlayerLevel)

Niveau actuel du joueur.

nextLevel

object (PlayerLevel)

Niveau suivant du joueur Si le niveau actuel est le niveau maximal, il doit être identique au niveau actuel.

PlayerLevel

Métadonnées propriétaires/tierces sur le niveau d'un utilisateur.

Représentation JSON
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#playerLevel.

level

integer

Niveau de l'utilisateur.

minExperiencePoints

string (int64 format)

Nombre minimal de points d'expérience pour ce niveau.

maxExperiencePoints

string (int64 format)

Nombre maximal de points d'expérience pour ce niveau.

FriendStatus

Définit les relations d'amitié entre les joueurs.

Enums
NO_RELATIONSHIP Il n'y a pas de relation entre les joueurs.
FRIEND Le joueur et le demandeur sont amis.

Méthodes

get

Récupère la ressource "Player" avec l'ID donné.

getMultipleApplicationPlayerIds

Obtenez les ID de joueur de l'application pour le joueur actuellement authentifié dans tous les jeux demandés par le même développeur que l'application appelante.

getScopedPlayerIds

Récupère les identifiants des joueurs ciblés pour l'utilisateur actuellement authentifié.

list

Permet d'obtenir la collection de joueurs pour l'utilisateur actuellement authentifié.