1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="games_v1.html">Google Play Games Services API</a> . <a href="games_v1.applications.html">applications</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(applicationId, language=None, platformType=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a URL for the requested end point type.</p>
<p class="toc_element">
<code><a href="#played">played(x__xgafv=None)</a></code></p>
<p class="firstline">Indicate that the currently authenticated user is playing your application.</p>
<p class="toc_element">
<code><a href="#verify">verify(applicationId, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(applicationId, language=None, platformType=None, x__xgafv=None)</code>
<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.
Args:
applicationId: string, The application ID from the Google Play developer console. (required)
language: string, The preferred language to use for strings returned by this method.
platformType: string, Restrict application details returned to the specific platform.
Allowed values
ANDROID - Retrieve applications that can be played on Android.
IOS - Retrieve applications that can be played on iOS.
WEB_APP - Retrieve applications that can be played on desktop web.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Application resource.
"achievement_count": 42, # The number of achievements visible to the currently authenticated player.
"assets": [ # The assets of the application.
{ # An image asset object.
"height": 42, # The height of the asset.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
"name": "A String", # The name of the asset.
"url": "A String", # The URL of the asset.
"width": 42, # The width of the asset.
},
],
"author": "A String", # The author of the application.
"category": { # An application category object. # The category of the application.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
"primary": "A String", # The primary category.
"secondary": "A String", # The secondary category.
},
"description": "A String", # The description of the application.
"enabledFeatures": [ # A list of features that have been enabled for the application.
"A String",
],
"id": "A String", # The ID of the application.
"instances": [ # The instances of the application.
{ # The Instance resource.
"acquisitionUri": "A String", # URI which shows where a user can acquire this instance.
"androidInstance": { # The Android instance details resource. # Platform dependent details for Android.
"enablePiracyCheck": True or False, # Flag indicating whether the anti-piracy check is enabled.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
"packageName": "A String", # Android package name which maps to Google Play URL.
"preferred": True or False, # Indicates that this instance is the default for new installations.
},
"iosInstance": { # The iOS details resource. # Platform dependent details for iOS.
"bundleIdentifier": "A String", # Bundle identifier.
"itunesAppId": "A String", # iTunes App ID.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
"preferredForIpad": True or False, # Indicates that this instance is the default for new installations on iPad devices.
"preferredForIphone": True or False, # Indicates that this instance is the default for new installations on iPhone devices.
"supportIpad": True or False, # Flag to indicate if this instance supports iPad.
"supportIphone": True or False, # Flag to indicate if this instance supports iPhone.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
"name": "A String", # Localized display name.
"platformType": "A String", # The platform type.
"realtimePlay": True or False, # Flag to show if this game instance supports realtime play.
"turnBasedPlay": True or False, # Flag to show if this game instance supports turn based play.
"webInstance": { # The Web details resource. # Platform dependent details for Web.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
"launchUrl": "A String", # Launch URL for the game.
"preferred": True or False, # Indicates that this instance is the default for new installations.
},
},
],
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
"lastUpdatedTimestamp": "A String", # The last updated timestamp of the application.
"leaderboard_count": 42, # The number of leaderboards visible to the currently authenticated player.
"name": "A String", # The name of the application.
"themeColor": "A String", # 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. "E0E0E0").
}</pre>
</div>
<div class="method">
<code class="details" id="getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</code>
<pre>Returns a URL for the requested end point type.
Args:
applicationId: string, The application ID from the Google Play developer console.
endPointType: string, Type of endpoint being requested.
Allowed values
PROFILE_CREATION - Request a URL to create a new profile.
PROFILE_SETTINGS - Request a URL for the Settings view.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Container for a URL end point of the requested type.
"url": "A String", # A URL suitable for loading in a web browser for the requested endpoint.
}</pre>
</div>
<div class="method">
<code class="details" id="played">played(x__xgafv=None)</code>
<pre>Indicate that the currently authenticated user is playing your application.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="verify">verify(applicationId, x__xgafv=None)</code>
<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.
Args:
applicationId: string, The application ID from the Google Play developer console. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A third party application verification response resource.
"alternate_player_id": "A String", # 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.)
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
"player_id": "A String", # The ID of the player that was issued the auth token used in this request.
}</pre>
</div>
</body></html>
|
