Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 1404 lines (42 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 24 classes

Google_Service_GamesManagement:: (1 method):
  __construct()

Google_Service_GamesManagement_Achievements_Resource:: (5 methods):
  reset()
  resetAll()
  resetAllForAllPlayers()
  resetForAllPlayers()
  resetMultipleForAllPlayers()

Google_Service_GamesManagement_Applications_Resource:: (1 method):
  listHidden()

Google_Service_GamesManagement_Events_Resource:: (5 methods):
  reset()
  resetAll()
  resetAllForAllPlayers()
  resetForAllPlayers()
  resetMultipleForAllPlayers()

Google_Service_GamesManagement_Players_Resource:: (2 methods):
  hide()
  unhide()

Google_Service_GamesManagement_Quests_Resource:: (5 methods):
  reset()
  resetAll()
  resetAllForAllPlayers()
  resetForAllPlayers()
  resetMultipleForAllPlayers()

Google_Service_GamesManagement_Rooms_Resource:: (2 methods):
  reset()
  resetForAllPlayers()

Google_Service_GamesManagement_Scores_Resource:: (5 methods):
  reset()
  resetAll()
  resetAllForAllPlayers()
  resetForAllPlayers()
  resetMultipleForAllPlayers()

Google_Service_GamesManagement_TurnBasedMatches_Resource:: (2 methods):
  reset()
  resetForAllPlayers()

Google_Service_GamesManagement_AchievementResetAllResponse:: (4 methods):
  setKind()
  getKind()
  setResults()
  getResults()

Google_Service_GamesManagement_AchievementResetMultipleForAllRequest:: (4 methods):
  setAchievementIds()
  getAchievementIds()
  setKind()
  getKind()

Google_Service_GamesManagement_AchievementResetResponse:: (8 methods):
  setCurrentState()
  getCurrentState()
  setDefinitionId()
  getDefinitionId()
  setKind()
  getKind()
  setUpdateOccurred()
  getUpdateOccurred()

Google_Service_GamesManagement_EventsResetMultipleForAllRequest:: (4 methods):
  setEventIds()
  getEventIds()
  setKind()
  getKind()

Google_Service_GamesManagement_GamesPlayedResource:: (4 methods):
  setAutoMatched()
  getAutoMatched()
  setTimeMillis()
  getTimeMillis()

Google_Service_GamesManagement_GamesPlayerExperienceInfoResource:: (8 methods):
  setCurrentExperiencePoints()
  getCurrentExperiencePoints()
  setCurrentLevel()
  getCurrentLevel()
  setLastLevelUpTimestampMillis()
  getLastLevelUpTimestampMillis()
  setNextLevel()
  getNextLevel()

Google_Service_GamesManagement_GamesPlayerLevelResource:: (6 methods):
  setLevel()
  getLevel()
  setMaxExperiencePoints()
  getMaxExperiencePoints()
  setMinExperiencePoints()
  getMinExperiencePoints()

Google_Service_GamesManagement_HiddenPlayer:: (6 methods):
  setHiddenTimeMillis()
  getHiddenTimeMillis()
  setKind()
  getKind()
  setPlayer()
  getPlayer()

Google_Service_GamesManagement_HiddenPlayerList:: (6 methods):
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()

Google_Service_GamesManagement_Player:: (20 methods):
  setAvatarImageUrl()
  getAvatarImageUrl()
  setBannerUrlLandscape()
  getBannerUrlLandscape()
  setBannerUrlPortrait()
  getBannerUrlPortrait()
  setDisplayName()
  getDisplayName()
  setExperienceInfo()
  getExperienceInfo()
  setKind()
  getKind()
  setLastPlayedWith()
  getLastPlayedWith()
  setName()
  getName()
  setPlayerId()
  getPlayerId()
  setTitle()
  getTitle()

Google_Service_GamesManagement_PlayerName:: (4 methods):
  setFamilyName()
  getFamilyName()
  setGivenName()
  getGivenName()

Google_Service_GamesManagement_PlayerScoreResetAllResponse:: (4 methods):
  setKind()
  getKind()
  setResults()
  getResults()

Google_Service_GamesManagement_PlayerScoreResetResponse:: (6 methods):
  setDefinitionId()
  getDefinitionId()
  setKind()
  getKind()
  setResetScoreTimeSpans()
  getResetScoreTimeSpans()

Google_Service_GamesManagement_QuestsResetMultipleForAllRequest:: (4 methods):
  setKind()
  getKind()
  setQuestIds()
  getQuestIds()

Google_Service_GamesManagement_ScoresResetMultipleForAllRequest:: (4 methods):
  setKind()
  getKind()
  setLeaderboardIds()
  getLeaderboardIds()


Class: Google_Service_GamesManagement  - X-Ref

Service definition for GamesManagement (v1management).

<p>
The Management API for Google Play Game Services.</p>

<p>
For more information about this service, see the API
<a href="https://developers.google.com/games/services" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client)   X-Ref
Constructs the internal representation of the GamesManagement service.

param: Google_Client $client

Class: Google_Service_GamesManagement_Achievements_Resource  - X-Ref

The "achievements" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$achievements = $gamesManagementService->achievements;
</code>

reset($achievementId, $optParams = array()   X-Ref
Resets the achievement with the given ID for the currently authenticated
player. This method is only accessible to whitelisted tester accounts for
your application. (achievements.reset)

param: string $achievementId The ID of the achievement used by this method.
param: array $optParams Optional parameters.
return: Google_Service_GamesManagement_AchievementResetResponse

resetAll($optParams = array()   X-Ref
Resets all achievements for the currently authenticated player for your
application. This method is only accessible to whitelisted tester accounts
for your application. (achievements.resetAll)

param: array $optParams Optional parameters.
return: Google_Service_GamesManagement_AchievementResetAllResponse

resetAllForAllPlayers($optParams = array()   X-Ref
Resets all draft achievements for all players. This method is only available
to user accounts for your developer console.
(achievements.resetAllForAllPlayers)

param: array $optParams Optional parameters.

resetForAllPlayers($achievementId, $optParams = array()   X-Ref
Resets the achievement with the given ID for all players. This method is only
available to user accounts for your developer console. Only draft
achievements can be reset. (achievements.resetForAllPlayers)

param: string $achievementId The ID of the achievement used by this method.
param: array $optParams Optional parameters.

resetMultipleForAllPlayers(Google_Service_GamesManagement_AchievementResetMultipleForAllRequest $postBody, $optParams = array()   X-Ref
Resets achievements with the given IDs for all players. This method is only
available to user accounts for your developer console. Only draft
achievements may be reset. (achievements.resetMultipleForAllPlayers)

param: Google_AchievementResetMultipleForAllRequest $postBody
param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_Applications_Resource  - X-Ref

The "applications" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$applications = $gamesManagementService->applications;
</code>

listHidden($applicationId, $optParams = array()   X-Ref
Get the list of players hidden from the given application. This method is
only available to user accounts for your developer console.
(applications.listHidden)

param: string $applicationId The application ID from the Google Play
param: array $optParams Optional parameters.
return: Google_Service_GamesManagement_HiddenPlayerList

Class: Google_Service_GamesManagement_Events_Resource  - X-Ref

The "events" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$events = $gamesManagementService->events;
</code>

reset($eventId, $optParams = array()   X-Ref
Resets all player progress on the event with the given ID for the currently
authenticated player. This method is only accessible to whitelisted tester
accounts for your application. All quests for this player that use the event
will also be reset. (events.reset)

param: string $eventId The ID of the event.
param: array $optParams Optional parameters.

resetAll($optParams = array()   X-Ref
Resets all player progress on all events for the currently authenticated
player. This method is only accessible to whitelisted tester accounts for
your application. All quests for this player will also be reset.
(events.resetAll)

param: array $optParams Optional parameters.

resetAllForAllPlayers($optParams = array()   X-Ref
Resets all draft events for all players. This method is only available to
user accounts for your developer console. All quests that use any of these
events will also be reset. (events.resetAllForAllPlayers)

param: array $optParams Optional parameters.

resetForAllPlayers($eventId, $optParams = array()   X-Ref
Resets the event with the given ID for all players. This method is only
available to user accounts for your developer console. Only draft events can
be reset. All quests that use the event will also be reset.
(events.resetForAllPlayers)

param: string $eventId The ID of the event.
param: array $optParams Optional parameters.

resetMultipleForAllPlayers(Google_Service_GamesManagement_EventsResetMultipleForAllRequest $postBody, $optParams = array()   X-Ref
Resets events with the given IDs for all players. This method is only
available to user accounts for your developer console. Only draft events may
be reset. All quests that use any of the events will also be reset.
(events.resetMultipleForAllPlayers)

param: Google_EventsResetMultipleForAllRequest $postBody
param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_Players_Resource  - X-Ref

The "players" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$players = $gamesManagementService->players;
</code>

hide($applicationId, $playerId, $optParams = array()   X-Ref
Hide the given player's leaderboard scores from the given application. This
method is only available to user accounts for your developer console.
(players.hide)

param: string $applicationId The application ID from the Google Play
param: string $playerId A player ID. A value of me may be used in place of
param: array $optParams Optional parameters.

unhide($applicationId, $playerId, $optParams = array()   X-Ref
Unhide the given player's leaderboard scores from the given application. This
method is only available to user accounts for your developer console.
(players.unhide)

param: string $applicationId The application ID from the Google Play
param: string $playerId A player ID. A value of me may be used in place of
param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_Quests_Resource  - X-Ref

The "quests" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$quests = $gamesManagementService->quests;
</code>

reset($questId, $optParams = array()   X-Ref
Resets all player progress on the quest with the given ID for the currently
authenticated player. This method is only accessible to whitelisted tester
accounts for your application. (quests.reset)

param: string $questId The ID of the quest.
param: array $optParams Optional parameters.

resetAll($optParams = array()   X-Ref
Resets all player progress on all quests for the currently authenticated
player. This method is only accessible to whitelisted tester accounts for
your application. (quests.resetAll)

param: array $optParams Optional parameters.

resetAllForAllPlayers($optParams = array()   X-Ref
Resets all draft quests for all players. This method is only available to
user accounts for your developer console. (quests.resetAllForAllPlayers)

param: array $optParams Optional parameters.

resetForAllPlayers($questId, $optParams = array()   X-Ref
Resets all player progress on the quest with the given ID for all players.
This method is only available to user accounts for your developer console.
Only draft quests can be reset. (quests.resetForAllPlayers)

param: string $questId The ID of the quest.
param: array $optParams Optional parameters.

resetMultipleForAllPlayers(Google_Service_GamesManagement_QuestsResetMultipleForAllRequest $postBody, $optParams = array()   X-Ref
Resets quests with the given IDs for all players. This method is only
available to user accounts for your developer console. Only draft quests may
be reset. (quests.resetMultipleForAllPlayers)

param: Google_QuestsResetMultipleForAllRequest $postBody
param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_Rooms_Resource  - X-Ref

The "rooms" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$rooms = $gamesManagementService->rooms;
</code>

reset($optParams = array()   X-Ref
Reset all rooms for the currently authenticated player for your application.
This method is only accessible to whitelisted tester accounts for your
application. (rooms.reset)

param: array $optParams Optional parameters.

resetForAllPlayers($optParams = array()   X-Ref
Deletes rooms where the only room participants are from whitelisted tester
accounts for your application. This method is only available to user accounts
for your developer console. (rooms.resetForAllPlayers)

param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_Scores_Resource  - X-Ref

The "scores" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$scores = $gamesManagementService->scores;
</code>

reset($leaderboardId, $optParams = array()   X-Ref
Resets scores for the leaderboard with the given ID for the currently
authenticated player. This method is only accessible to whitelisted tester
accounts for your application. (scores.reset)

param: string $leaderboardId The ID of the leaderboard.
param: array $optParams Optional parameters.
return: Google_Service_GamesManagement_PlayerScoreResetResponse

resetAll($optParams = array()   X-Ref
Resets all scores for all leaderboards for the currently authenticated
players. This method is only accessible to whitelisted tester accounts for
your application. (scores.resetAll)

param: array $optParams Optional parameters.
return: Google_Service_GamesManagement_PlayerScoreResetAllResponse

resetAllForAllPlayers($optParams = array()   X-Ref
Resets scores for all draft leaderboards for all players. This method is only
available to user accounts for your developer console.
(scores.resetAllForAllPlayers)

param: array $optParams Optional parameters.

resetForAllPlayers($leaderboardId, $optParams = array()   X-Ref
Resets scores for the leaderboard with the given ID for all players. This
method is only available to user accounts for your developer console. Only
draft leaderboards can be reset. (scores.resetForAllPlayers)

param: string $leaderboardId The ID of the leaderboard.
param: array $optParams Optional parameters.

resetMultipleForAllPlayers(Google_Service_GamesManagement_ScoresResetMultipleForAllRequest $postBody, $optParams = array()   X-Ref
Resets scores for the leaderboards with the given IDs for all players. This
method is only available to user accounts for your developer console. Only
draft leaderboards may be reset. (scores.resetMultipleForAllPlayers)

param: Google_ScoresResetMultipleForAllRequest $postBody
param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_TurnBasedMatches_Resource  - X-Ref

The "turnBasedMatches" collection of methods.
Typical usage is:
<code>
$gamesManagementService = new Google_Service_GamesManagement(...);
$turnBasedMatches = $gamesManagementService->turnBasedMatches;
</code>

reset($optParams = array()   X-Ref
Reset all turn-based match data for a user. This method is only accessible to
whitelisted tester accounts for your application. (turnBasedMatches.reset)

param: array $optParams Optional parameters.

resetForAllPlayers($optParams = array()   X-Ref
Deletes turn-based matches where the only match participants are from
whitelisted tester accounts for your application. This method is only
available to user accounts for your developer console.
(turnBasedMatches.resetForAllPlayers)

param: array $optParams Optional parameters.

Class: Google_Service_GamesManagement_AchievementResetAllResponse  - X-Ref

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setResults($results)   X-Ref
No description

getResults()   X-Ref
No description

Class: Google_Service_GamesManagement_AchievementResetResponse  - X-Ref

setCurrentState($currentState)   X-Ref
No description

getCurrentState()   X-Ref
No description

setDefinitionId($definitionId)   X-Ref
No description

getDefinitionId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setUpdateOccurred($updateOccurred)   X-Ref
No description

getUpdateOccurred()   X-Ref
No description

Class: Google_Service_GamesManagement_EventsResetMultipleForAllRequest  - X-Ref

setEventIds($eventIds)   X-Ref
No description

getEventIds()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

Class: Google_Service_GamesManagement_GamesPlayedResource  - X-Ref

setAutoMatched($autoMatched)   X-Ref
No description

getAutoMatched()   X-Ref
No description

setTimeMillis($timeMillis)   X-Ref
No description

getTimeMillis()   X-Ref
No description

Class: Google_Service_GamesManagement_GamesPlayerExperienceInfoResource  - X-Ref

setCurrentExperiencePoints($currentExperiencePoints)   X-Ref
No description

getCurrentExperiencePoints()   X-Ref
No description

setCurrentLevel(Google_Service_GamesManagement_GamesPlayerLevelResource $currentLevel)   X-Ref
No description

getCurrentLevel()   X-Ref
No description

setLastLevelUpTimestampMillis($lastLevelUpTimestampMillis)   X-Ref
No description

getLastLevelUpTimestampMillis()   X-Ref
No description

setNextLevel(Google_Service_GamesManagement_GamesPlayerLevelResource $nextLevel)   X-Ref
No description

getNextLevel()   X-Ref
No description

Class: Google_Service_GamesManagement_HiddenPlayer  - X-Ref

setHiddenTimeMillis($hiddenTimeMillis)   X-Ref
No description

getHiddenTimeMillis()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setPlayer(Google_Service_GamesManagement_Player $player)   X-Ref
No description

getPlayer()   X-Ref
No description

Class: Google_Service_GamesManagement_HiddenPlayerList  - X-Ref

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description

Class: Google_Service_GamesManagement_Player  - X-Ref

setAvatarImageUrl($avatarImageUrl)   X-Ref
No description

getAvatarImageUrl()   X-Ref
No description

setBannerUrlLandscape($bannerUrlLandscape)   X-Ref
No description

getBannerUrlLandscape()   X-Ref
No description

setBannerUrlPortrait($bannerUrlPortrait)   X-Ref
No description

getBannerUrlPortrait()   X-Ref
No description

setDisplayName($displayName)   X-Ref
No description

getDisplayName()   X-Ref
No description

setExperienceInfo(Google_Service_GamesManagement_GamesPlayerExperienceInfoResource $experienceInfo)   X-Ref
No description

getExperienceInfo()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setLastPlayedWith(Google_Service_GamesManagement_GamesPlayedResource $lastPlayedWith)   X-Ref
No description

getLastPlayedWith()   X-Ref
No description

setName(Google_Service_GamesManagement_PlayerName $name)   X-Ref
No description

getName()   X-Ref
No description

setPlayerId($playerId)   X-Ref
No description

getPlayerId()   X-Ref
No description

setTitle($title)   X-Ref
No description

getTitle()   X-Ref
No description

Class: Google_Service_GamesManagement_PlayerName  - X-Ref

setFamilyName($familyName)   X-Ref
No description

getFamilyName()   X-Ref
No description

setGivenName($givenName)   X-Ref
No description

getGivenName()   X-Ref
No description

Class: Google_Service_GamesManagement_PlayerScoreResetAllResponse  - X-Ref

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setResults($results)   X-Ref
No description

getResults()   X-Ref
No description

Class: Google_Service_GamesManagement_PlayerScoreResetResponse  - X-Ref

setDefinitionId($definitionId)   X-Ref
No description

getDefinitionId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setResetScoreTimeSpans($resetScoreTimeSpans)   X-Ref
No description

getResetScoreTimeSpans()   X-Ref
No description

Class: Google_Service_GamesManagement_QuestsResetMultipleForAllRequest  - X-Ref

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setQuestIds($questIds)   X-Ref
No description

getQuestIds()   X-Ref
No description

Class: Google_Service_GamesManagement_ScoresResetMultipleForAllRequest  - X-Ref

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setLeaderboardIds($leaderboardIds)   X-Ref
No description

getLeaderboardIds()   X-Ref
No description