Files
google-apis-rs/google_androidpublisher3_cli/grants_create/index.html
2022-03-08 15:36:16 +08:00

690 lines
23 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>Create - Android Publisher v3.0.0+20220307</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"> Android Publisher v3.0.0+20220307</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Edits</span>
<li class="toctree-l1 ">
<a class="" href="../edits_apks-addexternallyhosted">Apks Addexternallyhosted</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_apks-list">Apks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_apks-upload">Apks Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_bundles-list">Bundles List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_bundles-upload">Bundles Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_commit">Commit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_countryavailability-get">Countryavailability Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_deobfuscationfiles-upload">Deobfuscationfiles Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_details-get">Details Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_details-patch">Details Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_details-update">Details Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_expansionfiles-get">Expansionfiles Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_expansionfiles-patch">Expansionfiles Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_expansionfiles-update">Expansionfiles Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_expansionfiles-upload">Expansionfiles Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_images-delete">Images Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_images-deleteall">Images Deleteall</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_images-list">Images List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_images-upload">Images Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-delete">Listings Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-deleteall">Listings Deleteall</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-get">Listings Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-list">Listings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-patch">Listings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_listings-update">Listings Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_testers-get">Testers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_testers-patch">Testers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_testers-update">Testers Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_tracks-get">Tracks Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_tracks-list">Tracks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_tracks-patch">Tracks Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_tracks-update">Tracks Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../edits_validate">Validate</a>
</li>
<span>Generatedapks</span>
<li class="toctree-l1 ">
<a class="" href="../generatedapks_download">Download</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../generatedapks_list">List</a>
</li>
<span>Grants</span>
<li class="toctree-l1 current">
<a class="current" href=".">Create</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</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="../grants_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../grants_patch">Patch</a>
</li>
<span>Inappproducts</span>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../inappproducts_update">Update</a>
</li>
<span>Internalappsharingartifacts</span>
<li class="toctree-l1 ">
<a class="" href="../internalappsharingartifacts_uploadapk">Uploadapk</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../internalappsharingartifacts_uploadbundle">Uploadbundle</a>
</li>
<span>Monetization</span>
<li class="toctree-l1 ">
<a class="" href="../monetization_convert-region-prices">Convert Region Prices</a>
</li>
<span>Orders</span>
<li class="toctree-l1 ">
<a class="" href="../orders_refund">Refund</a>
</li>
<span>Purchases</span>
<li class="toctree-l1 ">
<a class="" href="../purchases_products-acknowledge">Products Acknowledge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_products-get">Products Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-acknowledge">Subscriptions Acknowledge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-cancel">Subscriptions Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-defer">Subscriptions Defer</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-get">Subscriptions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-refund">Subscriptions Refund</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_subscriptions-revoke">Subscriptions Revoke</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../purchases_voidedpurchases-list">Voidedpurchases List</a>
</li>
<span>Reviews</span>
<li class="toctree-l1 ">
<a class="" href="../reviews_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../reviews_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../reviews_reply">Reply</a>
</li>
<span>Systemapks</span>
<li class="toctree-l1 ">
<a class="" href="../systemapks_variants-create">Variants Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../systemapks_variants-download">Variants Download</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../systemapks_variants-get">Variants Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../systemapks_variants-list">Variants List</a>
</li>
<span>Users</span>
<li class="toctree-l1 ">
<a class="" href="../users_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_patch">Patch</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>Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidpublisher3-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Grant access for a user to the given package.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/androidpublisher</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/androidpublisher</em>.
You can set the scope for this method like this: <code>androidpublisher3 --scope &lt;scope&gt; grants create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>Required. The user which needs permission. Format: developers/{developer}/users/{user}</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>Grant:
app-level-permissions: [string]
name: string
package-name: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . app-level-permissions=stet</code><ul>
<li>The permissions granted to the user for this app.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>name=kasd</code><ul>
<li>Required. Resource name for this grant, following the pattern &#34;developers/{developer}/users/{email}/grants/{package_name}&#34;.</li>
</ul>
</li>
<li><code>package-name=et</code><ul>
<li>Immutable. The package name of the app.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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="../grants_delete" class="btn btn-neutral float-right" title="Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../generatedapks_list" class="btn btn-neutral" title="List"><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="../generatedapks_list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../grants_delete" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>