REST 资源:玩家

资源:玩家

玩家资源。

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

字符串

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

playerId

字符串

玩家的 ID。

displayName

字符串

要显示的玩家姓名。

avatarImageUrl

字符串

代表玩家的图片的基本 URL。

bannerUrlPortrait

字符串

玩家横幅图像的纵向模式 URL。

bannerUrlLandscape

字符串

玩家横幅图像的横向模式 URL。

originalPlayerId

字符串

该玩家第一次登录相关游戏时使用的玩家 ID。此字段仅在针对请求玩家调用 player.get 时填充,仅当玩家 ID 随后更改时才会填充,并且仅对支持重新映射玩家 ID 的客户端填充。

profileSettings

对象 (ProfileSettings)

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

name

对象

玩家姓名各个组成部分的对象表示。对于某些玩家,这些字段可能不存在。

name.familyName

字符串

此玩家的姓氏。在某些地方,这被称为姓。

name.givenName

字符串

此玩家的给定名称。在某些地方,这被称为名。

experienceInfo

对象 (PlayerExperienceInfo)

代表玩家的游戏体验信息的的对象。

title

字符串

玩家因其游戏活动而获得的称号。

friendStatus

枚举 (FriendStatus)

相对于请求者的给定玩家的好友状态。如果玩家没有与游戏共享其好友列表,则此设置未设置。

gamePlayerId

字符串

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

ProfileSettings

个人资料设置

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

字符串

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

profileVisible

布尔值

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

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

字符串

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

currentExperiencePoints

字符串 (int64 格式)

玩家当前的经验点数。

lastLevelUpTimestampMillis

字符串 (int64 格式)

玩家升级的时间戳,自 Unix 纪元 UTC 以来以毫秒为单位。

currentLevel

对象 (PlayerLevel)

玩家的当前等级。

nextLevel

对象 (PlayerLevel)

玩家的下一等级。如果当前等级是最高等级,则应与当前等级相同。

PlayerLevel

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

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

字符串

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

等级

整数

用户的等级。

最低经验值

字符串 (int64 格式)

此等级的最低经验值。

最高经验值

字符串 (int64 格式)

此等级的最高经验值。

FriendStatus

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

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

方法

get

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

getMultipleApplicationPlayerIds

获取当前已认证玩家在调用应用程序相同开发者所有请求游戏中所有应用程序玩家 ID。

getScopedPlayerIds

检索当前已认证用户的范围玩家标识符。

list

获取当前已认证用户的玩家集合。