blob: b826107e3d9645f716d295946491fc333d266530 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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 -070075<h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.applications.html">applications</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080081 <code><a href="#get">get(applicationId, language=None, platformType=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified `platformType`, the returned response will not include any instance data.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080084 <code><a href="#getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a URL for the requested end point type.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#played">played(x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Indicate that the currently authenticated user is playing your application.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080089<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#verify">verify(applicationId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080099 <code class="details" id="get">get(applicationId, language=None, platformType=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 <pre>Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified `platformType`, the returned response will not include any instance data.
John Asmuth614db982014-04-24 15:46:26 -0400101
102Args:
Craig Citroe633be12015-03-02 13:40:36 -0800103 applicationId: string, The application ID from the Google Play developer console. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800104 language: string, The preferred language to use for strings returned by this method.
John Asmuth614db982014-04-24 15:46:26 -0400105 platformType: string, Restrict application details returned to the specific platform.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 Allowed values
107 PLATFORM_TYPE_UNSPECIFIED - Default value, don&#x27;t use.
108 ANDROID - Retrieve applications that can be played on Android.
109 IOS - Retrieve applications that can be played on iOS.
110 WEB_APP - Retrieve applications that can be played on desktop web.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400112 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700113 1 - v1 error format
114 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400115
116Returns:
117 An object of the form:
118
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 { # The Application resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;achievement_count&quot;: 42, # The number of achievements visible to the currently authenticated player.
121 &quot;assets&quot;: [ # The assets of the application.
122 { # An image asset object.
123 &quot;height&quot;: 42, # The height of the asset.
124 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
125 &quot;name&quot;: &quot;A String&quot;, # The name of the asset.
126 &quot;url&quot;: &quot;A String&quot;, # The URL of the asset.
127 &quot;width&quot;: 42, # The width of the asset.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800128 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800129 ],
130 &quot;author&quot;: &quot;A String&quot;, # The author of the application.
131 &quot;category&quot;: { # An application category object. # The category of the application.
132 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
133 &quot;primary&quot;: &quot;A String&quot;, # The primary category.
134 &quot;secondary&quot;: &quot;A String&quot;, # The secondary category.
135 },
136 &quot;description&quot;: &quot;A String&quot;, # The description of the application.
137 &quot;enabledFeatures&quot;: [ # A list of features that have been enabled for the application.
138 &quot;A String&quot;,
139 ],
140 &quot;id&quot;: &quot;A String&quot;, # The ID of the application.
141 &quot;instances&quot;: [ # The instances of the application.
142 { # The Instance resource.
143 &quot;acquisitionUri&quot;: &quot;A String&quot;, # URI which shows where a user can acquire this instance.
144 &quot;androidInstance&quot;: { # The Android instance details resource. # Platform dependent details for Android.
145 &quot;enablePiracyCheck&quot;: True or False, # Flag indicating whether the anti-piracy check is enabled.
146 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
147 &quot;packageName&quot;: &quot;A String&quot;, # Android package name which maps to Google Play URL.
148 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800149 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800150 &quot;iosInstance&quot;: { # The iOS details resource. # Platform dependent details for iOS.
151 &quot;bundleIdentifier&quot;: &quot;A String&quot;, # Bundle identifier.
152 &quot;itunesAppId&quot;: &quot;A String&quot;, # iTunes App ID.
153 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
154 &quot;preferredForIpad&quot;: True or False, # Indicates that this instance is the default for new installations on iPad devices.
155 &quot;preferredForIphone&quot;: True or False, # Indicates that this instance is the default for new installations on iPhone devices.
156 &quot;supportIpad&quot;: True or False, # Flag to indicate if this instance supports iPad.
157 &quot;supportIphone&quot;: True or False, # Flag to indicate if this instance supports iPhone.
158 },
159 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
160 &quot;name&quot;: &quot;A String&quot;, # Localized display name.
161 &quot;platformType&quot;: &quot;A String&quot;, # The platform type.
162 &quot;realtimePlay&quot;: True or False, # Flag to show if this game instance supports realtime play.
163 &quot;turnBasedPlay&quot;: True or False, # Flag to show if this game instance supports turn based play.
164 &quot;webInstance&quot;: { # The Web details resource. # Platform dependent details for Web.
165 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
166 &quot;launchUrl&quot;: &quot;A String&quot;, # Launch URL for the game.
167 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
168 },
169 },
170 ],
171 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
172 &quot;lastUpdatedTimestamp&quot;: &quot;A String&quot;, # The last updated timestamp of the application.
173 &quot;leaderboard_count&quot;: 42, # The number of leaderboards visible to the currently authenticated player.
174 &quot;name&quot;: &quot;A String&quot;, # The name of the application.
175 &quot;themeColor&quot;: &quot;A String&quot;, # A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. &quot;E0E0E0&quot;).
176}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400177</div>
178
179<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800180 <code class="details" id="getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</code>
181 <pre>Returns a URL for the requested end point type.
182
183Args:
184 applicationId: string, The application ID from the Google Play developer console.
185 endPointType: string, Type of endpoint being requested.
186 Allowed values
187 END_POINT_TYPE_UNSPECIFIED - Default value. This value is unused.
188 PROFILE_CREATION - Request a URL to create a new profile.
189 PROFILE_SETTINGS - Request a URL for the Settings view.
190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195Returns:
196 An object of the form:
197
198 { # Container for a URL end point of the requested type.
199 &quot;url&quot;: &quot;A String&quot;, # A URL suitable for loading in a web browser for the requested endpoint.
200}</pre>
201</div>
202
203<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204 <code class="details" id="played">played(x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700205 <pre>Indicate that the currently authenticated user is playing your application.
John Asmuth614db982014-04-24 15:46:26 -0400206
207Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700208 x__xgafv: string, V1 error format.
209 Allowed values
210 1 - v1 error format
211 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400212</pre>
213</div>
214
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800215<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700216 <code class="details" id="verify">verify(applicationId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700217 <pre>Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800218
219Args:
220 applicationId: string, The application ID from the Google Play developer console. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800225
226Returns:
227 An object of the form:
228
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700229 { # A third party application verification response resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800230 &quot;alternate_player_id&quot;: &quot;A String&quot;, # An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)
231 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
232 &quot;player_id&quot;: &quot;A String&quot;, # The ID of the player that was issued the auth token used in this request.
233}</pre>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800234</div>
235
John Asmuth614db982014-04-24 15:46:26 -0400236</body></html>