docs/dyn/games_v1.recall.html - external/github.com/google/google-api-python-client - Git at Google

 <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 Game Services</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="#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 principal 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="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).
   &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.
   &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.
   &quot;expireTime&quot;: &quot;A String&quot;, # Input only. Optional expiration time.
   &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.
   &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.
   &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).
   &quot;ttl&quot;: &quot;A String&quot;, # 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.
   &quot;state&quot;: &quot;A String&quot;, # 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.
   &quot;persona&quot;: &quot;A String&quot;, # Value of the &#x27;persona&#x27; 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
   &quot;unlinked&quot;: 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 principal 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
   &quot;tokens&quot;: [ # Required. Recall tokens associated with the requested PGS Player principal
     { # Recall token data returned from RetrievePlayerTokens RPC
       &quot;expireTime&quot;: &quot;A String&quot;, # Optional. Optional expiration time of the token
       &quot;multiPlayerPersona&quot;: True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
       &quot;token&quot;: &quot;A String&quot;, # 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 &#x27;persona&#x27; 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
   &quot;persona&quot;: &quot;A String&quot;, # Value of the &#x27;persona&#x27; field as it was provided by the client in LinkPersona RPC
   &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.
   &quot;token&quot;: &quot;A String&quot;, # 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
   &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.
 }</pre>
 </div>

 </body></html>
	<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 Game Services</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="#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 principal 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="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 principal 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>