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

プレーヤーを表す画像のベース 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 ゲームのエクスペリエンス情報を表すオブジェクト。
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

プレーヤーのエクスペリエンスに関する 1P/3P メタデータ。

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

ユーザーのレベルに関する 1P/3P メタデータ。

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 プレーヤーとリクエスト送信者は友だちです。

Methods

get

 指定された ID のプレーヤー リソースを取得します。

getMultipleApplicationPlayerIds

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

getScopedPlayerIds

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

list

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