Method: achievementDefinitions.list

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

בקשת HTTP

GET https://games.googleapis.com/games/v1/achievements

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

פרמטרים
language

string

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

integer

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

string

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

גוף הבקשה

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

גוף התגובה

רשימת אובייקטים של הגדרת הישג.

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

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

string

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

string

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

object (AchievementDefinition)

הגדרות ההישגים.

היקפי הרשאות

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

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

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

AchievementDefinition

אובייקט של הגדרת הישג.

ייצוג JSON 
{
  "kind": string,
  "id": string,
  "name": string,
  "description": string,
  "achievementType": enum (AchievementType),
  "totalSteps": integer,
  "formattedTotalSteps": string,
  "revealedIconUrl": string,
  "isRevealedIconUrlDefault": boolean,
  "unlockedIconUrl": string,
  "isUnlockedIconUrlDefault": boolean,
  "initialState": enum (InitialAchievementState),
  "experiencePoints": string
}
שדות
kind

string

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

string

מזהה ההישג.
name

string

שם ההישג.
description

string

תיאור ההישג.
achievementType

enum (AchievementType)

סוג ההישג.
totalSteps

integer

סך כל השלבים להישג מצטבר.
formattedTotalSteps

string

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

string

כתובת ה-URL של התמונה של סמל ההישג שנחשף.
isRevealedIconUrlDefault

boolean

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

string

כתובת ה-URL של התמונה של סמל ההישג שאינו נעול.
isUnlockedIconUrlDefault

boolean

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

enum (InitialAchievementState)

המצב הראשוני של ההישג.
experiencePoints

string (int64 format)

נקודות ניסיון שנצברות בביטול של ההישג הזה.

AchievementType

סוגי הישגים אפשריים.

טיפוסים בני מנייה (enums)
STANDARD ההישג נעול או לא נעול.
INCREMENTAL ההישג הוא מצטבר.

InitialAchievementState

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

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