mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
385 lines
18 KiB
HTML
385 lines
18 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-recommendationengine1_beta1-cli/projects_locations-catalogs-catalog-items-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Catalogs Catalog Items Patch - Recommendations AI v5.0.4+20240229</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 Catalog Items Patch";
|
|
var mkdocs_page_input_path = "projects_locations-catalogs-catalog-items-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-recommendationengine1_beta1-cli/projects_locations-catalogs-catalog-items-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"> Recommendations AI v5.0.4+20240229
|
|
</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-catalog-items-create/">Locations Catalogs Catalog Items Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-catalog-items-delete/">Locations Catalogs Catalog Items Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-catalog-items-get/">Locations Catalogs Catalog Items Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-catalog-items-import/">Locations Catalogs Catalog Items Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-catalog-items-list/">Locations Catalogs Catalog Items List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Catalogs Catalog Items Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-operations-get/">Locations Catalogs Event Stores Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-operations-list/">Locations Catalogs Event Stores Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-placements-predict/">Locations Catalogs Event Stores Placements Predict</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-prediction-api-key-registrations-create/">Locations Catalogs Event Stores Prediction Api Key Registrations Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-prediction-api-key-registrations-delete/">Locations Catalogs Event Stores Prediction Api Key Registrations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-prediction-api-key-registrations-list/">Locations Catalogs Event Stores Prediction Api Key Registrations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-collect/">Locations Catalogs Event Stores User Events Collect</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-import/">Locations Catalogs Event Stores User Events Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-list/">Locations Catalogs Event Stores User Events List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-purge/">Locations Catalogs Event Stores User Events Purge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-rejoin/">Locations Catalogs Event Stores User Events Rejoin</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-catalogs-event-stores-user-events-write/">Locations Catalogs Event Stores User Events Write</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-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>
|
|
</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="..">Recommendations AI v5.0.4+20240229</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 Catalog Items Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/recommendationengine1_beta1-cli/edit/master/docs/projects_locations-catalogs-catalog-items-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>Updates a catalog item. Partial updating is supported. Non-existing items will be created.</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>recommendationengine1-beta1 --scope <scope> projects locations-catalogs-catalog-items-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. Full resource name of catalog item, such as <code>projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id</code>.</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>GoogleCloudRecommendationengineV1beta1CatalogItem:
|
|
description: string
|
|
id: string
|
|
item-group-id: string
|
|
language-code: string
|
|
product-metadata:
|
|
available-quantity: string
|
|
canonical-product-uri: string
|
|
costs: { string: number }
|
|
currency-code: string
|
|
exact-price:
|
|
display-price: number
|
|
original-price: number
|
|
price-range:
|
|
max: number
|
|
min: number
|
|
stock-state: string
|
|
tags: [string]
|
|
title: 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 . description=gubergren</code><ul>
|
|
<li>Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=rebum.</code><ul>
|
|
<li>Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>item-group-id=est</code><ul>
|
|
<li>Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. <a href="/recommendations-ai/docs/catalog#item-group-id">Learn more</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>language-code=ipsum</code><ul>
|
|
<li>Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>product-metadata available-quantity=ipsum</code><ul>
|
|
<li>Optional. The available quantity of the item.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>canonical-product-uri=est</code><ul>
|
|
<li>Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>costs=key=0.8000651323113592</code><ul>
|
|
<li>Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>currency-code=ea</code><ul>
|
|
<li>Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>exact-price display-price=0.017825676742989738</code><ul>
|
|
<li>Optional. Display price of the product.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>original-price=0.353169646817869</code></p>
|
|
<ul>
|
|
<li>Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..price-range max=0.11853734747270994</code></p>
|
|
<ul>
|
|
<li>Required. The maximum product price.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>min=0.24638057468506236</code></p>
|
|
<ul>
|
|
<li>Required. The minimum product price.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. stock-state=sed</code></p>
|
|
<ul>
|
|
<li>Optional. Online stock state of the catalog item. Default is <code>IN_STOCK</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. tags=no</code></p>
|
|
<ul>
|
|
<li>Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>title=stet</code><ul>
|
|
<li>Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.</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 'item' to update. If not set, will by default update 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-catalog-items-list/" class="btn btn-neutral float-left" title="Locations Catalogs Catalog Items List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-catalogs-event-stores-operations-get/" class="btn btn-neutral float-right" title="Locations Catalogs Event Stores Operations 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/recommendationengine1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-catalogs-catalog-items-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-catalogs-event-stores-operations-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>
|