mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
368 lines
18 KiB
HTML
368 lines
18 KiB
HTML
<!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>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 ">
|
|
<a class="" href="projects_locations-catalogs-completion-data-import/">Locations Catalogs Completion Data Import</a>
|
|
|
|
</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>
|
|
|
|
</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> »</li>
|
|
<li>Home</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">
|
|
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/mako/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
|
|
<p>The <code>retail2</code> command-line interface <em>(CLI)</em> allows to use most features of the <em>Google Cloud Retail</em> service from the comfort of your terminal.</p>
|
|
<p>By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's
|
|
capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero.</p>
|
|
<p>If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.</p>
|
|
<p>Everything else about the <em>Cloud Retail</em> API can be found at the
|
|
<a href="https://cloud.google.com/recommendations">official documentation site</a>.</p>
|
|
<h1 id="installation-and-source-code">Installation and Source Code</h1>
|
|
<p>Install the command-line interface with cargo using:</p>
|
|
<pre><code class="bash">cargo install google-retail2-cli
|
|
</code></pre>
|
|
|
|
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/retail2-cli">on github</a>.</p>
|
|
<h1 id="usage">Usage</h1>
|
|
<p>This documentation was generated from the <em>Cloud Retail</em> API at revision <em>20220224</em>. The CLI is at version <em>3.0.0</em>.</p>
|
|
<pre><code class="bash">retail2 [options]
|
|
projects
|
|
locations-catalogs-branches-operations-get <name> [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-add-fulfillment-places <product> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-delete <name> [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-get <name> [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-list <parent> [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-remove-fulfillment-places <product> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-branches-products-set-inventory <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-complete-query <catalog> [-p <v>]... [-o <out>]
|
|
locations-catalogs-completion-data-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-get-default-branch <catalog> [-p <v>]... [-o <out>]
|
|
locations-catalogs-list <parent> [-p <v>]... [-o <out>]
|
|
locations-catalogs-operations-get <name> [-p <v>]... [-o <out>]
|
|
locations-catalogs-operations-list <name> [-p <v>]... [-o <out>]
|
|
locations-catalogs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-placements-predict <placement> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-placements-search <placement> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-set-default-branch <catalog> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-user-events-collect <parent> [-p <v>]... [-o <out>]
|
|
locations-catalogs-user-events-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-user-events-purge <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-user-events-rejoin <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-catalogs-user-events-write <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-operations-get <name> [-p <v>]... [-o <out>]
|
|
locations-operations-list <name> [-p <v>]... [-o <out>]
|
|
operations-get <name> [-p <v>]... [-o <out>]
|
|
operations-list <name> [-p <v>]... [-o <out>]
|
|
retail2 --help
|
|
|
|
Configuration:
|
|
[--scope <url>]...
|
|
Specify the authentication a method should be executed in. Each scope
|
|
requires the user to grant this application permission to use it.
|
|
If unset, it defaults to the shortest scope url for a particular method.
|
|
--config-dir <folder>
|
|
A directory into which we will store our persistent data. Defaults to
|
|
a user-writable directory that we will create during the first invocation.
|
|
[default: ~/.google-service-cli]
|
|
|
|
</code></pre>
|
|
|
|
<h1 id="configuration">Configuration</h1>
|
|
<p>The program will store all persistent data in the <code>~/.google-service-cli</code> directory in <em>JSON</em> files prefixed with <code>retail2-</code>. You can change the directory used to store configuration with the <code>--config-dir</code> flag on a per-invocation basis.</p>
|
|
<p>More information about the various kinds of persistent data are given in the following paragraphs.</p>
|
|
<h1 id="authentication">Authentication</h1>
|
|
<p>Most APIs require a user to authenticate any request. If this is the case, the <a href="https://developers.google.com/+/api/oauth#scopes">scope</a> determines the
|
|
set of permissions granted. The granularity of these is usually no more than <em>read-only</em> or <em>full-access</em>.</p>
|
|
<p>If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a
|
|
method that is read-only, it will ask only for a read-only scope.
|
|
You may use the <code>--scope</code> flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.</p>
|
|
<p>The first time a scope is used, the user is asked for permission. Follow the instructions given
|
|
by the CLI to grant permissions, or to decline.</p>
|
|
<p>If a scope was authenticated by the user, the respective information will be stored as <em>JSON</em> in the configuration
|
|
directory, e.g. <code>~/.google-service-cli/retail2-token-<scope-hash>.json</code>. No manual management of these tokens
|
|
is necessary.</p>
|
|
<p>To revoke granted authentication, please refer to the <a href="http://webapps.stackexchange.com/a/30849">official documentation</a>.</p>
|
|
<h1 id="application-secrets">Application Secrets</h1>
|
|
<p>In order to allow any application to use Google services, it will need to be registered using the
|
|
<a href="https://console.developers.google.com/">Google Developer Console</a>. APIs the application may use are then enabled for it
|
|
one by one. Most APIs can be used for free and have a daily quota.</p>
|
|
<p>To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI
|
|
comes with a default application secret that is configured accordingly. This also means that heavy usage
|
|
all around the world may deplete the daily quota.</p>
|
|
<p>You can workaround this limitation by putting your own secrets file at this location:
|
|
<code>~/.google-service-cli/retail2-secret.json</code>, assuming that the required <em>retail</em> API
|
|
was enabled for it. Such a secret file can be downloaded in the <em>Google Developer Console</em> at
|
|
<em>APIs & auth -> Credentials -> Download JSON</em> and used as is.</p>
|
|
<p>Learn more about how to setup Google projects and enable APIs using the <a href="https://developers.google.com/console/help/new/">official documentation</a>.</p>
|
|
<h1 id="debugging">Debugging</h1>
|
|
<p>Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know
|
|
what exactly led to a particular issue. This is done by allowing all client-server communication to be
|
|
output to standard error <em>as-is</em>.</p>
|
|
<p>The <code>--debug</code> flag will print errors using the <code>Debug</code> representation to standard error.</p>
|
|
<p>You may consider redirecting standard error into a file for ease of use, e.g. <code>retail2 --debug <resource> <method> [options] 2>debug.txt</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="projects_locations-catalogs-branches-operations-get/" class="btn btn-neutral float-right" title="Locations Catalogs Branches Operations Get"/>Next <span class="icon icon-circle-arrow-right"></span></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="" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="projects_locations-catalogs-branches-operations-get/" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |