REST Resource: players

资源：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 随后发生更改且针对支持重新映射玩家 ID 的客户端时，为针对发出请求的玩家调用 player.get 才会填充此字段。
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 的播放器资源。

getMultipleApplicationPlayerIds

 由与调用应用相同的开发者在请求的所有游戏中获取当前经过身份验证的玩家的应用玩家 ID。

getScopedPlayerIds

 检索当前已经过身份验证的用户的限定范围的玩家标识符。

list

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