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

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

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

InitialAchievementState

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

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