Method: scores.get

קבל ניקוד גבוה, ובאופן אופציונלי דרגות, בלוחות לידרבורד עבור השחקן המאומת הנוכחי. עבור פרק זמן ספציפי, אפשר להגדיר את leaderboardId לערך ALL כדי לאחזר נתונים עבור כל לוחות הלידרבורד בפרק זמן נתון. 'הערה: לא ניתן לבקש לוחות Leaderboard מסוג 'ALL' ו-'ALL' timeSpan באותה בקשה. ניתן להגדיר רק פרמטר אחד כ-'ALL'.

בקשת HTTP

GET https://games.googleapis.com/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}

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

פרמטרים
playerId

string

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

string

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

enum (ScoreTimeSpan)

טווח הזמן עבור הציונים והדירוגים שביקשת.

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

פרמטרים
language

string

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

enum (IncludeRankType)

סוגי הדרגות שצריך להחזיר. אם הפרמטר יושמט, לא יוחזרו דירוגים.
maxResults

integer

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

string

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

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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

ScoreTimeSpan

הגדרת טווחי הזמן האפשריים לניקוד.

טיפוסים בני מנייה (enums)
ALL קבלת התוצאות הגבוהות בכל הזמנים. במקרה כזה, המערכת תתעלם מערכי maxResults.
ALL_TIME אפשר להשיג את התוצאה הגבוהה ביותר בכל הזמנים.
WEEKLY רשימה של התוצאות המובילות ליום הנוכחי.
DAILY רשימה של התוצאות המובילות לשבוע הנוכחי.

IncludeRankType

ערכים אפשריים לסוג הדירוג.

טיפוסים בני מנייה (enums)
ALL אחזור כל הדירוגים הנתמכים. ב-HTTP, אפשר לציין את ערך הפרמטר הזה גם כ-ALL.
PUBLIC אחזור דירוגים ציבוריים, אם השחקן משתף את פעילות הגיימפליי שלו באופן ציבורי.
SOCIAL

(מיושן) אחזור הדרגה החברתית.
FRIENDS מאחזרים את הדירוג באוסף החברים.