mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
513 lines
27 KiB
HTML
513 lines
27 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-cloudchannel1-cli/accounts_customers-entitlements-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Customers Entitlements Create - Cloudchannel v5.0.4+20240303</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 = "Customers Entitlements Create";
|
|
var mkdocs_page_input_path = "accounts_customers-entitlements-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudchannel1-cli/accounts_customers-entitlements-create/";
|
|
</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"> Cloudchannel v5.0.4+20240303
|
|
</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">Accounts</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-create/">Channel Partner Links Channel Partner Repricing Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-delete/">Channel Partner Links Channel Partner Repricing Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-get/">Channel Partner Links Channel Partner Repricing Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-list/">Channel Partner Links Channel Partner Repricing Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-patch/">Channel Partner Links Channel Partner Repricing Configs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-create/">Channel Partner Links Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-create/">Channel Partner Links Customers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-delete/">Channel Partner Links Customers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-get/">Channel Partner Links Customers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-import/">Channel Partner Links Customers Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-list/">Channel Partner Links Customers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-patch/">Channel Partner Links Customers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-get/">Channel Partner Links Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-list/">Channel Partner Links List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-patch/">Channel Partner Links Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_check-cloud-identity-accounts-exist/">Check Cloud Identity Accounts Exist</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-create/">Customers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-create/">Customers Customer Repricing Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-delete/">Customers Customer Repricing Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-get/">Customers Customer Repricing Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-list/">Customers Customer Repricing Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-patch/">Customers Customer Repricing Configs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-delete/">Customers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-activate/">Customers Entitlements Activate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-cancel/">Customers Entitlements Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-offer/">Customers Entitlements Change Offer</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-parameters/">Customers Entitlements Change Parameters</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-renewal-settings/">Customers Entitlements Change Renewal Settings</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Customers Entitlements Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-get/">Customers Entitlements Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-list/">Customers Entitlements List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-list-entitlement-changes/">Customers Entitlements List Entitlement Changes</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-lookup-offer/">Customers Entitlements Lookup Offer</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-start-paid-service/">Customers Entitlements Start Paid Service</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-suspend/">Customers Entitlements Suspend</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-get/">Customers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-import/">Customers Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list/">Customers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list-purchasable-offers/">Customers List Purchasable Offers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list-purchasable-skus/">Customers List Purchasable Skus</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-patch/">Customers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-provision-cloud-identity/">Customers Provision Cloud Identity</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-query-eligible-billing-accounts/">Customers Query Eligible Billing Accounts</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-transfer-entitlements/">Customers Transfer Entitlements</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-transfer-entitlements-to-google/">Customers Transfer Entitlements To Google</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-subscribers/">List Subscribers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-transferable-offers/">List Transferable Offers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-transferable-skus/">List Transferable Skus</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_offers-list/">Offers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_register/">Register</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_report-jobs-fetch-report-results/">Report Jobs Fetch Report Results</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-list/">Reports List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-run/">Reports Run</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sku-groups-billable-skus-list/">Sku Groups Billable Skus List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sku-groups-list/">Sku Groups List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_unregister/">Unregister</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Products</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_skus-list/">Skus List</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="..">Cloudchannel v5.0.4+20240303</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>Accounts »</li>
|
|
<li>Customers Entitlements Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudchannel1-cli/edit/master/docs/accounts_customers-entitlements-create.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>Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.</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 <scope> accounts customers-entitlements-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_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>GoogleCloudChannelV1CreateEntitlementRequest:
|
|
entitlement:
|
|
association-info:
|
|
base-entitlement: string
|
|
billing-account: string
|
|
commitment-settings:
|
|
end-time: string
|
|
renewal-settings:
|
|
enable-renewal: boolean
|
|
payment-cycle:
|
|
duration: integer
|
|
period-type: string
|
|
payment-plan: string
|
|
resize-unit-count: boolean
|
|
start-time: string
|
|
create-time: string
|
|
name: string
|
|
offer: string
|
|
provisioned-service:
|
|
product-id: string
|
|
provisioning-id: string
|
|
sku-id: string
|
|
provisioning-state: string
|
|
purchase-order-id: string
|
|
suspension-reasons: [string]
|
|
trial-settings:
|
|
end-time: string
|
|
trial: boolean
|
|
update-time: string
|
|
request-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>
|
|
<p><code>-r .entitlement.association-info base-entitlement=lorem</code></p>
|
|
<ul>
|
|
<li>The name of the base entitlement, for which this entitlement is an add-on.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. billing-account=justo</code></p>
|
|
<ul>
|
|
<li>Optional. The billing account resource name that is used to pay for this entitlement.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>commitment-settings end-time=amet.</code><ul>
|
|
<li>Output only. Commitment end timestamp.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>renewal-settings enable-renewal=false</code><ul>
|
|
<li>If false, the plan will be completed at the end date.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>payment-cycle duration=58</code><ul>
|
|
<li>Total duration of Period Type defined.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>period-type=kasd</code></p>
|
|
<ul>
|
|
<li>Period Type.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. payment-plan=lorem</code></p>
|
|
<ul>
|
|
<li>Describes how a reseller will be billed.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>resize-unit-count=true</code></p>
|
|
<ul>
|
|
<li>If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. start-time=nonumy</code></p>
|
|
<ul>
|
|
<li>Output only. Commitment start timestamp.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=rebum.</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which the entitlement is created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=tempor</code><ul>
|
|
<li>Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>offer=dolore</code><ul>
|
|
<li>Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>provisioned-service product-id=eos</code><ul>
|
|
<li>Output only. The product pertaining to the provisioning resource as specified in the Offer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>provisioning-id=amet.</code><ul>
|
|
<li>Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>sku-id=dolore</code></p>
|
|
<ul>
|
|
<li>Output only. The SKU pertaining to the provisioning resource as specified in the Offer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. provisioning-state=amet</code></p>
|
|
<ul>
|
|
<li>Output only. Current provisioning state of the entitlement.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>purchase-order-id=ut</code><ul>
|
|
<li>Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>suspension-reasons=at</code><ul>
|
|
<li>Output only. Enumerable of all current suspension reasons for an entitlement.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>trial-settings end-time=sit</code><ul>
|
|
<li>Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example <a href="https://www.epochconverter.com">Epoch converter</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>trial=false</code></p>
|
|
<ul>
|
|
<li>Determines if the entitlement is in a trial or not: * <code>true</code> - The entitlement is in trial. * <code>false</code> - The entitlement is not in trial.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. update-time=duo</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which the entitlement is updated.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. request-id=sadipscing</code></p>
|
|
<ul>
|
|
<li>Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid <a href="https://tools.ietf.org/html/rfc4122">UUID</a> with the exception that zero UUID is not supported (<code>00000000-0000-0000-0000-000000000000</code>).</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="../accounts_customers-entitlements-change-renewal-settings/" class="btn btn-neutral float-left" title="Customers Entitlements Change Renewal Settings"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../accounts_customers-entitlements-get/" class="btn btn-neutral float-right" title="Customers Entitlements Get">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/cloudchannel1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../accounts_customers-entitlements-change-renewal-settings/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../accounts_customers-entitlements-get/" 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>
|