mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
705 lines
26 KiB
HTML
705 lines
26 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-books1-cli/mylibrary_annotations-insert/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Annotations Insert - books 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 = "Annotations Insert";
|
|
var mkdocs_page_input_path = "mylibrary_annotations-insert.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-books1-cli/mylibrary_annotations-insert/";
|
|
</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"> books 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">Bookshelves</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bookshelves_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bookshelves_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bookshelves_volumes-list/">Volumes List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Cloudloading</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cloudloading_add-book/">Add Book</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cloudloading_delete-book/">Delete Book</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cloudloading_update-book/">Update Book</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Dictionary</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../dictionary_list-offline-metadata/">List Offline Metadata</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Familysharing</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../familysharing_get-family-info/">Get Family Info</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../familysharing_share/">Share</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../familysharing_unshare/">Unshare</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Layers</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_annotation-data-get/">Annotation Data Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_annotation-data-list/">Annotation Data List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_volume-annotations-get/">Volume Annotations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../layers_volume-annotations-list/">Volume Annotations List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Myconfig</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../myconfig_get-user-settings/">Get User Settings</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../myconfig_release-download-access/">Release Download Access</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../myconfig_request-access/">Request Access</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../myconfig_sync-volume-licenses/">Sync Volume Licenses</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../myconfig_update-user-settings/">Update User Settings</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Mylibrary</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_annotations-delete/">Annotations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Annotations Insert</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_annotations-list/">Annotations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_annotations-summary/">Annotations Summary</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_annotations-update/">Annotations Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-add-volume/">Bookshelves Add Volume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-clear-volumes/">Bookshelves Clear Volumes</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-get/">Bookshelves Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-list/">Bookshelves List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-move-volume/">Bookshelves Move Volume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-remove-volume/">Bookshelves Remove Volume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_bookshelves-volumes-list/">Bookshelves Volumes List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_readingpositions-get/">Readingpositions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../mylibrary_readingpositions-set-position/">Readingpositions Set Position</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Notification</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../notification_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Onboarding</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../onboarding_list-categories/">List Categories</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../onboarding_list-category-volumes/">List Category Volumes</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Personalizedstream</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../personalizedstream_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Promooffer</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../promooffer_accept/">Accept</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../promooffer_dismiss/">Dismiss</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../promooffer_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Series</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../series_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../series_membership-get/">Membership Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Volumes</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_associated-list/">Associated List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_mybooks-list/">Mybooks List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_recommended-list/">Recommended List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_recommended-rate/">Recommended Rate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../volumes_useruploaded-list/">Useruploaded 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="..">books 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>Mylibrary »</li>
|
|
<li>Annotations Insert</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/books1-cli/edit/master/docs/mylibrary_annotations-insert.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>Inserts a new annotation.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/books</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/books</em>.
|
|
You can set the scope for this method like this: <code>books1 --scope <scope> mylibrary annotations-insert ...</code></p>
|
|
<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>Annotation:
|
|
after-selected-text: string
|
|
before-selected-text: string
|
|
client-version-ranges:
|
|
cfi-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
content-version: string
|
|
gb-image-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
gb-text-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
image-cfi-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
created: string
|
|
current-version-ranges:
|
|
cfi-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
content-version: string
|
|
gb-image-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
gb-text-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
image-cfi-range:
|
|
end-offset: string
|
|
end-position: string
|
|
start-offset: string
|
|
start-position: string
|
|
data: string
|
|
deleted: boolean
|
|
highlight-style: string
|
|
id: string
|
|
kind: string
|
|
layer-id: string
|
|
layer-summary:
|
|
allowed-character-count: integer
|
|
limit-type: string
|
|
remaining-character-count: integer
|
|
page-ids: [string]
|
|
selected-text: string
|
|
self-link: string
|
|
updated: string
|
|
volume-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><code>-r . after-selected-text=gubergren</code><ul>
|
|
<li>Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>before-selected-text=lorem</code><ul>
|
|
<li>Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>client-version-ranges.cfi-range end-offset=gubergren</code><ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=eos</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=dolor</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=ea</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. content-version=ipsum</code></p>
|
|
<ul>
|
|
<li>Content version the client sent in.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gb-image-range end-offset=invidunt</code><ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=amet</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=duo</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=ipsum</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..gb-text-range end-offset=sed</code></p>
|
|
<ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=ut</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=gubergren</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=rebum.</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..image-cfi-range end-offset=est</code></p>
|
|
<ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=ipsum</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=ipsum</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=est</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... created=gubergren</code></p>
|
|
<ul>
|
|
<li>Timestamp for the created time of this annotation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>current-version-ranges.cfi-range end-offset=ea</code><ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=dolor</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=lorem</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=eos</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. content-version=labore</code></p>
|
|
<ul>
|
|
<li>Content version applicable to ranges below.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gb-image-range end-offset=sed</code><ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=duo</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=sed</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=no</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..gb-text-range end-offset=stet</code></p>
|
|
<ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=kasd</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=et</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=sed</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..image-cfi-range end-offset=et</code></p>
|
|
<ul>
|
|
<li>The offset from the ending position.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-position=et</code><ul>
|
|
<li>The ending position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-offset=vero</code><ul>
|
|
<li>The offset from the starting position.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-position=erat</code></p>
|
|
<ul>
|
|
<li>The starting position for the range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... data=sed</code></p>
|
|
<ul>
|
|
<li>User-created data for this annotation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>deleted=false</code><ul>
|
|
<li>Indicates that this annotation is deleted.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>highlight-style=diam</code><ul>
|
|
<li>The highlight style for this annotation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=dolor</code><ul>
|
|
<li>Id of this annotation, in the form of a GUID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=et</code><ul>
|
|
<li>Resource type.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>layer-id=et</code><ul>
|
|
<li>The layer this annotation is for.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>layer-summary allowed-character-count=6</code><ul>
|
|
<li>Maximum allowed characters on this layer, especially for the "copy" layer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>limit-type=stet</code><ul>
|
|
<li>Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>remaining-character-count=2</code></p>
|
|
<ul>
|
|
<li>Remaining allowed characters on this layer, especially for the "copy" layer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. page-ids=duo</code></p>
|
|
<ul>
|
|
<li>Pages that this annotation spans.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>selected-text=vero</code><ul>
|
|
<li>Excerpt from the volume.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=vero</code><ul>
|
|
<li>URL to this resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>updated=invidunt</code><ul>
|
|
<li>Timestamp for the last time this annotation was modified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>volume-id=stet</code><ul>
|
|
<li>The volume that this annotation belongs to.</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>
|
|
<p><strong>-p annotation-id=string</strong></p>
|
|
<ul>
|
|
<li>The ID for the annotation to insert.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p country=string</strong></p>
|
|
<ul>
|
|
<li>ISO-3166-1 code to override the IP-based location.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p show-only-summary-in-response=boolean</strong></p>
|
|
<ul>
|
|
<li>Requests that only the summary of the specified layer be provided in the response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p source=string</strong></p>
|
|
<ul>
|
|
<li>String to identify the originator of this request.</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="../mylibrary_annotations-delete/" class="btn btn-neutral float-left" title="Annotations Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../mylibrary_annotations-list/" class="btn btn-neutral float-right" title="Annotations List">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/books1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../mylibrary_annotations-delete/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../mylibrary_annotations-list/" 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>
|