| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#delete">delete(annotationId, source=None)</a></code></p> |
| 79 | <p class="firstline">Deletes an annotation.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Inserts a new annotation.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 84 | <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> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Retrieves a list of annotations, possibly filtered.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#summary">summary(layerIds, volumeId)</a></code></p> |
| 91 | <p class="firstline">Gets the summary of specified layers.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#update">update(annotationId, body=None, source=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Updates an existing annotation.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="delete">delete(annotationId, source=None)</code> |
| 98 | <pre>Deletes an annotation. |
| 99 | |
| 100 | Args: |
| 101 | annotationId: string, The ID for the annotation to delete. (required) |
| 102 | source: string, String to identify the originator of this request. |
| 103 | </pre> |
| 104 | </div> |
| 105 | |
| 106 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 107 | <code class="details" id="insert">insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 108 | <pre>Inserts a new annotation. |
| 109 | |
| 110 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 111 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | The object takes the form of: |
| 113 | |
| 114 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "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. |
| 116 | "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. |
| 117 | "clientVersionRanges": { # Selection ranges sent from the client. |
| 118 | "cfiRange": { # Range in CFI format for this annotation sent by client. |
| 119 | "endOffset": "A String", # The offset from the ending position. |
| 120 | "endPosition": "A String", # The ending position for the range. |
| 121 | "startOffset": "A String", # The offset from the starting position. |
| 122 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 123 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "contentVersion": "A String", # Content version the client sent in. |
| 125 | "gbImageRange": { # Range in GB image format for this annotation sent by client. |
| 126 | "endOffset": "A String", # The offset from the ending position. |
| 127 | "endPosition": "A String", # The ending position for the range. |
| 128 | "startOffset": "A String", # The offset from the starting position. |
| 129 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 130 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "gbTextRange": { # Range in GB text format for this annotation sent by client. |
| 132 | "endOffset": "A String", # The offset from the ending position. |
| 133 | "endPosition": "A String", # The ending position for the range. |
| 134 | "startOffset": "A String", # The offset from the starting position. |
| 135 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "imageCfiRange": { # Range in image CFI format for this annotation sent by client. |
| 138 | "endOffset": "A String", # The offset from the ending position. |
| 139 | "endPosition": "A String", # The ending position for the range. |
| 140 | "startOffset": "A String", # The offset from the starting position. |
| 141 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 142 | }, |
| 143 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "created": "A String", # Timestamp for the created time of this annotation. |
| 145 | "currentVersionRanges": { # Selection ranges for the most recent content version. |
| 146 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 147 | "endOffset": "A String", # The offset from the ending position. |
| 148 | "endPosition": "A String", # The ending position for the range. |
| 149 | "startOffset": "A String", # The offset from the starting position. |
| 150 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 151 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 153 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 154 | "endOffset": "A String", # The offset from the ending position. |
| 155 | "endPosition": "A String", # The ending position for the range. |
| 156 | "startOffset": "A String", # The offset from the starting position. |
| 157 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 158 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 159 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 160 | "endOffset": "A String", # The offset from the ending position. |
| 161 | "endPosition": "A String", # The ending position for the range. |
| 162 | "startOffset": "A String", # The offset from the starting position. |
| 163 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 164 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "imageCfiRange": { # Range in image CFI format for this annotation for version above. |
| 166 | "endOffset": "A String", # The offset from the ending position. |
| 167 | "endPosition": "A String", # The ending position for the range. |
| 168 | "startOffset": "A String", # The offset from the starting position. |
| 169 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 170 | }, |
| 171 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "data": "A String", # User-created data for this annotation. |
| 173 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 174 | "highlightStyle": "A String", # The highlight style for this annotation. |
| 175 | "id": "A String", # Id of this annotation, in the form of a GUID. |
| 176 | "kind": "books#annotation", # Resource type. |
| 177 | "layerId": "A String", # The layer this annotation is for. |
| 178 | "layerSummary": { |
| 179 | "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer. |
| 180 | "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. |
| 181 | "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 182 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 183 | "pageIds": [ # Pages that this annotation spans. |
| 184 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 185 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "selectedText": "A String", # Excerpt from the volume. |
| 187 | "selfLink": "A String", # URL to this resource. |
| 188 | "updated": "A String", # Timestamp for the last time this annotation was modified. |
| 189 | "volumeId": "A String", # The volume that this annotation belongs to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | } |
| 191 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | annotationId: string, The ID for the annotation to insert. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 193 | country: string, ISO-3166-1 code to override the IP-based location. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 194 | showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | source: string, String to identify the originator of this request. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 196 | |
| 197 | Returns: |
| 198 | An object of the form: |
| 199 | |
| 200 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | "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. |
| 202 | "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. |
| 203 | "clientVersionRanges": { # Selection ranges sent from the client. |
| 204 | "cfiRange": { # Range in CFI format for this annotation sent by client. |
| 205 | "endOffset": "A String", # The offset from the ending position. |
| 206 | "endPosition": "A String", # The ending position for the range. |
| 207 | "startOffset": "A String", # The offset from the starting position. |
| 208 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 209 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 210 | "contentVersion": "A String", # Content version the client sent in. |
| 211 | "gbImageRange": { # Range in GB image format for this annotation sent by client. |
| 212 | "endOffset": "A String", # The offset from the ending position. |
| 213 | "endPosition": "A String", # The ending position for the range. |
| 214 | "startOffset": "A String", # The offset from the starting position. |
| 215 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 216 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 217 | "gbTextRange": { # Range in GB text format for this annotation sent by client. |
| 218 | "endOffset": "A String", # The offset from the ending position. |
| 219 | "endPosition": "A String", # The ending position for the range. |
| 220 | "startOffset": "A String", # The offset from the starting position. |
| 221 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 222 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | "imageCfiRange": { # Range in image CFI format for this annotation sent by client. |
| 224 | "endOffset": "A String", # The offset from the ending position. |
| 225 | "endPosition": "A String", # The ending position for the range. |
| 226 | "startOffset": "A String", # The offset from the starting position. |
| 227 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 228 | }, |
| 229 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 230 | "created": "A String", # Timestamp for the created time of this annotation. |
| 231 | "currentVersionRanges": { # Selection ranges for the most recent content version. |
| 232 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 233 | "endOffset": "A String", # The offset from the ending position. |
| 234 | "endPosition": "A String", # The ending position for the range. |
| 235 | "startOffset": "A String", # The offset from the starting position. |
| 236 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 237 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 238 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 239 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 240 | "endOffset": "A String", # The offset from the ending position. |
| 241 | "endPosition": "A String", # The ending position for the range. |
| 242 | "startOffset": "A String", # The offset from the starting position. |
| 243 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 244 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 245 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 246 | "endOffset": "A String", # The offset from the ending position. |
| 247 | "endPosition": "A String", # The ending position for the range. |
| 248 | "startOffset": "A String", # The offset from the starting position. |
| 249 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 250 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | "imageCfiRange": { # Range in image CFI format for this annotation for version above. |
| 252 | "endOffset": "A String", # The offset from the ending position. |
| 253 | "endPosition": "A String", # The ending position for the range. |
| 254 | "startOffset": "A String", # The offset from the starting position. |
| 255 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 256 | }, |
| 257 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | "data": "A String", # User-created data for this annotation. |
| 259 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 260 | "highlightStyle": "A String", # The highlight style for this annotation. |
| 261 | "id": "A String", # Id of this annotation, in the form of a GUID. |
| 262 | "kind": "books#annotation", # Resource type. |
| 263 | "layerId": "A String", # The layer this annotation is for. |
| 264 | "layerSummary": { |
| 265 | "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer. |
| 266 | "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. |
| 267 | "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 268 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | "pageIds": [ # Pages that this annotation spans. |
| 270 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 271 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 272 | "selectedText": "A String", # Excerpt from the volume. |
| 273 | "selfLink": "A String", # URL to this resource. |
| 274 | "updated": "A String", # Timestamp for the last time this annotation was modified. |
| 275 | "volumeId": "A String", # The volume that this annotation belongs to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 276 | }</pre> |
| 277 | </div> |
| 278 | |
| 279 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 280 | <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> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 281 | <pre>Retrieves a list of annotations, possibly filtered. |
| 282 | |
| 283 | Args: |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 284 | contentVersion: string, The content version for the requested volume. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 285 | layerId: string, The layer ID to limit annotation by. |
| 286 | layerIds: string, The layer ID(s) to limit annotation by. (repeated) |
| 287 | maxResults: integer, Maximum number of results to return |
| 288 | pageToken: string, The value of the nextToken from the previous page. |
| 289 | showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 290 | source: string, String to identify the originator of this request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 291 | updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 292 | updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | volumeId: string, The volume to restrict annotations to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 294 | |
| 295 | Returns: |
| 296 | An object of the form: |
| 297 | |
| 298 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 299 | "items": [ # A list of annotations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 300 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | "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. |
| 302 | "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. |
| 303 | "clientVersionRanges": { # Selection ranges sent from the client. |
| 304 | "cfiRange": { # Range in CFI format for this annotation sent by client. |
| 305 | "endOffset": "A String", # The offset from the ending position. |
| 306 | "endPosition": "A String", # The ending position for the range. |
| 307 | "startOffset": "A String", # The offset from the starting position. |
| 308 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 309 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 310 | "contentVersion": "A String", # Content version the client sent in. |
| 311 | "gbImageRange": { # Range in GB image format for this annotation sent by client. |
| 312 | "endOffset": "A String", # The offset from the ending position. |
| 313 | "endPosition": "A String", # The ending position for the range. |
| 314 | "startOffset": "A String", # The offset from the starting position. |
| 315 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | "gbTextRange": { # Range in GB text format for this annotation sent by client. |
| 318 | "endOffset": "A String", # The offset from the ending position. |
| 319 | "endPosition": "A String", # The ending position for the range. |
| 320 | "startOffset": "A String", # The offset from the starting position. |
| 321 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 322 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "imageCfiRange": { # Range in image CFI format for this annotation sent by client. |
| 324 | "endOffset": "A String", # The offset from the ending position. |
| 325 | "endPosition": "A String", # The ending position for the range. |
| 326 | "startOffset": "A String", # The offset from the starting position. |
| 327 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 328 | }, |
| 329 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 330 | "created": "A String", # Timestamp for the created time of this annotation. |
| 331 | "currentVersionRanges": { # Selection ranges for the most recent content version. |
| 332 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 333 | "endOffset": "A String", # The offset from the ending position. |
| 334 | "endPosition": "A String", # The ending position for the range. |
| 335 | "startOffset": "A String", # The offset from the starting position. |
| 336 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 337 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 339 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 340 | "endOffset": "A String", # The offset from the ending position. |
| 341 | "endPosition": "A String", # The ending position for the range. |
| 342 | "startOffset": "A String", # The offset from the starting position. |
| 343 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 344 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 345 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 346 | "endOffset": "A String", # The offset from the ending position. |
| 347 | "endPosition": "A String", # The ending position for the range. |
| 348 | "startOffset": "A String", # The offset from the starting position. |
| 349 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 350 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 351 | "imageCfiRange": { # Range in image CFI format for this annotation for version above. |
| 352 | "endOffset": "A String", # The offset from the ending position. |
| 353 | "endPosition": "A String", # The ending position for the range. |
| 354 | "startOffset": "A String", # The offset from the starting position. |
| 355 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 356 | }, |
| 357 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "data": "A String", # User-created data for this annotation. |
| 359 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 360 | "highlightStyle": "A String", # The highlight style for this annotation. |
| 361 | "id": "A String", # Id of this annotation, in the form of a GUID. |
| 362 | "kind": "books#annotation", # Resource type. |
| 363 | "layerId": "A String", # The layer this annotation is for. |
| 364 | "layerSummary": { |
| 365 | "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer. |
| 366 | "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. |
| 367 | "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 368 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | "pageIds": [ # Pages that this annotation spans. |
| 370 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 371 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "selectedText": "A String", # Excerpt from the volume. |
| 373 | "selfLink": "A String", # URL to this resource. |
| 374 | "updated": "A String", # Timestamp for the last time this annotation was modified. |
| 375 | "volumeId": "A String", # The volume that this annotation belongs to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 376 | }, |
| 377 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 378 | "kind": "books#annotations", # Resource type. |
| 379 | "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. |
| 380 | "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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 381 | }</pre> |
| 382 | </div> |
| 383 | |
| 384 | <div class="method"> |
| 385 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 386 | <pre>Retrieves the next page of results. |
| 387 | |
| 388 | Args: |
| 389 | previous_request: The request for the previous page. (required) |
| 390 | previous_response: The response from the request for the previous page. (required) |
| 391 | |
| 392 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 393 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 394 | page. Returns None if there are no more items in the collection. |
| 395 | </pre> |
| 396 | </div> |
| 397 | |
| 398 | <div class="method"> |
| 399 | <code class="details" id="summary">summary(layerIds, volumeId)</code> |
| 400 | <pre>Gets the summary of specified layers. |
| 401 | |
| 402 | Args: |
| 403 | layerIds: string, Array of layer IDs to get the summary for. (required) (repeated) |
| 404 | volumeId: string, Volume id to get the summary for. (required) |
| 405 | |
| 406 | Returns: |
| 407 | An object of the form: |
| 408 | |
| 409 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | "kind": "books#annotationsSummary", |
| 411 | "layers": [ |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 412 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 413 | "allowedCharacterCount": 42, |
| 414 | "layerId": "A String", |
| 415 | "limitType": "A String", |
| 416 | "remainingCharacterCount": 42, |
| 417 | "updated": "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 418 | }, |
| 419 | ], |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 420 | }</pre> |
| 421 | </div> |
| 422 | |
| 423 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 424 | <code class="details" id="update">update(annotationId, body=None, source=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 425 | <pre>Updates an existing annotation. |
| 426 | |
| 427 | Args: |
| 428 | annotationId: string, The ID for the annotation to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 429 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 430 | The object takes the form of: |
| 431 | |
| 432 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "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. |
| 434 | "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. |
| 435 | "clientVersionRanges": { # Selection ranges sent from the client. |
| 436 | "cfiRange": { # Range in CFI format for this annotation sent by client. |
| 437 | "endOffset": "A String", # The offset from the ending position. |
| 438 | "endPosition": "A String", # The ending position for the range. |
| 439 | "startOffset": "A String", # The offset from the starting position. |
| 440 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 441 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 442 | "contentVersion": "A String", # Content version the client sent in. |
| 443 | "gbImageRange": { # Range in GB image format for this annotation sent by client. |
| 444 | "endOffset": "A String", # The offset from the ending position. |
| 445 | "endPosition": "A String", # The ending position for the range. |
| 446 | "startOffset": "A String", # The offset from the starting position. |
| 447 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 448 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 449 | "gbTextRange": { # Range in GB text format for this annotation sent by client. |
| 450 | "endOffset": "A String", # The offset from the ending position. |
| 451 | "endPosition": "A String", # The ending position for the range. |
| 452 | "startOffset": "A String", # The offset from the starting position. |
| 453 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 454 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | "imageCfiRange": { # Range in image CFI format for this annotation sent by client. |
| 456 | "endOffset": "A String", # The offset from the ending position. |
| 457 | "endPosition": "A String", # The ending position for the range. |
| 458 | "startOffset": "A String", # The offset from the starting position. |
| 459 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 460 | }, |
| 461 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 462 | "created": "A String", # Timestamp for the created time of this annotation. |
| 463 | "currentVersionRanges": { # Selection ranges for the most recent content version. |
| 464 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 465 | "endOffset": "A String", # The offset from the ending position. |
| 466 | "endPosition": "A String", # The ending position for the range. |
| 467 | "startOffset": "A String", # The offset from the starting position. |
| 468 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 469 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 470 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 471 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 472 | "endOffset": "A String", # The offset from the ending position. |
| 473 | "endPosition": "A String", # The ending position for the range. |
| 474 | "startOffset": "A String", # The offset from the starting position. |
| 475 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 476 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 477 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 478 | "endOffset": "A String", # The offset from the ending position. |
| 479 | "endPosition": "A String", # The ending position for the range. |
| 480 | "startOffset": "A String", # The offset from the starting position. |
| 481 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 482 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 483 | "imageCfiRange": { # Range in image CFI format for this annotation for version above. |
| 484 | "endOffset": "A String", # The offset from the ending position. |
| 485 | "endPosition": "A String", # The ending position for the range. |
| 486 | "startOffset": "A String", # The offset from the starting position. |
| 487 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 488 | }, |
| 489 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 490 | "data": "A String", # User-created data for this annotation. |
| 491 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 492 | "highlightStyle": "A String", # The highlight style for this annotation. |
| 493 | "id": "A String", # Id of this annotation, in the form of a GUID. |
| 494 | "kind": "books#annotation", # Resource type. |
| 495 | "layerId": "A String", # The layer this annotation is for. |
| 496 | "layerSummary": { |
| 497 | "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer. |
| 498 | "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. |
| 499 | "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 500 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 501 | "pageIds": [ # Pages that this annotation spans. |
| 502 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 503 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 504 | "selectedText": "A String", # Excerpt from the volume. |
| 505 | "selfLink": "A String", # URL to this resource. |
| 506 | "updated": "A String", # Timestamp for the last time this annotation was modified. |
| 507 | "volumeId": "A String", # The volume that this annotation belongs to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 508 | } |
| 509 | |
| 510 | source: string, String to identify the originator of this request. |
| 511 | |
| 512 | Returns: |
| 513 | An object of the form: |
| 514 | |
| 515 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | "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. |
| 517 | "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. |
| 518 | "clientVersionRanges": { # Selection ranges sent from the client. |
| 519 | "cfiRange": { # Range in CFI format for this annotation sent by client. |
| 520 | "endOffset": "A String", # The offset from the ending position. |
| 521 | "endPosition": "A String", # The ending position for the range. |
| 522 | "startOffset": "A String", # The offset from the starting position. |
| 523 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 524 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | "contentVersion": "A String", # Content version the client sent in. |
| 526 | "gbImageRange": { # Range in GB image format for this annotation sent by client. |
| 527 | "endOffset": "A String", # The offset from the ending position. |
| 528 | "endPosition": "A String", # The ending position for the range. |
| 529 | "startOffset": "A String", # The offset from the starting position. |
| 530 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 531 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 532 | "gbTextRange": { # Range in GB text format for this annotation sent by client. |
| 533 | "endOffset": "A String", # The offset from the ending position. |
| 534 | "endPosition": "A String", # The ending position for the range. |
| 535 | "startOffset": "A String", # The offset from the starting position. |
| 536 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 537 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 538 | "imageCfiRange": { # Range in image CFI format for this annotation sent by client. |
| 539 | "endOffset": "A String", # The offset from the ending position. |
| 540 | "endPosition": "A String", # The ending position for the range. |
| 541 | "startOffset": "A String", # The offset from the starting position. |
| 542 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 543 | }, |
| 544 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 545 | "created": "A String", # Timestamp for the created time of this annotation. |
| 546 | "currentVersionRanges": { # Selection ranges for the most recent content version. |
| 547 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 548 | "endOffset": "A String", # The offset from the ending position. |
| 549 | "endPosition": "A String", # The ending position for the range. |
| 550 | "startOffset": "A String", # The offset from the starting position. |
| 551 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 552 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 553 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 554 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 555 | "endOffset": "A String", # The offset from the ending position. |
| 556 | "endPosition": "A String", # The ending position for the range. |
| 557 | "startOffset": "A String", # The offset from the starting position. |
| 558 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 559 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 560 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 561 | "endOffset": "A String", # The offset from the ending position. |
| 562 | "endPosition": "A String", # The ending position for the range. |
| 563 | "startOffset": "A String", # The offset from the starting position. |
| 564 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 565 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "imageCfiRange": { # Range in image CFI format for this annotation for version above. |
| 567 | "endOffset": "A String", # The offset from the ending position. |
| 568 | "endPosition": "A String", # The ending position for the range. |
| 569 | "startOffset": "A String", # The offset from the starting position. |
| 570 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 571 | }, |
| 572 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "data": "A String", # User-created data for this annotation. |
| 574 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 575 | "highlightStyle": "A String", # The highlight style for this annotation. |
| 576 | "id": "A String", # Id of this annotation, in the form of a GUID. |
| 577 | "kind": "books#annotation", # Resource type. |
| 578 | "layerId": "A String", # The layer this annotation is for. |
| 579 | "layerSummary": { |
| 580 | "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer. |
| 581 | "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. |
| 582 | "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 583 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | "pageIds": [ # Pages that this annotation spans. |
| 585 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 586 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 587 | "selectedText": "A String", # Excerpt from the volume. |
| 588 | "selfLink": "A String", # URL to this resource. |
| 589 | "updated": "A String", # Timestamp for the last time this annotation was modified. |
| 590 | "volumeId": "A String", # The volume that this annotation belongs to. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 591 | }</pre> |
| 592 | </div> |
| 593 | |
| 594 | </body></html> |