com.google.api.services.games

Class Games.Scores

java.lang.Object

com.google.api.services.games.Games.Scores

Enclosing class:

Games

public class Games.Scores
extends Object

The "scores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Games.Scores.Get
class	Games.Scores.List
class	Games.Scores.ListWindow
class	Games.Scores.Submit
class	Games.Scores.SubmitMultiple

Constructor Summary

Constructors

Constructor and Description
Scores()

Method Summary

Modifier and Type	Method and Description
Games.Scores.Get	get(String playerId, String leaderboardId, String timeSpan) Get high scores, and optionally ranks, in leaderboards for the currently authenticated player.
Games.Scores.List	list(String leaderboardId, String collection, String timeSpan) Lists the scores in a leaderboard, starting from the top.
Games.Scores.ListWindow	listWindow(String leaderboardId, String collection, String timeSpan) Lists the scores in a leaderboard around (and including) a player's score.
Games.Scores.Submit	submit(String leaderboardId, Long score) Submits a score to the specified leaderboard.
Games.Scores.SubmitMultiple	submitMultiple(PlayerScoreSubmissionList content) Submits multiple scores to leaderboards.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scores

public Scores()

Method Detail

get

public Games.Scores.Get get(String playerId,
                            String leaderboardId,
                            String timeSpan)
                     throws IOException

Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'. Create a request for the method "scores.get". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

playerId - A player ID. A value of `me` may be used in place of the authenticated player's ID.

leaderboardId - The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.

timeSpan - The time span for the scores and ranks you're requesting.

Returns:

the request

Throws:

IOException

list

public Games.Scores.List list(String leaderboardId,
                              String collection,
                              String timeSpan)
                       throws IOException

Lists the scores in a leaderboard, starting from the top. Create a request for the method "scores.list". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

leaderboardId - The ID of the leaderboard.

collection - The collection of scores you're requesting.

timeSpan - Required. The time span for the scores and ranks you're requesting.

Returns:

the request

Throws:

IOException

listWindow

public Games.Scores.ListWindow listWindow(String leaderboardId,
                                          String collection,
                                          String timeSpan)
                                   throws IOException

Lists the scores in a leaderboard around (and including) a player's score. Create a request for the method "scores.listWindow". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

leaderboardId - The ID of the leaderboard.

collection - The collection of scores you're requesting.

timeSpan - Required. The time span for the scores and ranks you're requesting.

Returns:

the request

Throws:

IOException

submit

public Games.Scores.Submit submit(String leaderboardId,
                                  Long score)
                           throws IOException

Submits a score to the specified leaderboard. Create a request for the method "scores.submit". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

leaderboardId - The ID of the leaderboard.

score - Required. The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.

Returns:

the request

Throws:

IOException

submitMultiple

public Games.Scores.SubmitMultiple submitMultiple(PlayerScoreSubmissionList content)
                                           throws IOException

Submits multiple scores to leaderboards. Create a request for the method "scores.submitMultiple". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the PlayerScoreSubmissionList

Returns:

the request

Throws:

IOException