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 的用戶端，才會填入向提出請求的玩家.get 呼叫。
profileSettings

object (ProfileSettings)

玩家的個人資料設定。控制是否向其他玩家顯示玩家的個人資料。
name

object

代表玩家名稱個別元件的物件。部分播放器可能不會顯示這些欄位。
name.familyName

string

此玩家的姓氏。在某些地方，這是所謂的姓氏。
name.givenName

string

此玩家的名字。在某些地方，這就是所謂的名字。
experienceInfo

object (PlayerExperienceInfo)

代表玩家 Play 遊戲體驗資訊的物件。
title

string

玩家的遊戲活動獎勵。
friendStatus

enum (FriendStatus)

指定玩家的好友狀態 (相對於要求者)。如果玩家未與遊戲分享好友名單，這項設定就不會設定。
gamePlayerId

string

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

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 紀元 (世界標準時間) 開始計算。
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

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

list

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