REST Resource: 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

表示播放器的图片的基础网址。
bannerUrlPortrait

string

指向纵向模式播放器横幅图片的网址。
bannerUrlLandscape

string

横屏模式播放器横幅图片的网址。
originalPlayerId

string

该玩家首次登录相关游戏时使用的玩家 ID。只有在玩家 ID 随后发生了更改时，系统才会为发出请求的玩家调用 player.get，并且只有对于支持重新映射玩家 ID 的客户端，系统才会填充此字段。
profileSettings

object (ProfileSettings)

玩家的个人资料设置。控制能否向其他玩家显示该玩家的个人资料。
name

object

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

string

此播放器的姓氏。在某些地方，这个名字称为姓氏。
name.givenName

string

此播放器的名字。在某些地方，这个名字叫作名字。
experienceInfo

object (PlayerExperienceInfo)

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

string

玩家通过游戏活动获得的称号。
friendStatus

enum (FriendStatus)

指定玩家相对于请求者的好友状态。如果玩家未与游戏分享好友列表，则未设置此属性。
gamePlayerId

string

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

ProfileSettings

个人资料设置

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

string

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

boolean

当前登录的玩家是否可以看到该玩家的个人资料。
friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

是玩家的好友列表对此游戏可见，还是可以请求。系统只会为当前已登录的玩家填充此字段。

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

PlayerExperienceInfo

有关玩家体验的第一方/第三方元数据。

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

string

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

string (int64 format)

玩家当前的经验值。
lastLevelUpTimestampMillis

string (int64 format)

玩家升级时的时间戳，以从 Unix 新纪元 UTC 开始计算的毫秒数表示。
currentLevel

object (PlayerLevel)

玩家的当前等级。
nextLevel

object (PlayerLevel)

玩家进入下一关。如果当前级别为最高级别，则此级别应与当前级别相同。

PlayerLevel

关于用户级别的第一方/第三方元数据。

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

string

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

integer

用户的级别。
minExperiencePoints

string (int64 format)

此等级的最低经验值。
maxExperiencePoints

string (int64 format)

此关卡的经验值上限。

FriendStatus

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

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

方法

get

 检索具有指定 ID 的 Player 资源。

getMultipleApplicationPlayerIds

 获取与调用应用是同一开发者的所有游戏，获取当前已通过身份验证的玩家的应用玩家 ID。

getScopedPlayerIds

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

list

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