Google Play Games Services API

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

שירות: games.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה צריכה להשתמש בספריות משלה כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כשמבצעים את בקשות ה-API.

מסמך Discovery

Discovery Document הוא מפרט שניתן לקריאה על ידי מכונה, שמתאר ממשקי API ל-REST ומשמש לצריכתם. היא משמשת לבניית ספריות לקוח, תוספים ל-IDE וכלים אחרים שמתקשרים עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך Discovery הבא:

נקודת קצה של שירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. יכול להיות שלשירות אחד יהיו כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה שירות משלו, וכל כתובות ה-URI שבהמשך הן יחסיות לנקודת קצה השירות הזו:

  • https://games.googleapis.com

משאב REST: ‏ accesstokens

שיטות
generatePlayGroupingApiToken ‫POST /games/v1/accesstokens/generatePlayGroupingApiToken
יוצר טוקן של Play Grouping API למשתמש PGS שמזוהה על ידי פרטי הכניסה המצורפים.
generateRecallPlayGroupingApiToken POST /games/v1/accesstokens/generateRecallPlayGroupingApiToken
יוצר טוקן של Play Grouping API למשתמש PGS שמזוהה על ידי מזהה סשן הזיכרון שסופק בבקשה.

משאב REST: ‏ achievementDefinitions

שיטות
list GET /games/v1/achievements
רשימה של כל הגדרות ההישגים באפליקציה.

משאב REST: achievements

שיטות
increment ‫POST /games/v1/achievements/{achievementId}/increment
מגדיל את מספר השלבים להשגת ההישג עם המזהה הנתון עבור השחקן שאומת כרגע.
list GET /games/v1/players/{playerId}/achievements
רשימת ההתקדמות של כל ההישגים באפליקציה עבור השחקן המאומת הנוכחי.
reveal ‫POST /games/v1/achievements/{achievementId}/reveal
מגדיר את המצב של ההישג עם המזהה הנתון לערך REVEALED עבור השחקן המאומת הנוכחי.
setStepsAtLeast POST /games/v1/achievements/{achievementId}/setStepsAtLeast
מגדיר את הצעדים של השחקן המאומת הנוכחי לקראת השגת מטרה במשחק.
unlock POST /games/v1/achievements/{achievementId}/unlock
הפונקציה הזו מאפשרת לשחקן המאומת הנוכחי להשיג את המטרה במשחק.
updateMultiple POST /games/v1/achievements/updateMultiple
מעדכן כמה הישגים לשחקן המאומת הנוכחי.

משאב REST: ‏ applications

שיטות
get GET /games/v1/applications/{applicationId}
אחזור המטא-נתונים של האפליקציה עם המזהה שצוין.
getEndPoint POST /games/v1/applications/getEndPoint
מחזירה כתובת URL לסוג נקודת היעד המבוקש.
played POST /games/v1/applications/played
מציין שהמשתמש המאומת הנוכחי משחק באפליקציה שלכם.
verify GET /games/v1/applications/{applicationId}/verify
הפונקציה מאמתת שטוקן ההרשאה שסופק עם הבקשה הזו הוא של האפליקציה עם המזהה שצוין, ומחזירה את המזהה של נגן הווידאו שהטוקן הוענק לו.

משאב REST: ‏ events

שיטות
listByPlayer GET /games/v1/events
מחזירה רשימה שבה מוצג ההתקדמות הנוכחית באירועים באפליקציה הזו עבור המשתמש המאומת הנוכחי.
listDefinitions GET /games/v1/eventDefinitions
מחזירה רשימה של הגדרות האירועים באפליקציה הזו.
record POST /games/v1/events
מתעד קבוצה של שינויים במספר הפעמים שהתרחשו אירועים עבור המשתמש המאומת הנוכחי של האפליקציה הזו.

משאב REST: ‏ leaderboards

שיטות
get GET /games/v1/leaderboards/{leaderboardId}
מאחזר את המטא-נתונים של טבלת המובילים עם המזהה שצוין.
list GET /games/v1/leaderboards
רשימת כל המטא-נתונים של טבלת המובילים של האפליקציה.

משאב REST: ‏ metagame

שיטות
getMetagameConfig GET /games/v1/metagameConfig
מחזירה את נתוני ההגדרה של המשחק המטא עבור האפליקציה שקוראת לפונקציה.
listCategoriesByPlayer GET /games/v1/players/{playerId}/categories/{collection}
רשימת נתוני משחק מצטברים לפי קטגוריה עבור השחקן שמתאים ל-playerId.

משאב REST: ‏ playerGameEvents

שיטות
batchRecordEvents POST /games/v1/players/{playerId}/gameEvents:batchRecordEvents
הקלטת קבוצה של אירועים במשחק של שחקן מסוים.

משאב REST: players

שיטות
get GET /games/v1/players/{playerId}
מאחזר את משאב הנגן עם המזהה שצוין.
getMultipleApplicationPlayerIds GET /games/v1/players/me/multipleApplicationPlayerIds
קבלת מזהי השחקנים באפליקציה עבור השחקן המאומת הנוכחי בכל המשחקים המבוקשים של אותו מפתח כמו האפליקציה שקוראת לפונקציה.
getScopedPlayerIds GET /games/v1/players/me/scopedIds
מאחזרת מזהי שחקנים בהיקף מסוים עבור המשתמש המאומת הנוכחי.
list GET /games/v1/players/me/players/{collection}
קבלת אוסף השחקנים של המשתמש המאומת הנוכחי.

משאב REST: ‏ recall

שיטות
gamesPlayerTokens GET /games/v1/recall/gamesPlayerTokens/{sessionId}
אחזור טוקנים של Recall מכל המשחקים המבוקשים שמשויכים לשחקן PGS שקודד במזהה סשן ה-Recall שסופק.
lastTokenFromAllDeveloperGames GET /games/v1/recall/developerGamesLastPlayerToken/{sessionId}
שליפת טוקן הזיכרון האחרון מכל המשחקים של המפתח שמשויך לשחקן PGS שמקודד במזהה סשן הזיכרון שסופק.
linkPersona POST /games/v1/recall:linkPersona
משייכים את החשבון הראשי של השחקן ב-PGS, שמוצפן במזהה סשן הזיכרון שסופק, לחשבון במשחק
resetPersona POST /games/v1/recall:resetPersona
מחיקה של כל הטוקנים של Recall שמקשרים את הדמות הנתונה לכל שחקן (עם או בלי פרופיל).
retrieveTokens GET /games/v1/recall/tokens/{sessionId}
אחזור כל טוקני הזיכרון שמשויכים לשחקן PGS שקודד במזהה סשן הזיכרון שסופק.
unlinkPersona ‫POST /games/v1/recall:unlinkPersona
מחיקת טוקן זיכרון שמקשר בין הישות המורשית של שחקן PGS שמזוהה על ידי סשן Recall לבין חשבון במשחק שמזוהה על ידי 'הפרסונה' או על ידי ערך הטוקן.

משאב REST: ‏ revisions

שיטות
check GET /games/v1/revisions/check
בודקת אם לקוח המשחקים לא עדכני.

משאב REST: ‏ scores

שיטות
get GET /games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}
קבלת תוצאות גבוהות, ודירוגים אופציונליים, בלידרבורדים של השחקן המאומת הנוכחי.
list GET /games/v1/leaderboards/{leaderboardId}/scores/{collection}
מציג את התוצאות בטבלת הישגים, החל מהתוצאה הגבוהה ביותר.
listWindow GET /games/v1/leaderboards/{leaderboardId}/window/{collection}
מציג את הניקוד בטבלת מובילים סביב הניקוד של השחקן (כולל הניקוד שלו).
submit POST /games/v1/leaderboards/{leaderboardId}/scores
שולחת ציון לטבלת המובילים שצוינה.
submitMultiple POST /games/v1/leaderboards/scores
שליחת כמה תוצאות ללוחות לידרבורד.

משאב REST: ‏ snapshots

שיטות
get GET /games/v1/snapshots/{snapshotId}
אחזור המטא-נתונים של מזהה נתון של תמונת מצב.
list GET /games/v1/players/{playerId}/snapshots
מאחזר רשימה של תמונות מצב שנוצרו על ידי האפליקציה שלכם עבור הנגן שתואם למזהה הנגן.

משאב REST: ‏ stats

שיטות
get GET /games/v1/stats
מחזירה נתונים סטטיסטיים לגבי מעורבות והוצאות באפליקציה הזו עבור המשתמש המאומת הנוכחי.