Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / games_v1.achievementDefinitions.html
blob: 64c4dcb3289db3417696173fa03603d488f7259a [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.achievementDefinitions.html">achievementDefinitions</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="#list">list(maxResults=None, pageToken=None, language=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]79<p class="firstline">Lists all the achievement definitions for your application.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85 <code class="details" id="list">list(maxResults=None, pageToken=None, language=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86 <pre>Lists all the achievement definitions for your application.
87
88Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]89 maxResults: integer, The maximum number of achievement resources to return in the response, used
90for paging. For any response, the actual number of achievement resources
91returned may be less than the specified `maxResults`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 pageToken: string, The token returned by the previous request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 language: string, The preferred language to use for strings returned by this method.
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 { # A list of achievement definition objects.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 &quot;items&quot;: [ # The achievement definitions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]104 { # An achievement definition object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;name&quot;: &quot;A String&quot;, # The name of the achievement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 &quot;description&quot;: &quot;A String&quot;, # The description of the achievement.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;unlockedIconUrl&quot;: &quot;A String&quot;, # The image URL for the unlocked achievement icon.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 &quot;totalSteps&quot;: 42, # The total steps for an incremental achievement.
109 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
110 # string `games#achievementDefinition`.
111 &quot;initialState&quot;: &quot;A String&quot;, # The initial state of the achievement.
112 &quot;achievementType&quot;: &quot;A String&quot;, # The type of the achievement.
113 &quot;experiencePoints&quot;: &quot;A String&quot;, # Experience points which will be earned when unlocking this achievement.
114 &quot;isRevealedIconUrlDefault&quot;: True or False, # Indicates whether the revealed icon image being returned is a default
115 # image, or is provided by the game.
116 &quot;revealedIconUrl&quot;: &quot;A String&quot;, # The image URL for the revealed achievement icon.
117 &quot;isUnlockedIconUrlDefault&quot;: True or False, # Indicates whether the unlocked icon image being returned is a default
118 # image, or is game-provided.
119 &quot;id&quot;: &quot;A String&quot;, # The ID of the achievement.
120 &quot;formattedTotalSteps&quot;: &quot;A String&quot;, # The total steps for an incremental achievement as a string.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 },
122 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
124 # string `games#achievementDefinitionsListResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &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]126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
131 <pre>Retrieves the next page of results.
132
133Args:
134 previous_request: The request for the previous page. (required)
135 previous_response: The response from the request for the previous page. (required)
136
137Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 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]139 page. Returns None if there are no more items in the collection.
140 </pre>
141</div>
142
143</body></html>