mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
451 lines
28 KiB
HTML
451 lines
28 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-retail2-cli/projects_locations-catalogs-models-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Catalogs Models Patch - Cloud Retail v5.0.4+20240222</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 = "Locations Catalogs Models Patch";
|
|
var mkdocs_page_input_path = "projects_locations-catalogs-models-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-retail2-cli/projects_locations-catalogs-models-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"> Cloud Retail v5.0.4+20240222
|
|
</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">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-attributes-config-add-catalog-attribute/">Locations Catalogs Attributes Config Add Catalog Attribute</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-attributes-config-remove-catalog-attribute/">Locations Catalogs Attributes Config Remove Catalog Attribute</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-attributes-config-replace-catalog-attribute/">Locations Catalogs Attributes Config Replace Catalog Attribute</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-operations-get/">Locations Catalogs Branches Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-add-fulfillment-places/">Locations Catalogs Branches Products Add Fulfillment Places</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-add-local-inventories/">Locations Catalogs Branches Products Add Local Inventories</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-create/">Locations Catalogs Branches Products Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-delete/">Locations Catalogs Branches Products Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-get/">Locations Catalogs Branches Products Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-import/">Locations Catalogs Branches Products Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-list/">Locations Catalogs Branches Products List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-patch/">Locations Catalogs Branches Products Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-purge/">Locations Catalogs Branches Products Purge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-remove-fulfillment-places/">Locations Catalogs Branches Products Remove Fulfillment Places</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-remove-local-inventories/">Locations Catalogs Branches Products Remove Local Inventories</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-branches-products-set-inventory/">Locations Catalogs Branches Products Set Inventory</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-complete-query/">Locations Catalogs Complete Query</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-completion-data-import/">Locations Catalogs Completion Data Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-controls-create/">Locations Catalogs Controls Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-controls-delete/">Locations Catalogs Controls Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-controls-get/">Locations Catalogs Controls Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-controls-list/">Locations Catalogs Controls List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-controls-patch/">Locations Catalogs Controls Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-export-analytics-metrics/">Locations Catalogs Export Analytics Metrics</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-get-attributes-config/">Locations Catalogs Get Attributes Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-get-completion-config/">Locations Catalogs Get Completion Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-get-default-branch/">Locations Catalogs Get Default Branch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-list/">Locations Catalogs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-create/">Locations Catalogs Models Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-delete/">Locations Catalogs Models Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-get/">Locations Catalogs Models Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-list/">Locations Catalogs Models List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Catalogs Models Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-pause/">Locations Catalogs Models Pause</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-resume/">Locations Catalogs Models Resume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-models-tune/">Locations Catalogs Models Tune</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-operations-get/">Locations Catalogs Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-operations-list/">Locations Catalogs Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-patch/">Locations Catalogs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-placements-predict/">Locations Catalogs Placements Predict</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-placements-search/">Locations Catalogs Placements Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-add-control/">Locations Catalogs Serving Configs Add Control</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-create/">Locations Catalogs Serving Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-delete/">Locations Catalogs Serving Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-get/">Locations Catalogs Serving Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-list/">Locations Catalogs Serving Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-patch/">Locations Catalogs Serving Configs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-predict/">Locations Catalogs Serving Configs Predict</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-remove-control/">Locations Catalogs Serving Configs Remove Control</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-serving-configs-search/">Locations Catalogs Serving Configs Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-set-default-branch/">Locations Catalogs Set Default Branch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-update-attributes-config/">Locations Catalogs Update Attributes Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-update-completion-config/">Locations Catalogs Update Completion Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-user-events-collect/">Locations Catalogs User Events Collect</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-user-events-import/">Locations Catalogs User Events Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-user-events-purge/">Locations Catalogs User Events Purge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-user-events-rejoin/">Locations Catalogs User Events Rejoin</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-user-events-write/">Locations Catalogs User Events Write</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-list/">Operations 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="..">Cloud Retail v5.0.4+20240222</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>Projects »</li>
|
|
<li>Locations Catalogs Models Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/retail2-cli/edit/master/docs/projects_locations-catalogs-models-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>Update of model metadata. Only fields that currently can be updated are: <code>filtering_option</code> and <code>periodic_tuning_state</code>. If other values are provided, this API method ignores them.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>retail2 --scope <scope> projects locations-catalogs-models-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. The fully qualified resource name of the model. Format: <code>projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}</code> catalog_id has char limit of 50. recommendation_model_id has char limit of 40.</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>GoogleCloudRetailV2Model:
|
|
create-time: string
|
|
data-state: string
|
|
display-name: string
|
|
filtering-option: string
|
|
last-tune-time: string
|
|
model-features-config:
|
|
frequently-bought-together-config:
|
|
context-products-type: string
|
|
name: string
|
|
optimization-objective: string
|
|
periodic-tuning-state: string
|
|
serving-state: string
|
|
training-state: string
|
|
tuning-operation: string
|
|
type: string
|
|
update-time: 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 . create-time=sed</code><ul>
|
|
<li>Output only. Timestamp the Recommendation Model was created at.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-state=nonumy</code><ul>
|
|
<li>Output only. The state of data requirements for this model: <code>DATA_OK</code> and <code>DATA_ERROR</code>. Recommendation model cannot be trained if the data is in <code>DATA_ERROR</code> state. Recommendation model can have <code>DATA_ERROR</code> state even if serving state is <code>ACTIVE</code>: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=sea</code><ul>
|
|
<li>Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>filtering-option=ipsum</code><ul>
|
|
<li>Optional. If <code>RECOMMENDATIONS_FILTERING_ENABLED</code>, recommendation filtering by attributes is enabled for the model.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-tune-time=kasd</code><ul>
|
|
<li>Output only. The timestamp when the latest successful tune finished.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>model-features-config.frequently-bought-together-config context-products-type=justo</code></p>
|
|
<ul>
|
|
<li>Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the <code>frequently-bought-together</code> type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... name=ea</code></p>
|
|
<ul>
|
|
<li>Required. The fully qualified resource name of the model. Format: <code>projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}</code> catalog_id has char limit of 50. recommendation_model_id has char limit of 40.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>optimization-objective=at</code><ul>
|
|
<li>Optional. The optimization objective e.g. <code>cvr</code>. Currently supported values: <code>ctr</code>, <code>cvr</code>, <code>revenue-per-order</code>. If not specified, we choose default based on model type. Default depends on type of recommendation: <code>recommended-for-you</code> => <code>ctr</code> <code>others-you-may-like</code> => <code>ctr</code> <code>frequently-bought-together</code> => <code>revenue_per_order</code> This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = <code>frequently-bought-together</code> and optimization_objective = <code>ctr</code>), you receive an error 400 if you try to create/update a recommendation with this set of knobs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>periodic-tuning-state=erat</code><ul>
|
|
<li>Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the <code>TuneModel</code> method. Default value is <code>PERIODIC_TUNING_ENABLED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>serving-state=clita</code><ul>
|
|
<li>Output only. The serving state of the model: <code>ACTIVE</code>, <code>NOT_ACTIVE</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>training-state=vero</code><ul>
|
|
<li>Optional. The training state that the model is in (e.g. <code>TRAINING</code> or <code>PAUSED</code>). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for <code>CreateModel</code> method is <code>TRAINING</code>. The default value for <code>UpdateModel</code> method is to keep the state the same as before.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>tuning-operation=invidunt</code><ul>
|
|
<li>Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=nonumy</code><ul>
|
|
<li>Required. The type of model e.g. <code>home-page</code>. Currently supported values: <code>recommended-for-you</code>, <code>others-you-may-like</code>, <code>frequently-bought-together</code>, <code>page-optimization</code>, <code>similar-items</code>, <code>buy-it-again</code>, <code>on-sale-items</code>, and <code>recently-viewed</code>(readonly value). This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = <code>frequently-bought-together</code> and optimization_objective = <code>ctr</code>), you receive an error 400 if you try to create/update a recommendation with this set of knobs.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=erat</code><ul>
|
|
<li>Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.</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-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.</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="../projects_locations-catalogs-models-list/" class="btn btn-neutral float-left" title="Locations Catalogs Models List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-catalogs-models-pause/" class="btn btn-neutral float-right" title="Locations Catalogs Models Pause">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/retail2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-catalogs-models-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-catalogs-models-pause/" 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>
|