com.google.api.services.games

Class Games.Scores.Get

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.games.GamesRequest<PlayerLeaderboardScoreListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Games.Scores

public class Games.Scores.Get
extends GamesRequest<PlayerLeaderboardScoreListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String playerId, String leaderboardId, String timeSpan) Get high scores, and optionally ranks, in leaderboards for the currently authenticated player.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getIncludeRankType() The types of ranks to return.
String	getLanguage() The preferred language to use for strings returned by this method.
String	getLeaderboardId() The ID of the leaderboard.
Integer	getMaxResults() The maximum number of leaderboard scores to return in the response.
String	getPageToken() The token returned by the previous request.
String	getPlayerId() A player ID.
String	getTimeSpan() The time span for the scores and ranks you're requesting.
Games.Scores.Get	set(String parameterName, Object value)
Games.Scores.Get	set$Xgafv(String $Xgafv) V1 error format.
Games.Scores.Get	setAccessToken(String accessToken) OAuth access token.
Games.Scores.Get	setAlt(String alt) Data format for response.
Games.Scores.Get	setCallback(String callback) JSONP
Games.Scores.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Games.Scores.Get	setIncludeRankType(String includeRankType) The types of ranks to return.
Games.Scores.Get	setKey(String key) API key.
Games.Scores.Get	setLanguage(String language) The preferred language to use for strings returned by this method.
Games.Scores.Get	setLeaderboardId(String leaderboardId) The ID of the leaderboard.
Games.Scores.Get	setMaxResults(Integer maxResults) The maximum number of leaderboard scores to return in the response.
Games.Scores.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Games.Scores.Get	setPageToken(String pageToken) The token returned by the previous request.
Games.Scores.Get	setPlayerId(String playerId) A player ID.
Games.Scores.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Games.Scores.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Games.Scores.Get	setTimeSpan(String timeSpan) The time span for the scores and ranks you're requesting.
Games.Scores.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Games.Scores.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.games.GamesRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Get

protected Get(String playerId,
              String leaderboardId,
              String timeSpan)

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 the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Games.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

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.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlayerLeaderboardScoreListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlayerLeaderboardScoreListResponse>

Throws:

IOException

set$Xgafv

public Games.Scores.Get set$Xgafv(String $Xgafv)

Description copied from class: GamesRequest

V1 error format.

Overrides:

set$Xgafv in class GamesRequest<PlayerLeaderboardScoreListResponse>

setAccessToken

public Games.Scores.Get setAccessToken(String accessToken)

Description copied from class: GamesRequest

OAuth access token.

Overrides:

setAccessToken in class GamesRequest<PlayerLeaderboardScoreListResponse>

setAlt

public Games.Scores.Get setAlt(String alt)

Description copied from class: GamesRequest

Data format for response.

Overrides:

setAlt in class GamesRequest<PlayerLeaderboardScoreListResponse>

setCallback

public Games.Scores.Get setCallback(String callback)

Description copied from class: GamesRequest

JSONP

Overrides:

setCallback in class GamesRequest<PlayerLeaderboardScoreListResponse>

setFields

public Games.Scores.Get setFields(String fields)

Description copied from class: GamesRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GamesRequest<PlayerLeaderboardScoreListResponse>

setKey

public Games.Scores.Get setKey(String key)

Description copied from class: GamesRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class GamesRequest<PlayerLeaderboardScoreListResponse>

setOauthToken

public Games.Scores.Get setOauthToken(String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<PlayerLeaderboardScoreListResponse>

setPrettyPrint

public Games.Scores.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<PlayerLeaderboardScoreListResponse>

setQuotaUser

public Games.Scores.Get setQuotaUser(String quotaUser)

Description copied from class: GamesRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class GamesRequest<PlayerLeaderboardScoreListResponse>

setUploadType

public Games.Scores.Get setUploadType(String uploadType)

Description copied from class: GamesRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class GamesRequest<PlayerLeaderboardScoreListResponse>

setUploadProtocol

public Games.Scores.Get setUploadProtocol(String uploadProtocol)

Description copied from class: GamesRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class GamesRequest<PlayerLeaderboardScoreListResponse>

getPlayerId

public String getPlayerId()

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

setPlayerId

public Games.Scores.Get setPlayerId(String playerId)

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

getLeaderboardId

public String getLeaderboardId()

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

setLeaderboardId

public Games.Scores.Get setLeaderboardId(String leaderboardId)

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

getTimeSpan

public String getTimeSpan()

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

setTimeSpan

public Games.Scores.Get setTimeSpan(String timeSpan)

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

getIncludeRankType

public String getIncludeRankType()

The types of ranks to return. If the parameter is omitted, no ranks will be returned.

setIncludeRankType

public Games.Scores.Get setIncludeRankType(String includeRankType)

The types of ranks to return. If the parameter is omitted, no ranks will be returned.

getLanguage

public String getLanguage()

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

setLanguage

public Games.Scores.Get setLanguage(String language)

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

getMaxResults

public Integer getMaxResults()

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`.

setMaxResults

public Games.Scores.Get setMaxResults(Integer 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`.

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public Games.Scores.Get setPageToken(String pageToken)

The token returned by the previous request.

set

public Games.Scores.Get set(String parameterName,
                            Object value)

Overrides:

set in class GamesRequest<PlayerLeaderboardScoreListResponse>