REST Resource: players

リソース: Player

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

プレーヤーを表す画像のベース URL。
bannerUrlPortrait

string

縦向きプレーヤーのバナー画像の URL。
bannerUrlLandscape

string

横表示のプレーヤー バナー画像の URL。
originalPlayerId

string

該当のゲームに初めてログインしたときに使用されたプレーヤー ID。これは、リクエスト元のプレーヤーの player.get 呼び出しで、プレーヤー ID がその後変更された場合にのみ、プレーヤー ID の再マッピングをサポートするクライアントに対してのみ入力されます。
profileSettings

object (ProfileSettings)

プレーヤーのプロフィール設定。プレーヤーのプロフィールを他のプレーヤーに公開するかどうかを制御します。
name

object

プレーヤーの名前の個々のコンポーネントを表すオブジェクト。一部のプレーヤーには、これらのフィールドが表示されない場合があります。
name.familyName

string

このプレーヤーの姓。地域によっては、姓とも呼ばれます。
name.givenName

string

このプレーヤーの氏名。地域によっては、これを「ファーストネーム」と呼ぶこともあります。
experienceInfo

object (PlayerExperienceInfo)

プレーヤーの Play Games エクスペリエンス情報を表すオブジェクト。
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 の Player リソースを取得します。

getMultipleApplicationPlayerIds

 呼び出し元のアプリと同じデベロッパーがリクエストしたすべてのゲームで、現在認証されているプレーヤーのアプリ プレーヤー ID を取得します。

getScopedPlayerIds

 現在認証されているユーザーのスコープ設定されたプレーヤー ID を取得します。

list

 現在認証されているユーザーのプレーヤーのコレクションを取得します。