Method: achievements.list

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

בקשת HTTP

GET https://games.googleapis.com/games/v1/players/{playerId}/achievements

פרמטרים של נתיב

פרמטרים
playerId

string

מזהה נגן. ניתן להשתמש בערך של me במקום המזהה של הנגן המאומת.

פרמטרים של שאילתה

פרמטרים
language

string

השפה המועדפת לשימוש למחרוזות שמוחזרות בשיטה הזו.

maxResults

integer

המספר המקסימלי של משאבי הישגים שצריך להחזיר בתשובה, המשמש לחלוקה לדפים. בכל תגובה, המספר של משאבי ההישגים שמוחזרים בפועל עשוי להיות קטן מהערך שצוין ב-maxResults.

pageToken

string

האסימון שהוחזר בעקבות הבקשה הקודמת.

state

enum (State)

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

רשימה של הישגים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (PlayerAchievement)
    }
  ]
}
שדות
kind

string

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

nextPageToken

string

אסימון שתואם לדף התוצאות הבא.

items[]

object (PlayerAchievement)

ההישגים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

מדינה

טיפוסים בני מנייה (enum)
ALL הצגת רשימה של כל ההישגים. (זוהי ברירת המחדל)
HIDDEN הצגת רשימה של הישגים מוסתרים בלבד.
REVEALED הצגת רשימה של רק הישגים שנחשפו.
UNLOCKED הצגת רשימה רק של הישגים שלא נעולים.

PlayerAchievement

אובייקט של הישג.

ייצוג JSON
{
  "kind": string,
  "id": string,
  "currentSteps": integer,
  "formattedCurrentStepsString": string,
  "achievementState": enum (State),
  "lastUpdatedTimestamp": string,
  "experiencePoints": string
}
שדות
kind

string

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

id

string

מזהה ההישג.

currentSteps

integer

השלבים הנוכחיים להישג מצטבר.

formattedCurrentStepsString

string

השלבים הנוכחיים להישג מצטבר כמחרוזת.

achievementState

enum (State)

מצב ההישג.

lastUpdatedTimestamp

string (int64 format)

חותמת הזמן של השינוי האחרון במצב של ההישג הזה.

experiencePoints

string (int64 format)

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

מדינה

מגדיר מצבים אפשריים של הישג.

טיפוסים בני מנייה (enum)
HIDDEN ההישג מוסתר.
REVEALED ההישג ייחשף.
UNLOCKED ההישג בוטלה.