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

מזהה הנגן.
displayName

string

השם שיוצג לנגן.
avatarImageUrl

string

כתובת ה-URL הבסיסית של התמונה שמייצגת את הנגן.
bannerUrlPortrait

string

כתובת האתר של תמונת הבאנר של הנגן במצב 'הדגשת דיוקן'.
bannerUrlLandscape

string

כתובת האתר של תמונת הבאנר של הנגן במצב פריסה לרוחב.
originalPlayerId

string

מזהה השחקן ששימש את השחקן הזה בפעם הראשונה שהוא נכנס למשחק הרלוונטי. השדה הזה יאוכלס רק בקריאות ל-player.get עבור הנגן שביקש אותו, רק אם מזהה הנגן השתנה בהמשך, ורק ללקוחות שתומכים במיפוי מחדש של מזהי הנגן.
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

האם רשימת החברים של השחקן גלויה למשחק הזה או שניתן לבקש. השדה הזה מאוכלס רק עבור השחקן שמחובר כרגע.

טיפוסים בני מנייה (enums)
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

מגדיר את יחסי החברות בין השחקנים.

טיפוסים בני מנייה (enums)
NO_RELATIONSHIP אין קשר בין השחקנים.
FRIEND השחקן ומגיש הבקשה הם חברים.

שיטות

get

 שולפת את משאב הנגן עם המזהה הנתון.

getMultipleApplicationPlayerIds

 קבל את מזהי נגן האפליקציה של השחקן המאומת הנוכחי בכל המשחקים המבוקשים על ידי אותו מפתח כמו אפליקציית הקריאה.

getScopedPlayerIds

 אחזור של מזהי שחקנים בהיקף ההרשאות של המשתמש המאומת הנוכחי.

list

 קבלת אוסף הנגנים עבור המשתמש המאומת הנוכחי.