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