Debian Codegraph @

docs/dyn/games_v1.applications.html

raw
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
75 <h1><a href="games_v1.html">Google Play Games Services API</a> . <a href="games_v1.applications.html">applications</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(applicationId, language=None, platformType=None, x__xgafv=None)</a></code></p>
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>
83 <p class="toc_element">
84 <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">
87 <code><a href="#played">played(x__xgafv=None)</a></code></p>
88 <p class="firstline">Indicate that the currently authenticated user is playing your application.</p>
89 <p class="toc_element">
90 <code><a href="#verify">verify(applicationId, x__xgafv=None)</a></code></p>
91 <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>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(applicationId, language=None, platformType=None, x__xgafv=None)</code>
100 <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.
101
102 Args:
103 applicationId: string, The application ID from the Google Play developer console. (required)
104 language: string, The preferred language to use for strings returned by this method.
105 platformType: string, Restrict application details returned to the specific platform.
106 Allowed values
107 ANDROID - Retrieve applications that can be played on Android.
108 IOS - Retrieve applications that can be played on iOS.
109 WEB_APP - Retrieve applications that can be played on desktop web.
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115 Returns:
116 An object of the form:
117
118 { # The Application resource.
119 &quot;achievement_count&quot;: 42, # The number of achievements visible to the currently authenticated player.
120 &quot;assets&quot;: [ # The assets of the application.
121 { # An image asset object.
122 &quot;height&quot;: 42, # The height of the asset.
123 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
124 &quot;name&quot;: &quot;A String&quot;, # The name of the asset.
125 &quot;url&quot;: &quot;A String&quot;, # The URL of the asset.
126 &quot;width&quot;: 42, # The width of the asset.
127 },
128 ],
129 &quot;author&quot;: &quot;A String&quot;, # The author of the application.
130 &quot;category&quot;: { # An application category object. # The category of the application.
131 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
132 &quot;primary&quot;: &quot;A String&quot;, # The primary category.
133 &quot;secondary&quot;: &quot;A String&quot;, # The secondary category.
134 },
135 &quot;description&quot;: &quot;A String&quot;, # The description of the application.
136 &quot;enabledFeatures&quot;: [ # A list of features that have been enabled for the application.
137 &quot;A String&quot;,
138 ],
139 &quot;id&quot;: &quot;A String&quot;, # The ID of the application.
140 &quot;instances&quot;: [ # The instances of the application.
141 { # The Instance resource.
142 &quot;acquisitionUri&quot;: &quot;A String&quot;, # URI which shows where a user can acquire this instance.
143 &quot;androidInstance&quot;: { # The Android instance details resource. # Platform dependent details for Android.
144 &quot;enablePiracyCheck&quot;: True or False, # Flag indicating whether the anti-piracy check is enabled.
145 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
146 &quot;packageName&quot;: &quot;A String&quot;, # Android package name which maps to Google Play URL.
147 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
148 },
149 &quot;iosInstance&quot;: { # The iOS details resource. # Platform dependent details for iOS.
150 &quot;bundleIdentifier&quot;: &quot;A String&quot;, # Bundle identifier.
151 &quot;itunesAppId&quot;: &quot;A String&quot;, # iTunes App ID.
152 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
153 &quot;preferredForIpad&quot;: True or False, # Indicates that this instance is the default for new installations on iPad devices.
154 &quot;preferredForIphone&quot;: True or False, # Indicates that this instance is the default for new installations on iPhone devices.
155 &quot;supportIpad&quot;: True or False, # Flag to indicate if this instance supports iPad.
156 &quot;supportIphone&quot;: True or False, # Flag to indicate if this instance supports iPhone.
157 },
158 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
159 &quot;name&quot;: &quot;A String&quot;, # Localized display name.
160 &quot;platformType&quot;: &quot;A String&quot;, # The platform type.
161 &quot;realtimePlay&quot;: True or False, # Flag to show if this game instance supports realtime play.
162 &quot;turnBasedPlay&quot;: True or False, # Flag to show if this game instance supports turn based play.
163 &quot;webInstance&quot;: { # The Web details resource. # Platform dependent details for Web.
164 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
165 &quot;launchUrl&quot;: &quot;A String&quot;, # Launch URL for the game.
166 &quot;preferred&quot;: True or False, # Indicates that this instance is the default for new installations.
167 },
168 },
169 ],
170 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
171 &quot;lastUpdatedTimestamp&quot;: &quot;A String&quot;, # The last updated timestamp of the application.
172 &quot;leaderboard_count&quot;: 42, # The number of leaderboards visible to the currently authenticated player.
173 &quot;name&quot;: &quot;A String&quot;, # The name of the application.
174 &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;).
175 }</pre>
176 </div>
177
178 <div class="method">
179 <code class="details" id="getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</code>
180 <pre>Returns a URL for the requested end point type.
181
182 Args:
183 applicationId: string, The application ID from the Google Play developer console.
184 endPointType: string, Type of endpoint being requested.
185 Allowed values
186 PROFILE_CREATION - Request a URL to create a new profile.
187 PROFILE_SETTINGS - Request a URL for the Settings view.
188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193 Returns:
194 An object of the form:
195
196 { # Container for a URL end point of the requested type.
197 &quot;url&quot;: &quot;A String&quot;, # A URL suitable for loading in a web browser for the requested endpoint.
198 }</pre>
199 </div>
200
201 <div class="method">
202 <code class="details" id="played">played(x__xgafv=None)</code>
203 <pre>Indicate that the currently authenticated user is playing your application.
204
205 Args:
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210 </pre>
211 </div>
212
213 <div class="method">
214 <code class="details" id="verify">verify(applicationId, x__xgafv=None)</code>
215 <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.
216
217 Args:
218 applicationId: string, The application ID from the Google Play developer console. (required)
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224 Returns:
225 An object of the form:
226
227 { # A third party application verification response resource.
228 &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.)
229 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
230 &quot;player_id&quot;: &quot;A String&quot;, # The ID of the player that was issued the auth token used in this request.
231 }</pre>
232 </div>
233
234 </body></html>