Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / games_v1.applications.html
blob: 69d5ca528553d1b55d6d93420c8220b283d6ac1a [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.applications.html">applications</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]81 <code><a href="#get">get(applicationId, language=None, platformType=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<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 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#played">played(x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Indicate that the currently authenticated user is playing your application.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#verify">verify(applicationId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<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 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]96 <code class="details" id="get">get(applicationId, language=None, platformType=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <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 -0400[diff] [blame]98
99Args:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]100 applicationId: string, The application ID from the Google Play developer console. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]101 language: string, The preferred language to use for strings returned by this method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 platformType: string, Restrict application details returned to the specific platform.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 Allowed values
104 PLATFORM_TYPE_UNSPECIFIED - Default value, don&#x27;t use.
105 ANDROID - Retrieve applications that can be played on Android.
106 IOS - Retrieve applications that can be played on iOS.
107 WEB_APP - Retrieve applications that can be played on desktop web.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 1 - v1 error format
111 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112
113Returns:
114 An object of the form:
115
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 { # The Application resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]117 &quot;id&quot;: &quot;A String&quot;, # The ID of the application.
118 &quot;lastUpdatedTimestamp&quot;: &quot;A String&quot;, # The last updated timestamp of the application.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 &quot;name&quot;: &quot;A String&quot;, # The name of the application.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 &quot;instances&quot;: [ # The instances of the application.
122 { # The Instance resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]123 &quot;androidInstance&quot;: { # The Android instance details resource. # Platform dependent details for Android.
124 &quot;enablePiracyCheck&quot;: True or False, # Flag indicating whether the anti-piracy check is enabled.
125 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
126 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
127 &quot;packageName&quot;: &quot;A String&quot;, # Android package name which maps to Google Play URL.
128 },
129 &quot;acquisitionUri&quot;: &quot;A String&quot;, # URI which shows where a user can acquire this instance.
130 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]131 &quot;webInstance&quot;: { # The Web details resource. # Platform dependent details for Web.
132 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
133 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
134 &quot;launchUrl&quot;: &quot;A String&quot;, # Launch URL for the game.
135 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 &quot;realtimePlay&quot;: True or False, # Flag to show if this game instance supports realtime play.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]137 &quot;turnBasedPlay&quot;: True or False, # Flag to show if this game instance supports turn based play.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 &quot;iosInstance&quot;: { # The iOS details resource. # Platform dependent details for iOS.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 &quot;supportIphone&quot;: True or False, # Flag to indicate if this instance supports iPhone.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]140 &quot;bundleIdentifier&quot;: &quot;A String&quot;, # Bundle identifier.
141 &quot;supportIpad&quot;: True or False, # Flag to indicate if this instance supports iPad.
142 &quot;itunesAppId&quot;: &quot;A String&quot;, # iTunes App ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 &quot;preferredForIphone&quot;: True or False, # Indicates that this instance is the default for new installations on iPhone devices.
144 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]145 &quot;preferredForIpad&quot;: True or False, # Indicates that this instance is the default for new installations on iPad devices.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]147 &quot;platformType&quot;: &quot;A String&quot;, # The platform type.
148 &quot;name&quot;: &quot;A String&quot;, # Localized display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]149 },
150 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]151 &quot;enabledFeatures&quot;: [ # A list of features that have been enabled for the application.
152 &quot;A String&quot;,
153 ],
154 &quot;achievement_count&quot;: 42, # The number of achievements visible to the currently authenticated player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 &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;).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]156 &quot;author&quot;: &quot;A String&quot;, # The author of the application.
157 &quot;description&quot;: &quot;A String&quot;, # The description of the application.
158 &quot;assets&quot;: [ # The assets of the application.
159 { # An image asset object.
160 &quot;width&quot;: 42, # The width of the asset.
161 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
162 &quot;name&quot;: &quot;A String&quot;, # The name of the asset.
163 &quot;url&quot;: &quot;A String&quot;, # The URL of the asset.
164 &quot;height&quot;: 42, # The height of the asset.
165 },
166 ],
167 &quot;leaderboard_count&quot;: 42, # The number of leaderboards visible to the currently authenticated player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]168 &quot;category&quot;: { # An application category object. # The category of the application.
169 &quot;secondary&quot;: &quot;A String&quot;, # The secondary category.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 &quot;primary&quot;: &quot;A String&quot;, # The primary category.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]171 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 }</pre>
174</div>
175
176<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 <code class="details" id="played">played(x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 <pre>Indicate that the currently authenticated user is playing your application.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179
180Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185</pre>
186</div>
187
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 <code class="details" id="verify">verify(applicationId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]190 <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 -0800[diff] [blame]191
192Args:
193 applicationId: string, The application ID from the Google Play developer console. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]198
199Returns:
200 An object of the form:
201
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]202 { # A third party application verification response resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;player_id&quot;: &quot;A String&quot;, # The ID of the player that was issued the auth token used in this request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]204 &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.)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]205 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 }</pre>
207</div>
208
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]209</body></html>