gogol-games-0.4.0: Google Play Game Services SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Games.Scores.Get

Contents

Description

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.

Synopsis

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)))))))))))) Source #

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

Creating a Request

scoresGet Source #

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:

data ScoresGet Source #

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 Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Data ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScoresGet -> c ScoresGet #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScoresGet #

toConstr :: ScoresGet -> Constr #

dataTypeOf :: ScoresGet -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ScoresGet) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScoresGet) #

gmapT :: (forall b. Data b => b -> b) -> ScoresGet -> ScoresGet #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScoresGet -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScoresGet -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScoresGet -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScoresGet -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScoresGet -> m ScoresGet #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScoresGet -> m ScoresGet #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScoresGet -> m ScoresGet #

Show ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Generic ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Associated Types

type Rep ScoresGet :: Type -> Type #

GoogleRequest ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Associated Types

type Rs ScoresGet :: Type #

type Scopes ScoresGet :: [Symbol] #

type Rep ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

type Scopes ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

type Scopes ScoresGet = "https://www.googleapis.com/auth/games" ': ([] :: [Symbol])
type Rs ScoresGet Source # 
Instance details

Defined in Network.Google.Resource.Games.Scores.Get

Request Lenses

sgTimeSpan :: Lens' ScoresGet ScoresGetTimeSpan Source #

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

sgLeaderboardId :: Lens' ScoresGet Text Source #

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

sgIncludeRankType :: Lens' ScoresGet (Maybe ScoresGetIncludeRankType) Source #

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

sgLanguage :: Lens' ScoresGet (Maybe Text) Source #

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

sgPageToken :: Lens' ScoresGet (Maybe Text) Source #

The token returned by the previous request.

sgPlayerId :: Lens' ScoresGet Text Source #

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

sgMaxResults :: Lens' ScoresGet (Maybe Int32) Source #

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.