REST 资源: scores

资源: GetLeaderboardScoresResponse

玩家排行榜得分列表。

JSON 表示
{
  "kind": string,
  "nextPageToken": string,
  "player": {
    object (Player)
  },
  "items": [
    {
      object (LeaderboardScore)
    }
  ]
}
字段
kind

字符串

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

nextPageToken

字符串

用于获取下一页结果的分页令牌。

player

对象 (Player)

此得分拥有者的 Player 资源。

items[]

对象 (LeaderboardScore)

排行榜得分。

LeaderboardScore

一个玩家排行榜得分对象。

JSON 表示
{
  "kind": string,
  "leaderboard_id": string,
  "scoreValue": string,
  "scoreString": string,
  "publicRank": {
    object (LeaderboardScoreRank)
  },
  "socialRank": {
    object (LeaderboardScoreRank)
  },
  "friendsRank": {
    object (LeaderboardScoreRank)
  },
  "timeSpan": enum (ScoreTimeSpan),
  "writeTimestamp": string,
  "scoreTag": string
}
字段
kind

字符串

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

leaderboard_id

字符串

此得分所在的排行榜 ID。

scoreValue

字符串 (int64 格式)

此得分的数值。

scoreString

字符串

此得分的格式化值。

publicRank

对象 (LeaderboardScoreRank)

此得分在此排行榜中的公开排名。如果用户未公开分享其得分,则此对象将不存在。

socialRank

对象 (LeaderboardScoreRank)

此得分在此排行榜中的社交排名。

friendsRank

对象 (LeaderboardScoreRank)

此得分在此排行榜的朋友收藏夹中的排名。

timeSpan

枚举 (ScoreTimeSpan)

此得分的时间范围。

writeTimestamp

字符串 (int64 格式)

记录此得分的时间戳,以 UTC 时间、自 epoch 以来的毫秒为单位。

scoreTag

字符串

关于得分的额外信息。值必须包含不超过 64 个 URI 安全字符,如 RFC 3986 第 2.3 节中所定义。

LeaderboardScoreRank

排行榜中的得分排名。

JSON 表示
{
  "kind": string,
  "rank": string,
  "formattedRank": string,
  "numScores": string,
  "formattedNumScores": string
}
字段
kind

字符串

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

rank

字符串 (int64 格式)

在排行榜中的排名。

formattedRank

字符串

以字符串形式表示的排行榜排名。

numScores

字符串 (int64 格式)

排行榜中的得分数量。

formattedNumScores

字符串

以字符串形式表示的排行榜得分数量。

ScoreTimeSpan

定义得分的可能时间范围。

枚举
ALL_TIME 该得分为总计得分。
WEEKLY 该得分为周得分。
DAILY 该得分为日得分。

方法

get

获取当前已认证玩家在排行榜中的高得分,以及可选的排名。

list

列出排行榜中的得分,从最高分开始。

listWindow

列出排行榜中某个玩家得分附近(包括该得分)的得分。

submit

向指定的排行榜提交得分。

submitMultiple

向多个排行榜提交得分。