Network.Google.Resource.Games.Scores.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'.

See: Google Play Game Services API Reference for games.scores.get.

REST Resource

type ScoresGetResource = "games" :> ("v1" :> ("players" :> (Capture "playerId" Text :> ("leaderboards" :> (Capture "leaderboardId" Text :> ("scores" :> (Capture "timeSpan" ScoresGetTimeSpan :> (QueryParam "includeRankType" ScoresGetIncludeRankType :> (QueryParam "language" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` PlayerLeaderboardScoreListResponse))))))))))))

A resource alias for games.scores.get method which the ScoresGet request conforms to.

Creating a Request

scoresGet

Arguments

:: ScoresGetTimeSpan

sgTimeSpan

-> Text

sgLeaderboardId

-> Text

sgPlayerId

-> ScoresGet

Creates a value of ScoresGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sgTimeSpan
• sgLeaderboardId
• sgIncludeRankType
• sgLanguage
• sgPageToken
• sgPlayerId
• sgMaxResults

data ScoresGet

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

See: scoresGet smart constructor.

Instances

Eq ScoresGet

Data ScoresGet

Show ScoresGet

Generic ScoresGet

GoogleRequest ScoresGet

type Rep ScoresGet

type Rs ScoresGet = PlayerLeaderboardScoreListResponse

Request Lenses

sgTimeSpan :: Lens' ScoresGet ScoresGetTimeSpan

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

sgLeaderboardId :: Lens' ScoresGet Text

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

sgIncludeRankType :: Lens' ScoresGet (Maybe ScoresGetIncludeRankType)

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

sgLanguage :: Lens' ScoresGet (Maybe Text)

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

sgPageToken :: Lens' ScoresGet (Maybe Text)

The token returned by the previous request.

sgPlayerId :: Lens' ScoresGet Text

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

sgMaxResults :: Lens' ScoresGet (Maybe Int32)

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.