Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / games_v1.leaderboards.html
blob: a320ef968f5ef7414683887d6d3fa741a26c0b27 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Kimd059ad82020-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#get">get(leaderboardId, language=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]79<p class="firstline">Retrieves the metadata of the leaderboard with the given ID.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#list">list(pageToken=None, language=None, maxResults=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Lists all the leaderboard metadata for your application.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]88 <code class="details" id="get">get(leaderboardId, language=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89 <pre>Retrieves the metadata of the leaderboard with the given ID.
90
91Args:
92 leaderboardId: string, The ID of the leaderboard. (required)
93 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98
99Returns:
100 An object of the form:
101
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 { # The Leaderboard resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 &quot;iconUrl&quot;: &quot;A String&quot;, # The icon for the leaderboard.
104 &quot;id&quot;: &quot;A String&quot;, # The leaderboard ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]105 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
106 # string `games#leaderboard`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;name&quot;: &quot;A String&quot;, # The name of the leaderboard.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]108 &quot;isIconUrlDefault&quot;: True or False, # Indicates whether the icon image being returned is a default image, or is
109 # game-provided.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;order&quot;: &quot;A String&quot;, # How scores are ordered.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 }</pre>
112</div>
113
114<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]115 <code class="details" id="list">list(pageToken=None, language=None, maxResults=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116 <pre>Lists all the leaderboard metadata for your application.
117
118Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 pageToken: string, The token returned by the previous request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]120 language: string, The preferred language to use for strings returned by this method.
121 maxResults: integer, The maximum number of leaderboards to return in the response. For any
122response, the actual number of leaderboards returned may be less than the
123specified `maxResults`.
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128
129Returns:
130 An object of the form:
131
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]132 { # A list of leaderboard objects.
133 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
134 # string `games#leaderboardListResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;items&quot;: [ # The leaderboards.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]136 { # The Leaderboard resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;iconUrl&quot;: &quot;A String&quot;, # The icon for the leaderboard.
138 &quot;id&quot;: &quot;A String&quot;, # The leaderboard ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]139 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
140 # string `games#leaderboard`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;name&quot;: &quot;A String&quot;, # The name of the leaderboard.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]142 &quot;isIconUrlDefault&quot;: True or False, # Indicates whether the icon image being returned is a default image, or is
143 # game-provided.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;order&quot;: &quot;A String&quot;, # How scores are ordered.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 },
146 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token corresponding to the next page of results.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
153 <pre>Retrieves the next page of results.
154
155Args:
156 previous_request: The request for the previous page. (required)
157 previous_response: The response from the request for the previous page. (required)
158
159Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 page. Returns None if there are no more items in the collection.
162 </pre>
163</div>
164
165</body></html>