Files
google-apis-rs/google_games1_cli/achievements_set-steps-at-least/index.html
2022-03-08 15:36:16 +08:00

444 lines
13 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Set Steps At Least - Games v3.0.0+20220217</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Games v3.0.0+20220217</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Achievement Definitions</span>
<li class="toctree-l1 ">
<a class="" href="../achievement-definitions_list">List</a>
</li>
<span>Achievements</span>
<li class="toctree-l1 ">
<a class="" href="../achievements_increment">Increment</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../achievements_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../achievements_reveal">Reveal</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Set Steps At Least</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../achievements_unlock">Unlock</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../achievements_update-multiple">Update Multiple</a>
</li>
<span>Applications</span>
<li class="toctree-l1 ">
<a class="" href="../applications_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../applications_get-end-point">Get End Point</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../applications_played">Played</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../applications_verify">Verify</a>
</li>
<span>Events</span>
<li class="toctree-l1 ">
<a class="" href="../events_list-by-player">List By Player</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../events_list-definitions">List Definitions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../events_record">Record</a>
</li>
<span>Leaderboards</span>
<li class="toctree-l1 ">
<a class="" href="../leaderboards_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../leaderboards_list">List</a>
</li>
<span>Metagame</span>
<li class="toctree-l1 ">
<a class="" href="../metagame_get-metagame-config">Get Metagame Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../metagame_list-categories-by-player">List Categories By Player</a>
</li>
<span>Players</span>
<li class="toctree-l1 ">
<a class="" href="../players_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../players_list">List</a>
</li>
<span>Revisions</span>
<li class="toctree-l1 ">
<a class="" href="../revisions_check">Check</a>
</li>
<span>Scores</span>
<li class="toctree-l1 ">
<a class="" href="../scores_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../scores_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../scores_list-window">List Window</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../scores_submit">Submit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../scores_submit-multiple">Submit Multiple</a>
</li>
<span>Snapshots</span>
<li class="toctree-l1 ">
<a class="" href="../snapshots_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../snapshots_list">List</a>
</li>
<span>Stats</span>
<li class="toctree-l1 ">
<a class="" href="../stats_get">Get</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Set Steps At Least</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/games1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/games</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/games</em>.
You can set the scope for this method like this: <code>games1 --scope &lt;scope&gt; achievements set-steps-at-least ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;achievement-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the achievement used by this method.</li>
</ul>
</li>
<li><strong>&lt;steps&gt;</strong> <em>(integer)</em><ul>
<li>The minimum value to set the steps to.</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../achievements_unlock" class="btn btn-neutral float-right" title="Unlock"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../achievements_reveal" class="btn btn-neutral" title="Reveal"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../achievements_reveal" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../achievements_unlock" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>