John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.leaderboards.html">leaderboards</a></h1> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(leaderboardId, language=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Retrieves the metadata of the leaderboard with the given ID.</p> |
| 83 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Lists all the leaderboard metadata for your application.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code class="details" id="get">get(leaderboardId, language=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 97 | <pre>Retrieves the metadata of the leaderboard with the given ID. |
| 98 | |
| 99 | Args: |
| 100 | leaderboardId: string, The ID of the leaderboard. (required) |
| 101 | language: string, The preferred language to use for strings returned by this method. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 110 | { # The Leaderboard resource. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "iconUrl": "A String", # The icon for the leaderboard. |
| 112 | "id": "A String", # The leaderboard ID. |
| 113 | "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided. |
| 114 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`. |
| 115 | "name": "A String", # The name of the leaderboard. |
| 116 | "order": "A String", # How scores are ordered. |
| 117 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | </div> |
| 119 | |
| 120 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 121 | <code class="details" id="list">list(language=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 122 | <pre>Lists all the leaderboard metadata for your application. |
| 123 | |
| 124 | Args: |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 125 | language: string, The preferred language to use for strings returned by this method. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 126 | maxResults: integer, The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified `maxResults`. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 127 | pageToken: string, The token returned by the previous request. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 128 | x__xgafv: string, V1 error format. |
| 129 | Allowed values |
| 130 | 1 - v1 error format |
| 131 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 132 | |
| 133 | Returns: |
| 134 | An object of the form: |
| 135 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 136 | { # A list of leaderboard objects. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 137 | "items": [ # The leaderboards. |
| 138 | { # The Leaderboard resource. |
| 139 | "iconUrl": "A String", # The icon for the leaderboard. |
| 140 | "id": "A String", # The leaderboard ID. |
| 141 | "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided. |
| 142 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`. |
| 143 | "name": "A String", # The name of the leaderboard. |
| 144 | "order": "A String", # How scores are ordered. |
| 145 | }, |
| 146 | ], |
| 147 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardListResponse`. |
| 148 | "nextPageToken": "A String", # Token corresponding to the next page of results. |
| 149 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
| 153 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 154 | <pre>Retrieves the next page of results. |
| 155 | |
| 156 | Args: |
| 157 | previous_request: The request for the previous page. (required) |
| 158 | previous_response: The response from the request for the previous page. (required) |
| 159 | |
| 160 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | A request object that you can call 'execute()' on to request the next |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 162 | page. Returns None if there are no more items in the collection. |
| 163 | </pre> |
| 164 | </div> |
| 165 | |
| 166 | </body></html> |