Google_Service_Games_Scores_Resource Class Reference

The "scores" collection of methods. More...

Inheritance diagram for Google_Service_Games_Scores_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($playerId, $leaderboardId, $timeSpan, $optParams=array())
	Get high scores, and optionally ranks, in leaderboards for the currently authenticated player.
	listScores ($leaderboardId, $collection, $timeSpan, $optParams=array())
	Lists the scores in a leaderboard, starting from the top.
	listWindow ($leaderboardId, $collection, $timeSpan, $optParams=array())
	Lists the scores in a leaderboard around (and including) a player's score.
	submit ($leaderboardId, $score, $optParams=array())
	Submits a score to the specified leaderboard.
	submitMultiple (Google_Service_Games_PlayerScoreSubmissionList $postBody, $optParams=array())
	Submits multiple scores to leaderboards.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "scores" collection of methods.

Typical usage is: $gamesService = new Google_Service_Games(...); $scores = $gamesService->scores;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_Games_Scores_Resource::get	(		$playerId,
			$leaderboardId,
			$timeSpan,
			$optParams = array() )

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'. (scores.get)

Parameters

string	$playerId	A player ID. A value of me may be used in place of the authenticated player's ID.
string	$leaderboardId	The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.
string	$timeSpan	The time span for the scores and ranks you're requesting.
array	$optParams	Optional parameters.

@opt_param string includeRankType The types of ranks to return. If the parameter is omitted, no ranks will be returned. @opt_param string language The preferred language to use for strings returned by this method. @opt_param int maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. @opt_param string pageToken The token returned by the previous request.

Return values

Google_Service_Games_PlayerLeaderboardScoreListResponse

listScores()

Google_Service_Games_Scores_Resource::listScores	(		$leaderboardId,
			$collection,
			$timeSpan,
			$optParams = array() )

Lists the scores in a leaderboard, starting from the top.

(scores.listScores)

Parameters

string	$leaderboardId	The ID of the leaderboard.
string	$collection	The collection of scores you're requesting.
string	$timeSpan	The time span for the scores and ranks you're requesting.
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method. @opt_param int maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. @opt_param string pageToken The token returned by the previous request.

Return values

Google_Service_Games_LeaderboardScores

listWindow()

Google_Service_Games_Scores_Resource::listWindow	(		$leaderboardId,
			$collection,
			$timeSpan,
			$optParams = array() )

Lists the scores in a leaderboard around (and including) a player's score.

(scores.listWindow)

Parameters

string	$leaderboardId	The ID of the leaderboard.
string	$collection	The collection of scores you're requesting.
string	$timeSpan	The time span for the scores and ranks you're requesting.
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method. @opt_param bool returnTopIfAbsent True if the top scores should be returned when the player is not in the leaderboard. Defaults to true. @opt_param int resultsAbove The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults. @opt_param int maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. @opt_param string pageToken The token returned by the previous request.

Return values

Google_Service_Games_LeaderboardScores

submit()

Google_Service_Games_Scores_Resource::submit	(		$leaderboardId,
			$score,
			$optParams = array() )

Submits a score to the specified leaderboard.

(scores.submit)

Parameters

string	$leaderboardId	The ID of the leaderboard.
string	$score	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.
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method. @opt_param string scoreTag Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.

Return values

Google_Service_Games_PlayerScoreResponse

submitMultiple()

Google_Service_Games_Scores_Resource::submitMultiple	(	Google_Service_Games_PlayerScoreSubmissionList	$postBody,
			$optParams = array() )

Submits multiple scores to leaderboards.

(scores.submitMultiple)

Parameters

Google_PlayerScoreSubmissionList	$postBody
array	$optParams	Optional parameters.

@opt_param string language The preferred language to use for strings returned by this method.

Return values

Google_Service_Games_PlayerScoreListResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Games.php