| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.scores.html">scores</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(playerId, leaderboardId, timeSpan, maxResults=None, language=None, includeRankType=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get high scores, and optionally ranks, in leaderboards for the currently</p> |
| <p class="toc_element"> |
| <code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(leaderboardId, collection, timeSpan, pageToken=None, language=None, maxResults=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the scores in a leaderboard, starting from the top.</p> |
| <p class="toc_element"> |
| <code><a href="#listWindow">listWindow(leaderboardId, collection, timeSpan, returnTopIfAbsent=None, resultsAbove=None, pageToken=None, language=None, maxResults=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the scores in a leaderboard around (and including) a player's score.</p> |
| <p class="toc_element"> |
| <code><a href="#listWindow_next">listWindow_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#submit">submit(leaderboardId, score, scoreTag=None, language=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Submits a score to the specified leaderboard.</p> |
| <p class="toc_element"> |
| <code><a href="#submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Submits multiple scores to leaderboards.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(playerId, leaderboardId, timeSpan, maxResults=None, language=None, includeRankType=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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'. |
| |
| Args: |
| playerId: string, A player ID. A value of `me` may be used in place of the |
| authenticated player's ID. (required) |
| leaderboardId: string, The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all |
| leaderboards for this application. (required) |
| timeSpan: string, The time span for the scores and ranks you're requesting. (required) |
| maxResults: integer, 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`. |
| language: string, The preferred language to use for strings returned by this method. |
| includeRankType: string, The types of ranks to return. If the parameter is omitted, no ranks will be |
| returned. |
| pageToken: string, The token returned by the previous request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of player leaderboard scores. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLeaderboardScoreListResponse`. |
| "items": [ # The leaderboard scores. |
| { # A player leaderboard score object. |
| "timeSpan": "A String", # The time span of this score. |
| "scoreValue": "A String", # The numerical value of this score. |
| "scoreTag": "A String", # Additional information about the score. Values must contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "publicRank": { # A score rank in a leaderboard. # The public rank of the score in this leaderboard. This object will not be |
| # present if the user is not sharing their scores publicly. |
| "formattedNumScores": "A String", # The number of scores in the leaderboard as a string. |
| "rank": "A String", # The rank in the leaderboard. |
| "numScores": "A String", # The number of scores in the leaderboard. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardScoreRank`. |
| "formattedRank": "A String", # The rank in the leaderboard as a string. |
| }, |
| "leaderboard_id": "A String", # The ID of the leaderboard this score is in. |
| "writeTimestamp": "A String", # The timestamp at which this score was recorded, in milliseconds since the |
| # epoch in UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLeaderboardScore`. |
| "scoreString": "A String", # The formatted value of this score. |
| "socialRank": { # A score rank in a leaderboard. # The social rank of the score in this leaderboard. |
| "formattedNumScores": "A String", # The number of scores in the leaderboard as a string. |
| "rank": "A String", # The rank in the leaderboard. |
| "numScores": "A String", # The number of scores in the leaderboard. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardScoreRank`. |
| "formattedRank": "A String", # The rank in the leaderboard as a string. |
| }, |
| }, |
| ], |
| "player": { # A Player resource. # The Player resources for the owner of this score. |
| "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| "title": "A String", # The player's title rewarded for their game activities. |
| "displayName": "A String", # The name to display for the player. |
| "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile |
| # is visible to other players. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#profileSettings`. |
| "friendsListVisibility": "A String", |
| "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player. |
| }, |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#player` |
| "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is |
| # unset if the player is not sharing their friends list with the game. |
| "name": { # A representation of the individual components of the name. |
| "familyName": "A String", # The family name of this player. In some places, this is known as the last |
| # name. |
| "givenName": "A String", # The given name of this player. In some places, this is known as the first |
| # name. |
| }, |
| "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, |
| # this should be same as the current level. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch |
| # UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerExperienceInfo`. |
| }, |
| "playerId": "A String", # The ID of the player. |
| "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into |
| # the game in question. This is only populated for calls to player.get for |
| # the requesting player, only if the player ID has subsequently changed, and |
| # only to clients that support remapping player IDs. |
| }, |
| "nextPageToken": "A String", # The pagination token for the next page of results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get_next">get_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(leaderboardId, collection, timeSpan, pageToken=None, language=None, maxResults=None, x__xgafv=None)</code> |
| <pre>Lists the scores in a leaderboard, starting from the top. |
| |
| Args: |
| leaderboardId: string, The ID of the leaderboard. (required) |
| collection: string, The collection of scores you're requesting. (required) |
| timeSpan: string, The time span for the scores and ranks you're requesting. (required) |
| pageToken: string, The token returned by the previous request. |
| language: string, The preferred language to use for strings returned by this method. |
| maxResults: integer, 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`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A ListScores response. |
| "numScores": "A String", # The total number of scores in the leaderboard. |
| "nextPageToken": "A String", # The pagination token for the next page of results. |
| "items": [ # The scores in the leaderboard. |
| { # The Leaderboard Entry resource. |
| "player": { # A Player resource. # The player who holds this score. |
| "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| "title": "A String", # The player's title rewarded for their game activities. |
| "displayName": "A String", # The name to display for the player. |
| "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile |
| # is visible to other players. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#profileSettings`. |
| "friendsListVisibility": "A String", |
| "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player. |
| }, |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#player` |
| "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is |
| # unset if the player is not sharing their friends list with the game. |
| "name": { # A representation of the individual components of the name. |
| "familyName": "A String", # The family name of this player. In some places, this is known as the last |
| # name. |
| "givenName": "A String", # The given name of this player. In some places, this is known as the first |
| # name. |
| }, |
| "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, |
| # this should be same as the current level. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch |
| # UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerExperienceInfo`. |
| }, |
| "playerId": "A String", # The ID of the player. |
| "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into |
| # the game in question. This is only populated for calls to player.get for |
| # the requesting player, only if the player ID has subsequently changed, and |
| # only to clients that support remapping player IDs. |
| }, |
| "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the |
| # epoch in UTC. |
| "scoreRank": "A String", # The rank of this score for this leaderboard. |
| "scoreTag": "A String", # Additional information about the score. Values must contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. |
| "formattedScore": "A String", # The localized string for the numerical value of this score. |
| "timeSpan": "A String", # The time span of this high score. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardEntry`. |
| "scoreValue": "A String", # The numerical value of this score. |
| }, |
| ], |
| "playerScore": { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score |
| # may appear both here and in the list of scores above. If you are viewing a |
| # public leaderboard and the player is not sharing their gameplay information |
| # publicly, the `scoreRank`and `formattedScoreRank` |
| # values will not be present. |
| "player": { # A Player resource. # The player who holds this score. |
| "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| "title": "A String", # The player's title rewarded for their game activities. |
| "displayName": "A String", # The name to display for the player. |
| "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile |
| # is visible to other players. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#profileSettings`. |
| "friendsListVisibility": "A String", |
| "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player. |
| }, |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#player` |
| "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is |
| # unset if the player is not sharing their friends list with the game. |
| "name": { # A representation of the individual components of the name. |
| "familyName": "A String", # The family name of this player. In some places, this is known as the last |
| # name. |
| "givenName": "A String", # The given name of this player. In some places, this is known as the first |
| # name. |
| }, |
| "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, |
| # this should be same as the current level. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch |
| # UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerExperienceInfo`. |
| }, |
| "playerId": "A String", # The ID of the player. |
| "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into |
| # the game in question. This is only populated for calls to player.get for |
| # the requesting player, only if the player ID has subsequently changed, and |
| # only to clients that support remapping player IDs. |
| }, |
| "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the |
| # epoch in UTC. |
| "scoreRank": "A String", # The rank of this score for this leaderboard. |
| "scoreTag": "A String", # Additional information about the score. Values must contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. |
| "formattedScore": "A String", # The localized string for the numerical value of this score. |
| "timeSpan": "A String", # The time span of this high score. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardEntry`. |
| "scoreValue": "A String", # The numerical value of this score. |
| }, |
| "prevPageToken": "A String", # The pagination token for the previous page of results. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardScores`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listWindow">listWindow(leaderboardId, collection, timeSpan, returnTopIfAbsent=None, resultsAbove=None, pageToken=None, language=None, maxResults=None, x__xgafv=None)</code> |
| <pre>Lists the scores in a leaderboard around (and including) a player's score. |
| |
| Args: |
| leaderboardId: string, The ID of the leaderboard. (required) |
| collection: string, The collection of scores you're requesting. (required) |
| timeSpan: string, The time span for the scores and ranks you're requesting. (required) |
| returnTopIfAbsent: boolean, True if the top scores should be returned when the player is not in the |
| leaderboard. Defaults to true. |
| resultsAbove: integer, The preferred number of scores to return above the player's score. More |
| scores may be returned if the player is at the bottom of the leaderboard; |
| fewer may be returned if the player is at the top. Must be less than or |
| equal to maxResults. |
| pageToken: string, The token returned by the previous request. |
| language: string, The preferred language to use for strings returned by this method. |
| maxResults: integer, 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`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A ListScores response. |
| "numScores": "A String", # The total number of scores in the leaderboard. |
| "nextPageToken": "A String", # The pagination token for the next page of results. |
| "items": [ # The scores in the leaderboard. |
| { # The Leaderboard Entry resource. |
| "player": { # A Player resource. # The player who holds this score. |
| "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| "title": "A String", # The player's title rewarded for their game activities. |
| "displayName": "A String", # The name to display for the player. |
| "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile |
| # is visible to other players. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#profileSettings`. |
| "friendsListVisibility": "A String", |
| "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player. |
| }, |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#player` |
| "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is |
| # unset if the player is not sharing their friends list with the game. |
| "name": { # A representation of the individual components of the name. |
| "familyName": "A String", # The family name of this player. In some places, this is known as the last |
| # name. |
| "givenName": "A String", # The given name of this player. In some places, this is known as the first |
| # name. |
| }, |
| "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, |
| # this should be same as the current level. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch |
| # UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerExperienceInfo`. |
| }, |
| "playerId": "A String", # The ID of the player. |
| "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into |
| # the game in question. This is only populated for calls to player.get for |
| # the requesting player, only if the player ID has subsequently changed, and |
| # only to clients that support remapping player IDs. |
| }, |
| "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the |
| # epoch in UTC. |
| "scoreRank": "A String", # The rank of this score for this leaderboard. |
| "scoreTag": "A String", # Additional information about the score. Values must contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. |
| "formattedScore": "A String", # The localized string for the numerical value of this score. |
| "timeSpan": "A String", # The time span of this high score. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardEntry`. |
| "scoreValue": "A String", # The numerical value of this score. |
| }, |
| ], |
| "playerScore": { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score |
| # may appear both here and in the list of scores above. If you are viewing a |
| # public leaderboard and the player is not sharing their gameplay information |
| # publicly, the `scoreRank`and `formattedScoreRank` |
| # values will not be present. |
| "player": { # A Player resource. # The player who holds this score. |
| "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| "title": "A String", # The player's title rewarded for their game activities. |
| "displayName": "A String", # The name to display for the player. |
| "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile |
| # is visible to other players. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#profileSettings`. |
| "friendsListVisibility": "A String", |
| "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player. |
| }, |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#player` |
| "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is |
| # unset if the player is not sharing their friends list with the game. |
| "name": { # A representation of the individual components of the name. |
| "familyName": "A String", # The family name of this player. In some places, this is known as the last |
| # name. |
| "givenName": "A String", # The given name of this player. In some places, this is known as the first |
| # name. |
| }, |
| "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, |
| # this should be same as the current level. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player. |
| "minExperiencePoints": "A String", # The minimum experience points for this level. |
| "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| "level": 42, # The level for the user. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerLevel`. |
| }, |
| "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch |
| # UTC. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerExperienceInfo`. |
| }, |
| "playerId": "A String", # The ID of the player. |
| "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into |
| # the game in question. This is only populated for calls to player.get for |
| # the requesting player, only if the player ID has subsequently changed, and |
| # only to clients that support remapping player IDs. |
| }, |
| "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the |
| # epoch in UTC. |
| "scoreRank": "A String", # The rank of this score for this leaderboard. |
| "scoreTag": "A String", # Additional information about the score. Values must contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. |
| "formattedScore": "A String", # The localized string for the numerical value of this score. |
| "timeSpan": "A String", # The time span of this high score. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardEntry`. |
| "scoreValue": "A String", # The numerical value of this score. |
| }, |
| "prevPageToken": "A String", # The pagination token for the previous page of results. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#leaderboardScores`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listWindow_next">listWindow_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="submit">submit(leaderboardId, score, scoreTag=None, language=None, x__xgafv=None)</code> |
| <pre>Submits a score to the specified leaderboard. |
| |
| Args: |
| leaderboardId: string, The ID of the leaderboard. (required) |
| score: string, The score you're submitting. The submitted score is ignored if it is worse |
| than a previously submitted score, where worse depends on the leaderboard |
| sort order. The meaning of the score value depends on the leaderboard |
| format type. For fixed-point, the score represents the raw value. For |
| time, the score represents elapsed time in milliseconds. For currency, the |
| score represents a value in micro units. (required) |
| scoreTag: string, Additional information about the score you're submitting. Values must |
| contain no more than 64 URI-safe characters as defined by section 2.3 of |
| RFC 3986. |
| language: string, The preferred language to use for strings returned by this method. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of leaderboard entry resources. |
| "formattedScore": "A String", # The formatted value of the submitted score. |
| "leaderboardId": "A String", # The leaderboard ID that this score was submitted to. |
| "beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score |
| # for that time span. |
| "A String", |
| ], |
| "unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the |
| # submitted score may be better than the |
| # player's `DAILY` score, but not better than the player's scores |
| # for the `WEEKLY` or `ALL_TIME` time spans. |
| { # A player score. |
| "timeSpan": "A String", # The time span for this player score. |
| "scoreTag": "A String", # Additional information about this score. Values will contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScore`. |
| "score": "A String", # The numerical value for this player score. |
| "formattedScore": "A String", # The formatted score for this player score. |
| }, |
| ], |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScoreResponse`. |
| "scoreTag": "A String", # Additional information about this score. Values will contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</code> |
| <pre>Submits multiple scores to leaderboards. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A list of score submission requests. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScoreSubmissionList`. |
| "scores": [ # The score submissions. |
| { # A request to submit a score to leaderboards. |
| "leaderboardId": "A String", # The leaderboard this score is being submitted to. |
| "signature": "A String", # Signature Values will contain URI-safe characters as defined by section 2.3 |
| # of RFC 3986. |
| "score": "A String", # The new score being submitted. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#scoreSubmission`. |
| "scoreTag": "A String", # Additional information about this score. Values will contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| }, |
| ], |
| } |
| |
| language: string, The preferred language to use for strings returned by this method. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of score submission statuses. |
| "submittedScores": [ # The score submissions statuses. |
| { # A list of leaderboard entry resources. |
| "formattedScore": "A String", # The formatted value of the submitted score. |
| "leaderboardId": "A String", # The leaderboard ID that this score was submitted to. |
| "beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score |
| # for that time span. |
| "A String", |
| ], |
| "unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the |
| # submitted score may be better than the |
| # player's `DAILY` score, but not better than the player's scores |
| # for the `WEEKLY` or `ALL_TIME` time spans. |
| { # A player score. |
| "timeSpan": "A String", # The time span for this player score. |
| "scoreTag": "A String", # Additional information about this score. Values will contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScore`. |
| "score": "A String", # The numerical value for this player score. |
| "formattedScore": "A String", # The formatted score for this player score. |
| }, |
| ], |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScoreResponse`. |
| "scoreTag": "A String", # Additional information about this score. Values will contain no more than |
| # 64 URI-safe characters as defined by section 2.3 of RFC 3986. |
| }, |
| ], |
| "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| # string `games#playerScoreListResponse`. |
| }</pre> |
| </div> |
| |
| </body></html> |
