mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 21:02:29 +01:00
303 lines
13 KiB
HTML
303 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-licensing1-cli/license-assignments_patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Patch - licensing v5.0.4+20240301</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Patch";
|
|
var mkdocs_page_input_path = "license-assignments_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-licensing1-cli/license-assignments_patch/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</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-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> licensing v5.0.4+20240301
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">License Assignments</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_list-for-product/">List For Product</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_list-for-product-and-sku/">List For Product And Sku</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license-assignments_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">licensing v5.0.4+20240301</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=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>License Assignments »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/licensing1-cli/edit/master/docs/license-assignments_patch.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/apps.licensing</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/apps.licensing</em>.
|
|
You can set the scope for this method like this: <code>licensing1 --scope <scope> license-assignments patch ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><product-id></strong> <em>(string)</em><ul>
|
|
<li>A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><sku-id></strong> <em>(string)</em><ul>
|
|
<li>A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><user-id></strong> <em>(string)</em><ul>
|
|
<li>The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a <code>userId</code> is subject to change, do not use a <code>userId</code> value as a key for persistent data. This key could break if the current user's email address changes. If the <code>userId</code> is suspended, the license status changes.</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>LicenseAssignment:
|
|
etags: string
|
|
kind: string
|
|
product-id: string
|
|
product-name: string
|
|
self-link: string
|
|
sku-id: string
|
|
sku-name: string
|
|
user-id: 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 . etags=magna</code><ul>
|
|
<li>ETag of the resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=no</code><ul>
|
|
<li>Identifies the resource as a LicenseAssignment, which is <code>licensing#licenseAssignment</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>product-id=ipsum</code><ul>
|
|
<li>A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>product-name=voluptua.</code><ul>
|
|
<li>Display Name of the product.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=at</code><ul>
|
|
<li>Link to this page.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sku-id=sanctus</code><ul>
|
|
<li>A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sku-name=sed</code><ul>
|
|
<li>Display Name of the sku of the product.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-id=amet.</code><ul>
|
|
<li>The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a <code>userId</code> is subject to change, do not use a <code>userId</code> value as a key for persistent data. This key could break if the current user's email address changes. If the <code>userId</code> is suspended, the license status changes.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../license-assignments_list-for-product-and-sku/" class="btn btn-neutral float-left" title="List For Product And Sku"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../license-assignments_update/" class="btn btn-neutral float-right" title="Update">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/licensing1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../license-assignments_list-for-product-and-sku/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../license-assignments_update/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|