Debian Codegraph @

docs/dyn/games_v1.recall.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.recall.html">recall</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="#gamesPlayerTokens">gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None)</a></code></p>
82 <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>
83 <p class="toc_element">
84 <code><a href="#lastTokenFromAllDeveloperGames">lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None)</a></code></p>
85 <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>
86 <p class="toc_element">
87 <code><a href="#linkPersona">linkPersona(body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Associate the PGS Player principal encoded in the provided recall session id with an in-game account</p>
89 <p class="toc_element">
90 <code><a href="#resetPersona">resetPersona(body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Delete all Recall tokens linking the given persona to any player (with or without a profile).</p>
92 <p class="toc_element">
93 <code><a href="#retrieveTokens">retrieveTokens(sessionId, x__xgafv=None)</a></code></p>
94 <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>
95 <p class="toc_element">
96 <code><a href="#unlinkPersona">unlinkPersona(body=None, x__xgafv=None)</a></code></p>
97 <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>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="gamesPlayerTokens">gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None)</code>
106 <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.
107
108 Args:
109 sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
110 applicationIds: string, Required. The application IDs from the Google Play developer console for the games to return scoped ids for. (repeated)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 { # A list of recall token data returned from the RetrieveGamesPlayerTokens RPC
120 &quot;gamePlayerTokens&quot;: [ # 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.
121 { # Recall tokens for a game.
122 &quot;applicationId&quot;: &quot;A String&quot;, # The application that this player identifier is for.
123 &quot;recallToken&quot;: { # Recall token data returned from RetrievePlayerTokens RPC # Recall token data.
124 &quot;expireTime&quot;: &quot;A String&quot;, # Optional. Optional expiration time of the token
125 &quot;multiPlayerPersona&quot;: True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
126 &quot;token&quot;: &quot;A String&quot;, # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
127 },
128 },
129 ],
130 }</pre>
131 </div>
132
133 <div class="method">
134 <code class="details" id="lastTokenFromAllDeveloperGames">lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None)</code>
135 <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.
136
137 Args:
138 sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144 Returns:
145 An object of the form:
146
147 { # Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC
148 &quot;gamePlayerToken&quot;: { # 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.
149 &quot;applicationId&quot;: &quot;A String&quot;, # The application that this player identifier is for.
150 &quot;recallToken&quot;: { # Recall token data returned from RetrievePlayerTokens RPC # Recall token data.
151 &quot;expireTime&quot;: &quot;A String&quot;, # Optional. Optional expiration time of the token
152 &quot;multiPlayerPersona&quot;: True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
153 &quot;token&quot;: &quot;A String&quot;, # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
154 },
155 },
156 }</pre>
157 </div>
158
159 <div class="method">
160 <code class="details" id="linkPersona">linkPersona(body=None, x__xgafv=None)</code>
161 <pre>Associate the PGS Player principal encoded in the provided recall session id with an in-game account
162
163 Args:
164 body: object, The request body.
165 The object takes the form of:
166
167 { # Request to link an in-game account with a PGS principal (encoded in the session id).
168 &quot;cardinalityConstraint&quot;: &quot;A String&quot;, # Required. Cardinality constraint to observe when linking a persona to a player in the scope of a game.
169 &quot;conflictingLinksResolutionPolicy&quot;: &quot;A String&quot;, # Required. Resolution policy to apply when the linking of a persona to a player would result in violating the specified cardinality constraint.
170 &quot;expireTime&quot;: &quot;A String&quot;, # Input only. Optional expiration time.
171 &quot;persona&quot;: &quot;A String&quot;, # Required. Stable identifier of the in-game account. Please refrain from re-using the same persona for different games.
172 &quot;sessionId&quot;: &quot;A String&quot;, # Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
173 &quot;token&quot;: &quot;A String&quot;, # Required. Value of the token to create. Opaque to Play Games and assumed to be non-stable (encrypted with key rotation).
174 &quot;ttl&quot;: &quot;A String&quot;, # Input only. Optional time-to-live.
175 }
176
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182 Returns:
183 An object of the form:
184
185 { # Outcome of a persona linking attempt.
186 &quot;state&quot;: &quot;A String&quot;, # Output only. State of a persona linking attempt.
187 }</pre>
188 </div>
189
190 <div class="method">
191 <code class="details" id="resetPersona">resetPersona(body=None, x__xgafv=None)</code>
192 <pre>Delete all Recall tokens linking the given persona to any player (with or without a profile).
193
194 Args:
195 body: object, The request body.
196 The object takes the form of:
197
198 { # Request to remove all Recall tokens associated with a persona for an app.
199 &quot;persona&quot;: &quot;A String&quot;, # Value of the &#x27;persona&#x27; field as it was provided by the client in LinkPersona RPC
200 }
201
202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207 Returns:
208 An object of the form:
209
210 { # Response for the ResetPersona RPC
211 &quot;unlinked&quot;: True or False, # Required. Whether any tokens were unlinked as a result of this request.
212 }</pre>
213 </div>
214
215 <div class="method">
216 <code class="details" id="retrieveTokens">retrieveTokens(sessionId, x__xgafv=None)</code>
217 <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.
218
219 Args:
220 sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # Response for the RetrievePlayerTokens RPC
230 &quot;tokens&quot;: [ # Required. Recall tokens associated with the requested PGS Player principal
231 { # Recall token data returned from RetrievePlayerTokens RPC
232 &quot;expireTime&quot;: &quot;A String&quot;, # Optional. Optional expiration time of the token
233 &quot;multiPlayerPersona&quot;: True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
234 &quot;token&quot;: &quot;A String&quot;, # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
235 },
236 ],
237 }</pre>
238 </div>
239
240 <div class="method">
241 <code class="details" id="unlinkPersona">unlinkPersona(body=None, x__xgafv=None)</code>
242 <pre>Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the &#x27;persona&#x27; or by the token value.
243
244 Args:
245 body: object, The request body.
246 The object takes the form of:
247
248 { # Request to remove a Recall token linking PGS principal and an in-game account
249 &quot;persona&quot;: &quot;A String&quot;, # Value of the &#x27;persona&#x27; field as it was provided by the client in LinkPersona RPC
250 &quot;sessionId&quot;: &quot;A String&quot;, # Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
251 &quot;token&quot;: &quot;A String&quot;, # Value of the Recall token as it was provided by the client in LinkPersona RPC
252 }
253
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259 Returns:
260 An object of the form:
261
262 { # Response for the UnlinkPersona RPC
263 &quot;unlinked&quot;: True or False, # Required. Whether a Recall token specified by the request was deleted. Can be &#x27;false&#x27; when there were no Recall tokens satisfied the criteria from the request.
264 }</pre>
265 </div>
266
267 </body></html>