REST 资源：players

资源：Player

Player 资源。

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

玩家的 ID。
displayName

string

用于显示玩家名称的名称。
avatarImageUrl

string

表示玩家图片的基准 URL。
bannerUrlPortrait

string

指向玩家竖屏模式横幅图片的 URL。
bannerUrlLandscape

string

指向玩家横屏模式横幅图片的 URL。
originalPlayerId

string

此玩家首次登录游戏时使用的玩家 ID。仅在对请求玩家调用 player.get 时填充此字段（前提是玩家 ID 后续发生了变化），且仅适用于支持重新映射玩家 ID 的客户端。
profileSettings

对象 (ProfileSettings)

玩家的资料设置。控制玩家的资料是否对其他玩家可见。
name

对象

玩家名称各个组成部分的对象表示形式。对于某些玩家，这些字段可能不存在。
name.familyName

string

此玩家的姓氏。在某些地区，这称为“姓”。
name.givenName

string

此玩家的名字。在某些地区，这称为“名”。
experienceInfo

对象 (PlayerExperienceInfo)

一个对象，用于表示玩家的 Play 游戏体验信息。
title

string

玩家因游戏活动获得的头衔。
friendStatus

枚举 (FriendStatus)

给定玩家相对于请求者的好友状态。如果玩家未与游戏分享其好友列表，则此字段不设值。
gamePlayerId

string

每个应用的唯一玩家标识符。

ProfileSettings

资料设置

JSON 表示法 
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
字段
kind

string

此资源类型的唯一标识符。值始终为固定字符串 games#profileSettings。
profileVisible

boolean

玩家的资料是否对当前登录的玩家可见。
friendsListVisibility

枚举 (FriendsListVisibility)

FriendsListVisibility

玩家的好友列表对此游戏是否可见或是否可以请求。此字段仅为当前登录的玩家填充。

枚举
VISIBLE 好友列表当前对此游戏可见。
REQUEST_REQUIRED 开发者无权访问好友列表，但可以调用 Android API 显示同意对话框。
UNAVAILABLE 好友列表当前对此用户不可用，并且此时无法请求访问，原因可能是用户已永久拒绝或好友功能对此用户不可用。在此状态下，任何请求访问好友列表的尝试都将失败。

PlayerExperienceInfo

关于玩家体验的 1P/3P 元数据。

JSON 表示法 
{
  "kind": string,
  "currentExperiencePoints": string,
  "lastLevelUpTimestampMillis": string,
  "currentLevel": {
    object (PlayerLevel)
  },
  "nextLevel": {
    object (PlayerLevel)
  }
}
字段
kind

string

此资源类型的唯一标识符。值始终为固定字符串 games#playerExperienceInfo。
currentExperiencePoints

字符串 (int64 格式)

玩家当前经验值数量。
lastLevelUpTimestampMillis

字符串 (int64 格式)

玩家升级的时间戳，以自 Unix epoch UTC 以来的毫秒数表示。
currentLevel

对象 (PlayerLevel)

玩家当前等级。
nextLevel

对象 (PlayerLevel)

玩家下一等级。如果当前等级是最高等级，则此字段应与当前等级相同。

PlayerLevel

关于用户等级的 1P/3P 元数据。

JSON 表示法 
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
字段
kind

string

此资源类型的唯一标识符。值始终为固定字符串 games#playerLevel。
level

整数

用户的等级。
minExperiencePoints

字符串 (int64 格式)

此等级的最低经验值。
maxExperiencePoints

字符串 (int64 格式)

此等级的最高经验值。

FriendStatus

定义玩家之间的好友关系。

枚举
NO_RELATIONSHIP 玩家之间没有关系。
FRIEND 玩家和请求者是好友。

方法

get

 检索给定 ID 的 Player 资源。

getMultipleApplicationPlayerIds

 获取当前已通过身份验证的玩家在与调用应用属于同一开发者的所有请求的游戏中的应用玩家 ID。

getScopedPlayerIds

 检索当前已通过身份验证的用户的作用域玩家标识符。

list

 获取当前已通过身份验证的用户的玩家集合。