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

每個應用程式的專屬玩家 ID。

個人資料設定

個人資料設定

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

string

用於識別這項資源的類型的唯一識別碼。值一律為固定字串 games#profileSettings。
profileVisible

boolean

指出目前登入的玩家是否能看到玩家的個人資料。
friendsListVisibility

enum (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 Epoch 紀元時間世界標準時間起算，以毫秒為單位)。
currentLevel

object (PlayerLevel)

玩家目前的關卡。
nextLevel

object (PlayerLevel)

下一個玩家等級。如果目前的等級是最高等級，此等級應與目前等級相同。

玩家等級

使用者層級的第一方/第三方中繼資料。

JSON 表示法 
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
欄位
kind

string

用於識別這項資源的類型的唯一識別碼。值一律為固定字串 games#playerLevel。
level

integer

使用者的等級。
minExperiencePoints

string (int64 format)

這個等級的最低經驗值。
maxExperiencePoints

string (int64 format)

這個等級的最高體驗分數。

朋友狀態

定義玩家之間的友誼關係。

列舉
NO_RELATIONSHIP 玩家之間沒有任何關係。
FRIEND 玩家和要求者是好友。

方法

get

 擷取具有指定 ID 的 Player 資源。

getMultipleApplicationPlayerIds

 取得相同開發人員在所有要求遊戲中，目前驗證玩家的應用程式玩家 ID。

getScopedPlayerIds

 擷取目前驗證使用者的範圍玩家 ID。

list

 取得目前驗證使用者的玩家集合。