docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/books_v1.mylibrary.annotations.html b/docs/dyn/books_v1.mylibrary.annotations.html
index 25a1f1b..f361ea6 100644
--- a/docs/dyn/books_v1.mylibrary.annotations.html
+++ b/docs/dyn/books_v1.mylibrary.annotations.html
@@ -78,10 +78,10 @@
<code><a href="#delete">delete(annotationId, source=None)</a></code></p>
<p class="firstline">Deletes an annotation.</p>
<p class="toc_element">
- <code><a href="#insert">insert(body=None, source=None, country=None, showOnlySummaryInResponse=None, annotationId=None)</a></code></p>
+ <code><a href="#insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</a></code></p>
<p class="firstline">Inserts a new annotation.</p>
<p class="toc_element">
- <code><a href="#list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</a></code></p>
+ <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>
<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>
@@ -104,7 +104,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(body=None, source=None, country=None, showOnlySummaryInResponse=None, annotationId=None)</code>
+ <code class="details" id="insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</code>
<pre>Inserts a new annotation.
Args:
@@ -112,272 +112,272 @@
The object takes the form of:
{
- "kind": "books#annotation", # Resource type.
- "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. 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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
+ "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.
},
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
+ "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.
}
- source: string, String to identify the originator of this request.
+ 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.
- annotationId: string, The ID for the annotation to insert.
+ source: string, String to identify the originator of this request.
Returns:
An object of the form:
{
- "kind": "books#annotation", # Resource type.
- "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. 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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
+ "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.
},
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
+ "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>
</div>
<div class="method">
- <code class="details" id="list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</code>
+ <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>
<pre>Retrieves a list of annotations, possibly filtered.
Args:
- layerId: string, The layer ID to limit annotation by.
- pageToken: string, The value of the nextToken from the previous page.
- layerIds: string, The layer ID(s) to limit annotation by. (repeated)
- volumeId: string, The volume to restrict annotations to.
- maxResults: integer, Maximum number of results to return
- showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
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).
+ volumeId: string, The volume to restrict annotations to.
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.
+ "items": [ # A list of annotations.
{
- "kind": "books#annotation", # Resource type.
- "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. 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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
+ "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.
},
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
+ "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.
},
],
- "kind": "books#annotations", # Resource type.
- "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": "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.
}</pre>
</div>
@@ -390,7 +390,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -407,16 +407,16 @@
An object of the form:
{
- "layers": [
+ "kind": "books#annotationsSummary",
+ "layers": [
{
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "layerId": "A String",
- "allowedCharacterCount": 42,
+ "allowedCharacterCount": 42,
+ "layerId": "A String",
+ "limitType": "A String",
+ "remainingCharacterCount": 42,
+ "updated": "A String",
},
],
- "kind": "books#annotationsSummary",
}</pre>
</div>
@@ -430,81 +430,81 @@
The object takes the form of:
{
- "kind": "books#annotation", # Resource type.
- "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. 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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
+ "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.
},
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
+ "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.
}
source: string, String to identify the originator of this request.
@@ -513,81 +513,81 @@
An object of the form:
{
- "kind": "books#annotation", # Resource type.
- "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. 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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
- "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.
+ "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.
},
- "cfiRange": { # Range in 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.
+ "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.
},
- "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.
+ "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.
},
- "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.
- "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.
+ "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.
},
},
- "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.
+ "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.
},
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
+ "pageIds": [ # Pages that this annotation spans.
+ "A String",
],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
+ "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>
</div>