blob: 8627b3394cf5cd6c57e5e65477931624cff2654e [file] [log] [blame]
<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="gamesManagement_v1management.html">Google Play Game Management</a> . <a href="gamesManagement_v1management.scores.html">scores</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#reset">reset(leaderboardId, x__xgafv=None)</a></code></p>
<p class="firstline">Resets scores for the leaderboard with the given ID for the currently</p>
<p class="toc_element">
<code><a href="#resetAll">resetAll(x__xgafv=None)</a></code></p>
<p class="firstline">Resets all scores for all leaderboards for the currently authenticated</p>
<p class="toc_element">
<code><a href="#resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</a></code></p>
<p class="firstline">Resets scores for all draft leaderboards for all players. This method is</p>
<p class="toc_element">
<code><a href="#resetForAllPlayers">resetForAllPlayers(leaderboardId, x__xgafv=None)</a></code></p>
<p class="firstline">Resets scores for the leaderboard with the given ID for all players. This</p>
<p class="toc_element">
<code><a href="#resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resets scores for the leaderboards with the given IDs for all players. This</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="reset">reset(leaderboardId, x__xgafv=None)</code>
<pre>Resets scores for the leaderboard with the given ID for the currently
authenticated player. This method is only accessible to whitelisted tester
accounts for your application.
Args:
leaderboardId: string, The ID of the leaderboard. (required)
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 reset leaderboard entry resources.
&quot;definitionId&quot;: &quot;A String&quot;, # The ID of an leaderboard for which player state has been updated.
&quot;resetScoreTimeSpans&quot;: [ # The time spans of the updated score. &lt;br/&gt;Possible values are: &lt;ul&gt;
# &lt;li&gt;&quot;`ALL_TIME`&quot; - The score is an all-time score.&lt;/li&gt;
# &lt;li&gt;&quot;`WEEKLY`&quot; - The score is a weekly score.&lt;/li&gt;
# &lt;li&gt;&quot;`DAILY`&quot; - The score is a daily score.&lt;/li&gt; &lt;/ul&gt;
&quot;A String&quot;,
],
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `gamesManagement#playerScoreResetResponse`.
}</pre>
</div>
<div class="method">
<code class="details" id="resetAll">resetAll(x__xgafv=None)</code>
<pre>Resets all scores for all leaderboards for the currently authenticated
players. This method is only accessible to whitelisted tester accounts for
your application.
Args:
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 leaderboard reset resources.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `gamesManagement#playerScoreResetAllResponse`.
&quot;results&quot;: [ # The leaderboard reset results.
{ # A list of reset leaderboard entry resources.
&quot;definitionId&quot;: &quot;A String&quot;, # The ID of an leaderboard for which player state has been updated.
&quot;resetScoreTimeSpans&quot;: [ # The time spans of the updated score. &lt;br/&gt;Possible values are: &lt;ul&gt;
# &lt;li&gt;&quot;`ALL_TIME`&quot; - The score is an all-time score.&lt;/li&gt;
# &lt;li&gt;&quot;`WEEKLY`&quot; - The score is a weekly score.&lt;/li&gt;
# &lt;li&gt;&quot;`DAILY`&quot; - The score is a daily score.&lt;/li&gt; &lt;/ul&gt;
&quot;A String&quot;,
],
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `gamesManagement#playerScoreResetResponse`.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</code>
<pre>Resets scores for all draft leaderboards for all players. This method is
only available to user accounts for your developer console.
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="resetForAllPlayers">resetForAllPlayers(leaderboardId, x__xgafv=None)</code>
<pre>Resets scores for the leaderboard with the given ID for all players. This
method is only available to user accounts for your developer console. Only
draft leaderboards can be reset.
Args:
leaderboardId: string, The ID of the leaderboard. (required)
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="resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</code>
<pre>Resets scores for the leaderboards with the given IDs for all players. This
method is only available to user accounts for your developer console. Only
draft leaderboards may be reset.
Args:
body: object, The request body.
The object takes the form of:
{
&quot;leaderboard_ids&quot;: [ # The IDs of leaderboards to reset.
&quot;A String&quot;,
],
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `gamesManagement#scoresResetMultipleForAllRequest`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
</body></html>