Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- API Declaration
- Resources
- gamesManagement.achievements.reset
- gamesManagement.achievements.resetAll
- gamesManagement.achievements.resetAllForAllPlayers
- gamesManagement.achievements.resetForAllPlayers
- gamesManagement.achievements.resetMultipleForAllPlayers
- gamesManagement.applications.listHidden
- gamesManagement.events.reset
- gamesManagement.events.resetAll
- gamesManagement.events.resetAllForAllPlayers
- gamesManagement.events.resetForAllPlayers
- gamesManagement.events.resetMultipleForAllPlayers
- gamesManagement.players.hide
- gamesManagement.players.unhide
- gamesManagement.quests.reset
- gamesManagement.quests.resetAll
- gamesManagement.quests.resetAllForAllPlayers
- gamesManagement.quests.resetForAllPlayers
- gamesManagement.quests.resetMultipleForAllPlayers
- gamesManagement.rooms.reset
- gamesManagement.rooms.resetForAllPlayers
- gamesManagement.scores.reset
- gamesManagement.scores.resetAll
- gamesManagement.scores.resetAllForAllPlayers
- gamesManagement.scores.resetForAllPlayers
- gamesManagement.scores.resetMultipleForAllPlayers
- gamesManagement.turnBasedMatches.reset
- gamesManagement.turnBasedMatches.resetForAllPlayers
- Types
- GamesPlayerExperienceInfoResource
- PlayerName
- PlayerScoreResetAllResponse
- GamesPlayedResource
- GamesPlayerLevelResource
- PlayerScoreResetResponse
- ScoresResetMultipleForAllRequest
- QuestsResetMultipleForAllRequest
- HiddenPlayerList
- EventsResetMultipleForAllRequest
- AchievementResetMultipleForAllRequest
- HiddenPlayer
- AchievementResetAllResponse
- Player
- AchievementResetResponse
The Management API for Google Play Game Services.
- gamesManagementService :: Service
- type GamesManagementAPI = RoomsResetForAllPlayersResource :<|> (RoomsResetResource :<|> (AchievementsResetAllResource :<|> (AchievementsResetAllForAllPlayersResource :<|> (AchievementsResetMultipleForAllPlayersResource :<|> (AchievementsResetForAllPlayersResource :<|> (AchievementsResetResource :<|> (EventsResetAllResource :<|> (EventsResetAllForAllPlayersResource :<|> (EventsResetMultipleForAllPlayersResource :<|> (EventsResetForAllPlayersResource :<|> (EventsResetResource :<|> (QuestsResetAllResource :<|> (QuestsResetAllForAllPlayersResource :<|> (QuestsResetMultipleForAllPlayersResource :<|> (QuestsResetForAllPlayersResource :<|> (QuestsResetResource :<|> (PlayersHideResource :<|> (PlayersUnhideResource :<|> (ScoresResetAllResource :<|> (ScoresResetAllForAllPlayersResource :<|> (ScoresResetMultipleForAllPlayersResource :<|> (ScoresResetForAllPlayersResource :<|> (ScoresResetResource :<|> (TurnBasedMatchesResetForAllPlayersResource :<|> (TurnBasedMatchesResetResource :<|> ApplicationsListHiddenResource)))))))))))))))))))))))))
- module Network.Google.Resource.GamesManagement.Achievements.Reset
- module Network.Google.Resource.GamesManagement.Achievements.ResetAll
- module Network.Google.Resource.GamesManagement.Achievements.ResetAllForAllPlayers
- module Network.Google.Resource.GamesManagement.Achievements.ResetForAllPlayers
- module Network.Google.Resource.GamesManagement.Achievements.ResetMultipleForAllPlayers
- module Network.Google.Resource.GamesManagement.Applications.ListHidden
- module Network.Google.Resource.GamesManagement.Events.Reset
- module Network.Google.Resource.GamesManagement.Events.ResetAll
- module Network.Google.Resource.GamesManagement.Events.ResetAllForAllPlayers
- module Network.Google.Resource.GamesManagement.Events.ResetForAllPlayers
- module Network.Google.Resource.GamesManagement.Events.ResetMultipleForAllPlayers
- module Network.Google.Resource.GamesManagement.Players.Hide
- module Network.Google.Resource.GamesManagement.Players.Unhide
- module Network.Google.Resource.GamesManagement.Quests.Reset
- module Network.Google.Resource.GamesManagement.Quests.ResetAll
- module Network.Google.Resource.GamesManagement.Quests.ResetAllForAllPlayers
- module Network.Google.Resource.GamesManagement.Quests.ResetForAllPlayers
- module Network.Google.Resource.GamesManagement.Quests.ResetMultipleForAllPlayers
- module Network.Google.Resource.GamesManagement.Rooms.Reset
- module Network.Google.Resource.GamesManagement.Rooms.ResetForAllPlayers
- module Network.Google.Resource.GamesManagement.Scores.Reset
- module Network.Google.Resource.GamesManagement.Scores.ResetAll
- module Network.Google.Resource.GamesManagement.Scores.ResetAllForAllPlayers
- module Network.Google.Resource.GamesManagement.Scores.ResetForAllPlayers
- module Network.Google.Resource.GamesManagement.Scores.ResetMultipleForAllPlayers
- module Network.Google.Resource.GamesManagement.TurnBasedMatches.Reset
- module Network.Google.Resource.GamesManagement.TurnBasedMatches.ResetForAllPlayers
- data GamesPlayerExperienceInfoResource
- gamesPlayerExperienceInfoResource :: GamesPlayerExperienceInfoResource
- gpeirCurrentExperiencePoints :: Lens' GamesPlayerExperienceInfoResource (Maybe Int64)
- gpeirCurrentLevel :: Lens' GamesPlayerExperienceInfoResource (Maybe GamesPlayerLevelResource)
- gpeirNextLevel :: Lens' GamesPlayerExperienceInfoResource (Maybe GamesPlayerLevelResource)
- gpeirLastLevelUpTimestampMillis :: Lens' GamesPlayerExperienceInfoResource (Maybe Int64)
- data PlayerName
- playerName :: PlayerName
- pnGivenName :: Lens' PlayerName (Maybe Text)
- pnFamilyName :: Lens' PlayerName (Maybe Text)
- data PlayerScoreResetAllResponse
- playerScoreResetAllResponse :: PlayerScoreResetAllResponse
- psrarResults :: Lens' PlayerScoreResetAllResponse [PlayerScoreResetResponse]
- psrarKind :: Lens' PlayerScoreResetAllResponse Text
- data GamesPlayedResource
- gamesPlayedResource :: GamesPlayedResource
- gprAutoMatched :: Lens' GamesPlayedResource (Maybe Bool)
- gprTimeMillis :: Lens' GamesPlayedResource (Maybe Int64)
- data GamesPlayerLevelResource
- gamesPlayerLevelResource :: GamesPlayerLevelResource
- gplrMaxExperiencePoints :: Lens' GamesPlayerLevelResource (Maybe Int64)
- gplrMinExperiencePoints :: Lens' GamesPlayerLevelResource (Maybe Int64)
- gplrLevel :: Lens' GamesPlayerLevelResource (Maybe Int32)
- data PlayerScoreResetResponse
- playerScoreResetResponse :: PlayerScoreResetResponse
- psrrKind :: Lens' PlayerScoreResetResponse Text
- psrrResetScoreTimeSpans :: Lens' PlayerScoreResetResponse [Text]
- psrrDefinitionId :: Lens' PlayerScoreResetResponse (Maybe Text)
- data ScoresResetMultipleForAllRequest
- scoresResetMultipleForAllRequest :: ScoresResetMultipleForAllRequest
- srmfarKind :: Lens' ScoresResetMultipleForAllRequest Text
- srmfarLeaderboardIds :: Lens' ScoresResetMultipleForAllRequest [Text]
- data QuestsResetMultipleForAllRequest
- questsResetMultipleForAllRequest :: QuestsResetMultipleForAllRequest
- qrmfarKind :: Lens' QuestsResetMultipleForAllRequest Text
- qrmfarQuestIds :: Lens' QuestsResetMultipleForAllRequest [Text]
- data HiddenPlayerList
- hiddenPlayerList :: HiddenPlayerList
- hplNextPageToken :: Lens' HiddenPlayerList (Maybe Text)
- hplKind :: Lens' HiddenPlayerList Text
- hplItems :: Lens' HiddenPlayerList [HiddenPlayer]
- data EventsResetMultipleForAllRequest
- eventsResetMultipleForAllRequest :: EventsResetMultipleForAllRequest
- ermfarKind :: Lens' EventsResetMultipleForAllRequest Text
- ermfarEventIds :: Lens' EventsResetMultipleForAllRequest [Text]
- data AchievementResetMultipleForAllRequest
- achievementResetMultipleForAllRequest :: AchievementResetMultipleForAllRequest
- armfarKind :: Lens' AchievementResetMultipleForAllRequest Text
- armfarAchievementIds :: Lens' AchievementResetMultipleForAllRequest [Text]
- data HiddenPlayer
- hiddenPlayer :: HiddenPlayer
- hpKind :: Lens' HiddenPlayer Text
- hpHiddenTimeMillis :: Lens' HiddenPlayer (Maybe Int64)
- hpPlayer :: Lens' HiddenPlayer (Maybe Player)
- data AchievementResetAllResponse
- achievementResetAllResponse :: AchievementResetAllResponse
- ararResults :: Lens' AchievementResetAllResponse [AchievementResetResponse]
- ararKind :: Lens' AchievementResetAllResponse Text
- data Player
- player :: Player
- pLastPlayedWith :: Lens' Player (Maybe GamesPlayedResource)
- pAvatarImageURL :: Lens' Player (Maybe Text)
- pKind :: Lens' Player Text
- pExperienceInfo :: Lens' Player (Maybe GamesPlayerExperienceInfoResource)
- pName :: Lens' Player (Maybe PlayerName)
- pDisplayName :: Lens' Player (Maybe Text)
- pTitle :: Lens' Player (Maybe Text)
- pPlayerId :: Lens' Player (Maybe Text)
- data AchievementResetResponse
- achievementResetResponse :: AchievementResetResponse
- arrUpdateOccurred :: Lens' AchievementResetResponse (Maybe Bool)
- arrKind :: Lens' AchievementResetResponse Text
- arrCurrentState :: Lens' AchievementResetResponse (Maybe Text)
- arrDefinitionId :: Lens' AchievementResetResponse (Maybe Text)
Service Configuration
gamesManagementService :: Service Source
Default request referring to version v1management
of the Google Play Game Services Management API. This contains the host and root path used as a starting point for constructing service requests.
API Declaration
type GamesManagementAPI = RoomsResetForAllPlayersResource :<|> (RoomsResetResource :<|> (AchievementsResetAllResource :<|> (AchievementsResetAllForAllPlayersResource :<|> (AchievementsResetMultipleForAllPlayersResource :<|> (AchievementsResetForAllPlayersResource :<|> (AchievementsResetResource :<|> (EventsResetAllResource :<|> (EventsResetAllForAllPlayersResource :<|> (EventsResetMultipleForAllPlayersResource :<|> (EventsResetForAllPlayersResource :<|> (EventsResetResource :<|> (QuestsResetAllResource :<|> (QuestsResetAllForAllPlayersResource :<|> (QuestsResetMultipleForAllPlayersResource :<|> (QuestsResetForAllPlayersResource :<|> (QuestsResetResource :<|> (PlayersHideResource :<|> (PlayersUnhideResource :<|> (ScoresResetAllResource :<|> (ScoresResetAllForAllPlayersResource :<|> (ScoresResetMultipleForAllPlayersResource :<|> (ScoresResetForAllPlayersResource :<|> (ScoresResetResource :<|> (TurnBasedMatchesResetForAllPlayersResource :<|> (TurnBasedMatchesResetResource :<|> ApplicationsListHiddenResource))))))))))))))))))))))))) Source
Represents the entirety of the methods and resources available for the Google Play Game Services Management API service.
Resources
gamesManagement.achievements.reset
gamesManagement.achievements.resetAll
gamesManagement.achievements.resetAllForAllPlayers
gamesManagement.achievements.resetForAllPlayers
gamesManagement.achievements.resetMultipleForAllPlayers
gamesManagement.applications.listHidden
gamesManagement.events.reset
gamesManagement.events.resetAll
gamesManagement.events.resetAllForAllPlayers
gamesManagement.events.resetForAllPlayers
gamesManagement.events.resetMultipleForAllPlayers
gamesManagement.players.hide
gamesManagement.players.unhide
gamesManagement.quests.reset
gamesManagement.quests.resetAll
gamesManagement.quests.resetAllForAllPlayers
gamesManagement.quests.resetForAllPlayers
gamesManagement.quests.resetMultipleForAllPlayers
gamesManagement.rooms.reset
gamesManagement.rooms.resetForAllPlayers
gamesManagement.scores.reset
gamesManagement.scores.resetAll
gamesManagement.scores.resetAllForAllPlayers
gamesManagement.scores.resetForAllPlayers
gamesManagement.scores.resetMultipleForAllPlayers
gamesManagement.turnBasedMatches.reset
gamesManagement.turnBasedMatches.resetForAllPlayers
Types
GamesPlayerExperienceInfoResource
data GamesPlayerExperienceInfoResource Source
This is a JSON template for 1P/3P metadata about the player's experience.
See: gamesPlayerExperienceInfoResource
smart constructor.
gamesPlayerExperienceInfoResource :: GamesPlayerExperienceInfoResource Source
Creates a value of GamesPlayerExperienceInfoResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gpeirCurrentExperiencePoints :: Lens' GamesPlayerExperienceInfoResource (Maybe Int64) Source
The current number of experience points for the player.
gpeirCurrentLevel :: Lens' GamesPlayerExperienceInfoResource (Maybe GamesPlayerLevelResource) Source
The current level of the player.
gpeirNextLevel :: Lens' GamesPlayerExperienceInfoResource (Maybe GamesPlayerLevelResource) Source
The next level of the player. If the current level is the maximum level, this should be same as the current level.
gpeirLastLevelUpTimestampMillis :: Lens' GamesPlayerExperienceInfoResource (Maybe Int64) Source
The timestamp when the player was leveled up, in millis since Unix epoch UTC.
PlayerName
data PlayerName Source
An object representation of the individual components of the player's name. For some players, these fields may not be present.
See: playerName
smart constructor.
playerName :: PlayerName Source
Creates a value of PlayerName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pnGivenName :: Lens' PlayerName (Maybe Text) Source
The given name of this player. In some places, this is known as the first name.
pnFamilyName :: Lens' PlayerName (Maybe Text) Source
The family name of this player. In some places, this is known as the last name.
PlayerScoreResetAllResponse
data PlayerScoreResetAllResponse Source
This is a JSON template for a list of leaderboard reset resources.
See: playerScoreResetAllResponse
smart constructor.
playerScoreResetAllResponse :: PlayerScoreResetAllResponse Source
Creates a value of PlayerScoreResetAllResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psrarResults :: Lens' PlayerScoreResetAllResponse [PlayerScoreResetResponse] Source
The leaderboard reset results.
psrarKind :: Lens' PlayerScoreResetAllResponse Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.
GamesPlayedResource
data GamesPlayedResource Source
This is a JSON template for metadata about a player playing a game with the currently authenticated user.
See: gamesPlayedResource
smart constructor.
gamesPlayedResource :: GamesPlayedResource Source
Creates a value of GamesPlayedResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gprAutoMatched :: Lens' GamesPlayedResource (Maybe Bool) Source
True if the player was auto-matched with the currently authenticated user.
gprTimeMillis :: Lens' GamesPlayedResource (Maybe Int64) Source
The last time the player played the game in milliseconds since the epoch in UTC.
GamesPlayerLevelResource
data GamesPlayerLevelResource Source
This is a JSON template for 1P/3P metadata about a user's level.
See: gamesPlayerLevelResource
smart constructor.
gamesPlayerLevelResource :: GamesPlayerLevelResource Source
Creates a value of GamesPlayerLevelResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gplrMaxExperiencePoints :: Lens' GamesPlayerLevelResource (Maybe Int64) Source
The maximum experience points for this level.
gplrMinExperiencePoints :: Lens' GamesPlayerLevelResource (Maybe Int64) Source
The minimum experience points for this level.
PlayerScoreResetResponse
data PlayerScoreResetResponse Source
This is a JSON template for a list of reset leaderboard entry resources.
See: playerScoreResetResponse
smart constructor.
playerScoreResetResponse :: PlayerScoreResetResponse Source
Creates a value of PlayerScoreResetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psrrKind :: Lens' PlayerScoreResetResponse Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.
psrrResetScoreTimeSpans :: Lens' PlayerScoreResetResponse [Text] Source
The time spans of the updated score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score.
psrrDefinitionId :: Lens' PlayerScoreResetResponse (Maybe Text) Source
The ID of an leaderboard for which player state has been updated.
ScoresResetMultipleForAllRequest
data ScoresResetMultipleForAllRequest Source
This is a JSON template for multiple scores reset all request.
See: scoresResetMultipleForAllRequest
smart constructor.
scoresResetMultipleForAllRequest :: ScoresResetMultipleForAllRequest Source
Creates a value of ScoresResetMultipleForAllRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srmfarKind :: Lens' ScoresResetMultipleForAllRequest Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest.
srmfarLeaderboardIds :: Lens' ScoresResetMultipleForAllRequest [Text] Source
The IDs of leaderboards to reset.
QuestsResetMultipleForAllRequest
data QuestsResetMultipleForAllRequest Source
This is a JSON template for multiple quests reset all request.
See: questsResetMultipleForAllRequest
smart constructor.
questsResetMultipleForAllRequest :: QuestsResetMultipleForAllRequest Source
Creates a value of QuestsResetMultipleForAllRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qrmfarKind :: Lens' QuestsResetMultipleForAllRequest Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#questsResetMultipleForAllRequest.
qrmfarQuestIds :: Lens' QuestsResetMultipleForAllRequest [Text] Source
The IDs of quests to reset.
HiddenPlayerList
data HiddenPlayerList Source
This is a JSON template for a list of hidden players.
See: hiddenPlayerList
smart constructor.
hiddenPlayerList :: HiddenPlayerList Source
Creates a value of HiddenPlayerList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hplNextPageToken :: Lens' HiddenPlayerList (Maybe Text) Source
The pagination token for the next page of results.
hplKind :: Lens' HiddenPlayerList Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList.
hplItems :: Lens' HiddenPlayerList [HiddenPlayer] Source
The players.
EventsResetMultipleForAllRequest
data EventsResetMultipleForAllRequest Source
This is a JSON template for multiple events reset all request.
See: eventsResetMultipleForAllRequest
smart constructor.
eventsResetMultipleForAllRequest :: EventsResetMultipleForAllRequest Source
Creates a value of EventsResetMultipleForAllRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ermfarKind :: Lens' EventsResetMultipleForAllRequest Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest.
ermfarEventIds :: Lens' EventsResetMultipleForAllRequest [Text] Source
The IDs of events to reset.
AchievementResetMultipleForAllRequest
data AchievementResetMultipleForAllRequest Source
This is a JSON template for multiple achievements reset all request.
See: achievementResetMultipleForAllRequest
smart constructor.
achievementResetMultipleForAllRequest :: AchievementResetMultipleForAllRequest Source
Creates a value of AchievementResetMultipleForAllRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
armfarKind :: Lens' AchievementResetMultipleForAllRequest Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest.
armfarAchievementIds :: Lens' AchievementResetMultipleForAllRequest [Text] Source
The IDs of achievements to reset.
HiddenPlayer
data HiddenPlayer Source
This is a JSON template for the HiddenPlayer resource.
See: hiddenPlayer
smart constructor.
hiddenPlayer :: HiddenPlayer Source
Creates a value of HiddenPlayer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hpKind :: Lens' HiddenPlayer Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer.
hpHiddenTimeMillis :: Lens' HiddenPlayer (Maybe Int64) Source
The time this player was hidden.
AchievementResetAllResponse
data AchievementResetAllResponse Source
This is a JSON template for achievement reset all response.
See: achievementResetAllResponse
smart constructor.
achievementResetAllResponse :: AchievementResetAllResponse Source
Creates a value of AchievementResetAllResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ararResults :: Lens' AchievementResetAllResponse [AchievementResetResponse] Source
The achievement reset results.
ararKind :: Lens' AchievementResetAllResponse Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse.
Player
This is a JSON template for a Player resource.
See: player
smart constructor.
Creates a value of Player
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pLastPlayedWith :: Lens' Player (Maybe GamesPlayedResource) Source
Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
pAvatarImageURL :: Lens' Player (Maybe Text) Source
The base URL for the image that represents the player.
pKind :: Lens' Player Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player.
pExperienceInfo :: Lens' Player (Maybe GamesPlayerExperienceInfoResource) Source
An object to represent Play Game experience information for the player.
pName :: Lens' Player (Maybe PlayerName) Source
An object representation of the individual components of the player's name. For some players, these fields may not be present.
AchievementResetResponse
data AchievementResetResponse Source
This is a JSON template for an achievement reset response.
See: achievementResetResponse
smart constructor.
achievementResetResponse :: AchievementResetResponse Source
Creates a value of AchievementResetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arrUpdateOccurred :: Lens' AchievementResetResponse (Maybe Bool) Source
Flag to indicate if the requested update actually occurred.
arrKind :: Lens' AchievementResetResponse Text Source
Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
arrCurrentState :: Lens' AchievementResetResponse (Maybe Text) Source
The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - "HIDDEN"- Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.
arrDefinitionId :: Lens' AchievementResetResponse (Maybe Text) Source
The ID of an achievement for which player state has been updated.