Refresh docs
diff --git a/docs/dyn/books_v1.mylibrary.annotations.html b/docs/dyn/books_v1.mylibrary.annotations.html
index 69c36a7..b2da444 100644
--- a/docs/dyn/books_v1.mylibrary.annotations.html
+++ b/docs/dyn/books_v1.mylibrary.annotations.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(annotationId, source=None)</a></code></p>
<p class="firstline">Gets an annotation by its ID.</p>
<p class="toc_element">
- <code><a href="#insert">insert(body, source=None)</a></code></p>
+ <code><a href="#insert">insert(body, source=None, showOnlySummaryInResponse=None)</a></code></p>
<p class="firstline">Inserts a new annotation.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=None)</a></code></p>
@@ -90,6 +90,9 @@
<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>
+<p class="firstline">Gets the summary of specified layers.</p>
+<p class="toc_element">
<code><a href="#update">update(annotationId, body, source=None)</a></code></p>
<p class="firstline">Updates an existing annotation.</p>
<h3>Method Details</h3>
@@ -119,7 +122,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -134,6 +137,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -141,7 +150,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -156,6 +165,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -163,6 +178,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",
@@ -177,7 +197,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(body, source=None)</code>
+ <code class="details" id="insert">insert(body, source=None, showOnlySummaryInResponse=None)</code>
<pre>Inserts a new annotation.
Args:
@@ -189,7 +209,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -204,6 +224,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -211,7 +237,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -226,6 +252,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -233,6 +265,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",
@@ -246,6 +283,7 @@
}
source: string, String to identify the originator of this request.
+ showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
Returns:
An object of the form:
@@ -255,7 +293,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -270,6 +308,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -277,7 +321,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -292,6 +336,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -299,6 +349,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",
@@ -339,7 +394,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -354,6 +409,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -361,7 +422,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -376,6 +437,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -383,6 +450,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",
@@ -415,6 +487,31 @@
</div>
<div class="method">
+ <code class="details" id="summary">summary(layerIds, volumeId)</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)
+
+Returns:
+ An object of the form:
+
+ {
+ "layers": [
+ {
+ "limitType": "A String",
+ "remainingCharacterCount": 42,
+ "updated": "A String",
+ "layerId": "A String",
+ "allowedCharacterCount": 42,
+ },
+ ],
+ "kind": "books#annotationsSummary",
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(annotationId, body, source=None)</code>
<pre>Updates an existing annotation.
@@ -428,7 +525,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -443,6 +540,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -450,7 +553,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -465,6 +568,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -472,6 +581,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",
@@ -494,7 +608,7 @@
"updated": "A String", # Timestamp for the last time this annotation was modified.
"created": "A String", # Timestamp for the created time of this annotation.
"deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt.
+ "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.
"currentVersionRanges": { # Selection ranges for the most recent content version.
"contentVersion": "A String", # Content version applicable to ranges below.
"gbTextRange": { # Range in GB text format for this annotation for version above.
@@ -509,6 +623,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation for version above.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation for version above.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -516,7 +636,7 @@
"endOffset": "A String", # The offset from the ending position.
},
},
- "afterSelectedText": "A String", # Anchor text after excerpt.
+ "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.
"clientVersionRanges": { # Selection ranges sent from the client.
"contentVersion": "A String", # Content version the client sent in.
"gbTextRange": { # Range in GB text format for this annotation sent by client.
@@ -531,6 +651,12 @@
"startOffset": "A String", # The offset from the starting position.
"endOffset": "A String", # The offset from the ending position.
},
+ "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
+ "startPosition": "A String", # The starting position for the range.
+ "endPosition": "A String", # The ending position for the range.
+ "startOffset": "A String", # The offset from the starting position.
+ "endOffset": "A String", # The offset from the ending position.
+ },
"gbImageRange": { # Range in GB image format for this annotation sent by client.
"startPosition": "A String", # The starting position for the range.
"endPosition": "A String", # The ending position for the range.
@@ -538,6 +664,11 @@
"endOffset": "A String", # The offset from the ending position.
},
},
+ "layerSummary": {
+ "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.
+ "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
+ },
"volumeId": "A String", # The volume that this annotation belongs to.
"pageIds": [ # Pages that this annotation spans.
"A String",