REST Resource: players

资源：玩家

播放器资源。

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。只有在请求玩家的 player.get 调用之后玩家 ID 发生更改时，并且仅针对支持重新映射玩家 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

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