OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-30 22:03:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_retail2_cli/projects_locations-catalogs-completion-data-import/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

460 lines
19 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>Locations Catalogs Completion Data Import - Cloud Retail v3.0.0+20220224</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"> Cloud Retail v3.0.0+20220224</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-operations-get">Locations Catalogs Branches Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-add-fulfillment-places">Locations Catalogs Branches Products Add Fulfillment Places</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-create">Locations Catalogs Branches Products Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-delete">Locations Catalogs Branches Products Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-get">Locations Catalogs Branches Products Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-import">Locations Catalogs Branches Products Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-list">Locations Catalogs Branches Products List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-patch">Locations Catalogs Branches Products Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-remove-fulfillment-places">Locations Catalogs Branches Products Remove Fulfillment Places</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-branches-products-set-inventory">Locations Catalogs Branches Products Set Inventory</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-complete-query">Locations Catalogs Complete Query</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Catalogs Completion Data Import</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="../projects_locations-catalogs-get-default-branch">Locations Catalogs Get Default Branch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-list">Locations Catalogs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-operations-get">Locations Catalogs Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-operations-list">Locations Catalogs Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-patch">Locations Catalogs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-placements-predict">Locations Catalogs Placements Predict</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-placements-search">Locations Catalogs Placements Search</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-set-default-branch">Locations Catalogs Set Default Branch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-user-events-collect">Locations Catalogs User Events Collect</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-user-events-import">Locations Catalogs User Events Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-user-events-purge">Locations Catalogs User Events Purge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-user-events-rejoin">Locations Catalogs User Events Rejoin</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-catalogs-user-events-write">Locations Catalogs User Events Write</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-list">Operations 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>Locations Catalogs Completion Data Import</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/retail2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Bulk import of processed completion dataset. Request processing may be synchronous. Partial updating is not supported. This feature is only available for users who have Retail Search enabled. Please submit a form <a href="https://cloud.google.com/contact">here</a> to contact cloud sales if you are interested in using Retail Search.</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 &lt;scope&gt; projects locations-catalogs-completion-data-import ...</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 catalog which the suggestions dataset belongs to. Format: <code>projects/1234/locations/global/catalogs/default_catalog</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>GoogleCloudRetailV2ImportCompletionDataRequest:
input-config:
big-query-source:
data-schema: string
dataset-id: string
gcs-staging-dir: string
partition-date:
day: integer
month: integer
year: integer
project-id: string
table-id: string
notification-pubsub-topic: 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 .input-config.big-query-source data-schema=dolores</code><ul>
<li>The schema to use when parsing the data from the source. Supported values for product imports: * <code>product</code> (default): One JSON Product per line. Each product must have a valid Product.id. * <code>product_merchant_center</code>: See <a href="https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc">Importing catalog data from Merchant Center</a>. Supported values for user events imports: * <code>user_event</code> (default): One JSON UserEvent per line. * <code>user_event_ga360</code>: The schema is available here: https://support.google.com/analytics/answer/3437719. * <code>user_event_ga4</code>: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846.</li>
</ul>
</li>
<li><code>dataset-id=consetetur</code><ul>
<li>Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.</li>
</ul>
</li>
<li><code>gcs-staging-dir=gubergren</code><ul>
<li>Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.</li>
</ul>
</li>
<li><code>partition-date day=97</code><ul>
<li>Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#39;t significant.</li>
</ul>
</li>
<li><code>month=69</code><ul>
<li>Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.</li>
</ul>
</li>
<li>
<p><code>year=40</code></p>
<ul>
<li>Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.</li>
</ul>
</li>
<li>
<p><code>.. project-id=amet.</code></p>
<ul>
<li>The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.</li>
</ul>
</li>
<li>
<p><code>table-id=ipsum</code></p>
<ul>
<li>Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.</li>
</ul>
</li>
<li>
<p><code>... notification-pubsub-topic=lorem</code></p>
<ul>
<li>Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is <code>projects/{project}/topics/{topic}</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. &#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="../projects_locations-catalogs-get-default-branch" class="btn btn-neutral float-right" title="Locations Catalogs Get Default Branch"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-catalogs-complete-query" class="btn btn-neutral" title="Locations Catalogs Complete Query"><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="../projects_locations-catalogs-complete-query" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-catalogs-get-default-branch" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink