Class ScoresResource.GetRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<PlayerLeaderboardScoreListResponse>
GamesBaseServiceRequest<PlayerLeaderboardScoreListResponse>
ScoresResource.GetRequest
Implements
Inherited Members
Namespace: Google.Apis.Games.v1
Assembly: Google.Apis.Games.v1.dll
Syntax
public class ScoresResource.GetRequest : GamesBaseServiceRequest<PlayerLeaderboardScoreListResponse>, IClientServiceRequest<PlayerLeaderboardScoreListResponse>, IClientServiceRequest

Constructors

GetRequest(IClientService, string, string, TimeSpanEnum)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string playerId, string leaderboardId, ScoresResource.GetRequest.TimeSpanEnum timeSpan)
Parameters
Type Name Description
IClientService service
string playerId
string leaderboardId
ScoresResource.GetRequest.TimeSpanEnum timeSpan

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Games.v1.Data.PlayerLeaderboardScoreListResponse>.HttpMethod

IncludeRankType

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

Declaration
[RequestParameter("includeRankType", RequestParameterType.Query)]
public virtual ScoresResource.GetRequest.IncludeRankTypeEnum? IncludeRankType { get; set; }
Property Value
Type Description
ScoresResource.GetRequest.IncludeRankTypeEnum?

Language

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

Declaration
[RequestParameter("language", RequestParameterType.Query)]
public virtual string Language { get; set; }
Property Value
Type Description
string

LeaderboardId

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

Declaration
[RequestParameter("leaderboardId", RequestParameterType.Path)]
public virtual string LeaderboardId { get; }
Property Value
Type Description
string

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.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Games.v1.Data.PlayerLeaderboardScoreListResponse>.MethodName

PageToken

The token returned by the previous request.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

PlayerId

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

Declaration
[RequestParameter("playerId", RequestParameterType.Path)]
public virtual string PlayerId { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Games.v1.Data.PlayerLeaderboardScoreListResponse>.RestPath

TimeSpan

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

Declaration
[RequestParameter("timeSpan", RequestParameterType.Path)]
public virtual ScoresResource.GetRequest.TimeSpanEnum TimeSpan { get; }
Property Value
Type Description
ScoresResource.GetRequest.TimeSpanEnum

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements