REST Resource: players

משאב: נגן

משאב נגן.

ייצוג 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

כתובת ה-URL לתמונת הבאנר של הנגן בפריסה לאורך.
bannerUrlLandscape

string

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

string

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

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

טיפוסים בני מנייה (enum)
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 epoch) לפי שעון UTC.
currentLevel

object (PlayerLevel)

הרמה הנוכחית של הנגן.
nextLevel

object (PlayerLevel)

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

PlayerLevel

מטא-נתונים מאינטראקציה ישירה (First-Party) לגבי רמת המשתמש.

ייצוג JSON 
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
שדות
kind

string

מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה games#playerLevel.
level

integer

הרמה שבה נמצא המשתמש.
minExperiencePoints

string (int64 format)

נקודות הניסיון המינימליות לרמה הזו.
maxExperiencePoints

string (int64 format)

מספר נקודות הניסיון המקסימלי לרמה הזו.

FriendStatus

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

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

שיטות

get

 מאחזר את משאב Player עם המזהה הנתון.

getMultipleApplicationPlayerIds

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

getScopedPlayerIds

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

list

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