Documentation

Google_Service_Games_Resource_Scores extends Google_Service_Resource
in package

Application

The "scores" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Games_PlayerLeaderboardScoreListResponse: 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)
listScores() : Google_Service_Games_LeaderboardScores: Lists the scores in a leaderboard, starting from the top. (scores.listScores)
listWindow() : Google_Service_Games_LeaderboardScores: Lists the scores in a leaderboard around (and including) a player's score.
submit() : Google_Service_Games_PlayerScoreResponse: Submits a score to the specified leaderboard. (scores.submit)
submitMultiple() : Google_Service_Games_PlayerScoreListResponse: Submits multiple scores to leaderboards. (scores.submitMultiple)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

get()

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)


    public
                get(string $playerId, string $leaderboardId, string $timeSpan[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerLeaderboardScoreListResponse

Parameters

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

Return values

Google_Service_Games_PlayerLeaderboardScoreListResponse —

listScores()

Lists the scores in a leaderboard, starting from the top. (scores.listScores)


    public
                listScores(string $leaderboardId, string $collection, string $timeSpan[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_LeaderboardScores

Parameters

$leaderboardId : string: The ID of the leaderboard.
$collection : string: The collection of scores you're requesting.
$timeSpan : string: The time span for the scores and ranks you're requesting.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_LeaderboardScores —

listWindow()

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


    public
                listWindow(string $leaderboardId, string $collection, string $timeSpan[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_LeaderboardScores

(scores.listWindow)

Parameters

$leaderboardId : string: The ID of the leaderboard.
$collection : string: The collection of scores you're requesting.
$timeSpan : string: The time span for the scores and ranks you're requesting.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_LeaderboardScores —

submit()

Submits a score to the specified leaderboard. (scores.submit)


    public
                submit(string $leaderboardId, string $score[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerScoreResponse

Parameters

$leaderboardId : string: The ID of the leaderboard.
$score : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_PlayerScoreResponse —

submitMultiple()

Submits multiple scores to leaderboards. (scores.submitMultiple)


    public
                submitMultiple(Google_Service_Games_PlayerScoreSubmissionList $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Games_PlayerScoreListResponse

Parameters

$postBody : Google_Service_Games_PlayerScoreSubmissionList
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Games_PlayerScoreListResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —