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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<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.recall.html">recall</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="#gamesPlayerTokens">gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.</p>
<p class="toc_element">
<code><a href="#lastTokenFromAllDeveloperGames">lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.</p>
<p class="toc_element">
<code><a href="#linkPersona">linkPersona(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Associate the PGS Player principal encoded in the provided recall session id with an in-game account</p>
<p class="toc_element">
<code><a href="#resetPersona">resetPersona(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete all Recall tokens linking the given persona to any player (with or without a profile).</p>
<p class="toc_element">
<code><a href="#retrieveTokens">retrieveTokens(sessionId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.</p>
<p class="toc_element">
<code><a href="#unlinkPersona">unlinkPersona(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.</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="gamesPlayerTokens">gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None)</code>
<pre>Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.
Args:
sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
applicationIds: string, Required. The application IDs from the Google Play developer console for the games to return scoped ids for. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of recall token data returned from the RetrieveGamesPlayerTokens RPC
"gamePlayerTokens": [ # The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.
{ # Recall tokens for a game.
"applicationId": "A String", # The application that this player identifier is for.
"recallToken": { # Recall token data returned from RetrievePlayerTokens RPC # Recall token data.
"expireTime": "A String", # Optional. Optional expiration time of the token
"multiPlayerPersona": True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
"token": "A String", # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="lastTokenFromAllDeveloperGames">lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None)</code>
<pre>Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
Args:
sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC
"gamePlayerToken": { # Recall tokens for a game. # The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal.
"applicationId": "A String", # The application that this player identifier is for.
"recallToken": { # Recall token data returned from RetrievePlayerTokens RPC # Recall token data.
"expireTime": "A String", # Optional. Optional expiration time of the token
"multiPlayerPersona": True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
"token": "A String", # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="linkPersona">linkPersona(body=None, x__xgafv=None)</code>
<pre>Associate the PGS Player principal encoded in the provided recall session id with an in-game account
Args:
body: object, The request body.
The object takes the form of:
{ # Request to link an in-game account with a PGS principal (encoded in the session id).
"cardinalityConstraint": "A String", # Required. Cardinality constraint to observe when linking a persona to a player in the scope of a game.
"conflictingLinksResolutionPolicy": "A String", # Required. Resolution policy to apply when the linking of a persona to a player would result in violating the specified cardinality constraint.
"expireTime": "A String", # Input only. Optional expiration time.
"persona": "A String", # Required. Stable identifier of the in-game account. Please refrain from re-using the same persona for different games.
"sessionId": "A String", # Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
"token": "A String", # Required. Value of the token to create. Opaque to Play Games and assumed to be non-stable (encrypted with key rotation).
"ttl": "A String", # Input only. Optional time-to-live.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Outcome of a persona linking attempt.
"state": "A String", # Output only. State of a persona linking attempt.
}</pre>
</div>
<div class="method">
<code class="details" id="resetPersona">resetPersona(body=None, x__xgafv=None)</code>
<pre>Delete all Recall tokens linking the given persona to any player (with or without a profile).
Args:
body: object, The request body.
The object takes the form of:
{ # Request to remove all Recall tokens associated with a persona for an app.
"persona": "A String", # Value of the 'persona' field as it was provided by the client in LinkPersona RPC
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the ResetPersona RPC
"unlinked": True or False, # Required. Whether any tokens were unlinked as a result of this request.
}</pre>
</div>
<div class="method">
<code class="details" id="retrieveTokens">retrieveTokens(sessionId, x__xgafv=None)</code>
<pre>Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
Args:
sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the RetrievePlayerTokens RPC
"tokens": [ # Required. Recall tokens associated with the requested PGS Player principal
{ # Recall token data returned from RetrievePlayerTokens RPC
"expireTime": "A String", # Optional. Optional expiration time of the token
"multiPlayerPersona": True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
"token": "A String", # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="unlinkPersona">unlinkPersona(body=None, x__xgafv=None)</code>
<pre>Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to remove a Recall token linking PGS principal and an in-game account
"persona": "A String", # Value of the 'persona' field as it was provided by the client in LinkPersona RPC
"sessionId": "A String", # Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
"token": "A String", # Value of the Recall token as it was provided by the client in LinkPersona RPC
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the UnlinkPersona RPC
"unlinked": True or False, # Required. Whether a Recall token specified by the request was deleted. Can be 'false' when there were no Recall tokens satisfied the criteria from the request.
}</pre>
</div>
</body></html>
|
