OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_cloudchannel1_cli/accounts_list-transferable-skus/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

511 lines
20 KiB
HTML
Raw Blame History

<!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>List Transferable Skus - Cloudchannel v2.0.0+20210326</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"> Cloudchannel v2.0.0+20210326</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Accounts</span>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-create">Channel Partner Links Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-customers-create">Channel Partner Links Customers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-customers-delete">Channel Partner Links Customers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-customers-get">Channel Partner Links Customers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-customers-list">Channel Partner Links Customers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-customers-patch">Channel Partner Links Customers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-get">Channel Partner Links Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-list">Channel Partner Links List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_channel-partner-links-patch">Channel Partner Links Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_check-cloud-identity-accounts-exist">Check Cloud Identity Accounts Exist</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-create">Customers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-delete">Customers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-activate">Customers Entitlements Activate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-cancel">Customers Entitlements Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-change-offer">Customers Entitlements Change Offer</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-change-parameters">Customers Entitlements Change Parameters</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-change-renewal-settings">Customers Entitlements Change Renewal Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-create">Customers Entitlements Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-get">Customers Entitlements Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-list">Customers Entitlements List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-start-paid-service">Customers Entitlements Start Paid Service</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-entitlements-suspend">Customers Entitlements Suspend</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-get">Customers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-list">Customers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-list-purchasable-offers">Customers List Purchasable Offers</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-list-purchasable-skus">Customers List Purchasable Skus</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-patch">Customers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-provision-cloud-identity">Customers Provision Cloud Identity</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-transfer-entitlements">Customers Transfer Entitlements</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_customers-transfer-entitlements-to-google">Customers Transfer Entitlements To Google</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_list-subscribers">List Subscribers</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_list-transferable-offers">List Transferable Offers</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">List Transferable Skus</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="../accounts_offers-list">Offers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_register">Register</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_unregister">Unregister</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_list">List</a>
</li>
<span>Products</span>
<li class="toctree-l1 ">
<a class="" href="../products_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_skus-list">Skus List</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>List Transferable Skus</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/cloudchannel1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer&#39;s Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn&#39;t belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer&#39;s TransferableSku.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/apps.order</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.order</em>.
You can set the scope for this method like this: <code>cloudchannel1 --scope &lt;scope&gt; accounts list-transferable-skus ...</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 reseller account&#39;s resource name. Parent uses the format: accounts/{account_id}</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>GoogleCloudChannelV1ListTransferableSkusRequest:
auth-token: string
cloud-identity-id: string
customer-name: string
language-code: string
page-size: integer
page-token: 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 . auth-token=ut</code><ul>
<li>The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.</li>
</ul>
</li>
<li><code>cloud-identity-id=sit</code><ul>
<li>Customer&#39;s Cloud Identity ID</li>
</ul>
</li>
<li><code>customer-name=vero</code><ul>
<li>A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}</li>
</ul>
</li>
<li><code>language-code=rebum.</code><ul>
<li>The BCP-47 language code. For example, &#34;en-US&#34;. The response will localize in the corresponding language code, if specified. The default value is &#34;en-US&#34;. Optional.</li>
</ul>
</li>
<li><code>page-size=82</code><ul>
<li>The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional.</li>
</ul>
</li>
<li><code>page-token=consetetur</code><ul>
<li>A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional.</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="../accounts_offers-list" class="btn btn-neutral float-right" title="Offers List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../accounts_list-transferable-offers" class="btn btn-neutral" title="List Transferable Offers"><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="../accounts_list-transferable-offers" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../accounts_offers-list" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink