docs: update generated docs (#981)
diff --git a/docs/dyn/books_v1.mylibrary.annotations.html b/docs/dyn/books_v1.mylibrary.annotations.html
index f361ea6..836c364 100644
--- a/docs/dyn/books_v1.mylibrary.annotations.html
+++ b/docs/dyn/books_v1.mylibrary.annotations.html
@@ -75,36 +75,45 @@
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.annotations.html">annotations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(annotationId, source=None)</a></code></p>
+ <code><a href="#delete">delete(annotationId, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an annotation.</p>
<p class="toc_element">
- <code><a href="#insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</a></code></p>
+ <code><a href="#insert">insert(body=None, country=None, source=None, annotationId=None, showOnlySummaryInResponse=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new annotation.</p>
<p class="toc_element">
- <code><a href="#list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None)</a></code></p>
+ <code><a href="#list">list(showDeleted=None, source=None, contentVersion=None, volumeId=None, layerIds=None, updatedMax=None, layerId=None, maxResults=None, updatedMin=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#summary">summary(layerIds, volumeId)</a></code></p>
+ <code><a href="#summary">summary(volumeId=None, layerIds=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the summary of specified layers.</p>
<p class="toc_element">
- <code><a href="#update">update(annotationId, body=None, source=None)</a></code></p>
+ <code><a href="#update">update(annotationId, body=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing annotation.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(annotationId, source=None)</code>
+ <code class="details" id="delete">delete(annotationId, source=None, x__xgafv=None)</code>
<pre>Deletes an annotation.
Args:
annotationId: string, The ID for the annotation to delete. (required)
source: string, String to identify the originator of this request.
-</pre>
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</code>
+ <code class="details" id="insert">insert(body=None, country=None, source=None, annotationId=None, showOnlySummaryInResponse=None, x__xgafv=None)</code>
<pre>Inserts a new annotation.
Args:
@@ -112,272 +121,280 @@
The object takes the form of:
{
- "afterSelectedText": "A String", # 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.
- "beforeSelectedText": "A String", # 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.
+ "highlightStyle": "A String", # The highlight style for this annotation.
+ "clientVersionRanges": { # Selection ranges sent from the client.
+ "gbImageRange": { # Range in GB image format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "gbTextRange": { # Range in GB text format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "cfiRange": { # Range in CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version the client sent in.
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ "beforeSelectedText": "A String", # 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.
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
+ ],
+ "selfLink": "A String", # URL to this resource.
+ "updated": "A String", # Timestamp for the last time this annotation was modified.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Id of this annotation, in the form of a GUID.
+ "kind": "A String", # Resource type.
+ "layerId": "A String", # The layer this annotation is for.
+ "volumeId": "A String", # The volume that this annotation belongs to.
+ "created": "A String", # Timestamp for the created time of this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
+ "afterSelectedText": "A String", # 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.
+ "data": "A String", # User-created data for this annotation.
+ "layerSummary": {
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
+ "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ },
+ "currentVersionRanges": { # Selection ranges for the most recent content version.
+ "cfiRange": { # Range in CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+}
+
+ country: string, ISO-3166-1 code to override the IP-based location.
+ source: string, String to identify the originator of this request.
+ annotationId: string, The ID for the annotation to insert.
+ showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "highlightStyle": "A String", # The highlight style for this annotation.
"clientVersionRanges": { # Selection ranges sent from the client.
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version the client sent in.
"gbImageRange": { # Range in GB image format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
"endPosition": "A String", # The ending position for the range.
"startOffset": "A String", # The offset from the starting position.
"startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
"gbTextRange": { # Range in GB text format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
"endPosition": "A String", # The ending position for the range.
"startOffset": "A String", # The offset from the starting position.
"startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
+ "cfiRange": { # Range in CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version the client sent in.
"imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
"endPosition": "A String", # The ending position for the range.
"startOffset": "A String", # The offset from the starting position.
"startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
},
- "created": "A String", # Timestamp for the created time of this annotation.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- },
- "data": "A String", # User-created data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "highlightStyle": "A String", # The highlight style for this annotation.
+ "beforeSelectedText": "A String", # 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.
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
+ ],
+ "selfLink": "A String", # URL to this resource.
+ "updated": "A String", # Timestamp for the last time this annotation was modified.
+ "selectedText": "A String", # Excerpt from the volume.
"id": "A String", # Id of this annotation, in the form of a GUID.
- "kind": "books#annotation", # Resource type.
+ "kind": "A String", # Resource type.
"layerId": "A String", # The layer this annotation is for.
+ "volumeId": "A String", # The volume that this annotation belongs to.
+ "created": "A String", # Timestamp for the created time of this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
+ "afterSelectedText": "A String", # 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.
+ "data": "A String", # User-created data for this annotation.
"layerSummary": {
"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
},
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "selectedText": "A String", # Excerpt from the volume.
- "selfLink": "A String", # URL to this resource.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "volumeId": "A String", # The volume that this annotation belongs to.
- }
-
- annotationId: string, The ID for the annotation to insert.
- country: string, ISO-3166-1 code to override the IP-based location.
- showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "afterSelectedText": "A String", # 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.
- "beforeSelectedText": "A String", # 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.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version the client sent in.
- "gbImageRange": { # Range in GB image format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "currentVersionRanges": { # Selection ranges for the most recent content version.
+ "cfiRange": { # Range in CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "created": "A String", # Timestamp for the created time of this annotation.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "data": "A String", # User-created data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "kind": "books#annotation", # Resource type.
- "layerId": "A String", # The layer this annotation is for.
- "layerSummary": {
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "selectedText": "A String", # Excerpt from the volume.
- "selfLink": "A String", # URL to this resource.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "volumeId": "A String", # The volume that this annotation belongs to.
- }</pre>
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None)</code>
+ <code class="details" id="list">list(showDeleted=None, source=None, contentVersion=None, volumeId=None, layerIds=None, updatedMax=None, layerId=None, maxResults=None, updatedMin=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves a list of annotations, possibly filtered.
Args:
- contentVersion: string, The content version for the requested volume.
- layerId: string, The layer ID to limit annotation by.
- layerIds: string, The layer ID(s) to limit annotation by. (repeated)
- maxResults: integer, Maximum number of results to return
- pageToken: string, The value of the nextToken from the previous page.
showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
source: string, String to identify the originator of this request.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+ contentVersion: string, The content version for the requested volume.
volumeId: string, The volume to restrict annotations to.
+ layerIds: string, The layer ID(s) to limit annotation by. (repeated)
+ updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+ layerId: string, The layer ID to limit annotation by.
+ maxResults: integer, Maximum number of results to return
+ updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+ pageToken: string, The value of the nextToken from the previous page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{
+ "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
"items": [ # A list of annotations.
{
- "afterSelectedText": "A String", # 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.
- "beforeSelectedText": "A String", # 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.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version the client sent in.
- "gbImageRange": { # Range in GB image format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "highlightStyle": "A String", # The highlight style for this annotation.
+ "clientVersionRanges": { # Selection ranges sent from the client.
+ "gbImageRange": { # Range in GB image format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "created": "A String", # Timestamp for the created time of this annotation.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "gbTextRange": { # Range in GB text format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "data": "A String", # User-created data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "kind": "books#annotation", # Resource type.
- "layerId": "A String", # The layer this annotation is for.
- "layerSummary": {
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ "cfiRange": { # Range in CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "selectedText": "A String", # Excerpt from the volume.
- "selfLink": "A String", # URL to this resource.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "volumeId": "A String", # The volume that this annotation belongs to.
+ "contentVersion": "A String", # Content version the client sent in.
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
},
+ "beforeSelectedText": "A String", # 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.
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
+ ],
+ "selfLink": "A String", # URL to this resource.
+ "updated": "A String", # Timestamp for the last time this annotation was modified.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Id of this annotation, in the form of a GUID.
+ "kind": "A String", # Resource type.
+ "layerId": "A String", # The layer this annotation is for.
+ "volumeId": "A String", # The volume that this annotation belongs to.
+ "created": "A String", # Timestamp for the created time of this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
+ "afterSelectedText": "A String", # 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.
+ "data": "A String", # User-created data for this annotation.
+ "layerSummary": {
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
+ "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ },
+ "currentVersionRanges": { # Selection ranges for the most recent content version.
+ "cfiRange": { # Range in CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ },
],
- "kind": "books#annotations", # Resource type.
- "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
"totalItems": 42, # Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
+ "kind": "A String", # Resource type.
}</pre>
</div>
@@ -396,32 +413,36 @@
</div>
<div class="method">
- <code class="details" id="summary">summary(layerIds, volumeId)</code>
+ <code class="details" id="summary">summary(volumeId=None, layerIds=None, x__xgafv=None)</code>
<pre>Gets the summary of specified layers.
Args:
- layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
- volumeId: string, Volume id to get the summary for. (required)
+ volumeId: string, Volume id to get the summary for.
+ layerIds: string, Array of layer IDs to get the summary for. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{
- "kind": "books#annotationsSummary",
"layers": [
{
+ "updated": "A String",
"allowedCharacterCount": 42,
+ "remainingCharacterCount": 42,
"layerId": "A String",
"limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
},
],
+ "kind": "A String",
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(annotationId, body=None, source=None)</code>
+ <code class="details" id="update">update(annotationId, body=None, source=None, x__xgafv=None)</code>
<pre>Updates an existing annotation.
Args:
@@ -430,165 +451,169 @@
The object takes the form of:
{
- "afterSelectedText": "A String", # 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.
- "beforeSelectedText": "A String", # 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.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version the client sent in.
- "gbImageRange": { # Range in GB image format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "highlightStyle": "A String", # The highlight style for this annotation.
+ "clientVersionRanges": { # Selection ranges sent from the client.
+ "gbImageRange": { # Range in GB image format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "created": "A String", # Timestamp for the created time of this annotation.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "gbTextRange": { # Range in GB text format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "data": "A String", # User-created data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "kind": "books#annotation", # Resource type.
- "layerId": "A String", # The layer this annotation is for.
- "layerSummary": {
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ "cfiRange": { # Range in CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "selectedText": "A String", # Excerpt from the volume.
- "selfLink": "A String", # URL to this resource.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "volumeId": "A String", # The volume that this annotation belongs to.
- }
+ "contentVersion": "A String", # Content version the client sent in.
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ "beforeSelectedText": "A String", # 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.
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
+ ],
+ "selfLink": "A String", # URL to this resource.
+ "updated": "A String", # Timestamp for the last time this annotation was modified.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Id of this annotation, in the form of a GUID.
+ "kind": "A String", # Resource type.
+ "layerId": "A String", # The layer this annotation is for.
+ "volumeId": "A String", # The volume that this annotation belongs to.
+ "created": "A String", # Timestamp for the created time of this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
+ "afterSelectedText": "A String", # 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.
+ "data": "A String", # User-created data for this annotation.
+ "layerSummary": {
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
+ "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ },
+ "currentVersionRanges": { # Selection ranges for the most recent content version.
+ "cfiRange": { # Range in CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+}
source: string, String to identify the originator of this request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{
- "afterSelectedText": "A String", # 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.
- "beforeSelectedText": "A String", # 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.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "cfiRange": { # Range in CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version the client sent in.
- "gbImageRange": { # Range in GB image format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "highlightStyle": "A String", # The highlight style for this annotation.
+ "clientVersionRanges": { # Selection ranges sent from the client.
+ "gbImageRange": { # Range in GB image format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "created": "A String", # Timestamp for the created time of this annotation.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "cfiRange": { # Range in CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation for version above.
- "endOffset": "A String", # The offset from the ending position.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- },
+ "gbTextRange": { # Range in GB text format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "data": "A String", # User-created data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "kind": "books#annotation", # Resource type.
- "layerId": "A String", # The layer this annotation is for.
- "layerSummary": {
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ "cfiRange": { # Range in CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
},
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "selectedText": "A String", # Excerpt from the volume.
- "selfLink": "A String", # URL to this resource.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "volumeId": "A String", # The volume that this annotation belongs to.
- }</pre>
+ "contentVersion": "A String", # Content version the client sent in.
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ "beforeSelectedText": "A String", # 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.
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
+ ],
+ "selfLink": "A String", # URL to this resource.
+ "updated": "A String", # Timestamp for the last time this annotation was modified.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Id of this annotation, in the form of a GUID.
+ "kind": "A String", # Resource type.
+ "layerId": "A String", # The layer this annotation is for.
+ "volumeId": "A String", # The volume that this annotation belongs to.
+ "created": "A String", # Timestamp for the created time of this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
+ "afterSelectedText": "A String", # 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.
+ "data": "A String", # User-created data for this annotation.
+ "layerSummary": {
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
+ "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
+ },
+ "currentVersionRanges": { # Selection ranges for the most recent content version.
+ "cfiRange": { # Range in CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ },
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file