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。

プロファイル設定

プロフィール設定

JSON 表現 
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
フィールド
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#profileSettings です。
profileVisible

boolean

現在ログインしているプレーヤーにプレーヤーのプロフィールが表示されるかどうか。
friendsListVisibility

enum (FriendsListVisibility)

友達リストの公開設定

プレーヤーのフレンドリストをこのゲームから閲覧可能にするか、リクエスト可能か。このフィールドは、現在ログインしているプレーヤーについてのみ入力されます。

列挙型
VISIBLE フレンドリストは現在ゲームに表示されています。
REQUEST_REQUIRED 開発者は友だちリストにアクセスできませんが、Android API を呼び出して同意ダイアログを表示できます。
UNAVAILABLE このユーザーは友だちリストを利用できません。ユーザーが完全に辞退したか、友だち機能が利用できないため、現在、アクセスをリクエストすることはできません。この状態では、フレンドリストへのアクセスをリクエストしようとしても失敗します。

プレーヤー エクスペリエンス情報

プレーヤーのエクスペリエンスに関するファースト パーティ/サードパーティ メタデータ。

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)

プレーヤーの次のレベル。現在のレベルが最大レベルである場合、これは現在のレベルと同じである必要があります。

プレーヤー レベル

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

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

Methods

get

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

getMultipleApplicationPlayerIds

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

getScopedPlayerIds

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

list

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