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

アプリごとの一意のプレーヤー 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

プレーヤーのエクスペリエンスに関する 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

ユーザーのレベルに関するファースト パーティ/サードパーティのメタデータ。

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

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