| Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an annotation.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | source: string, String to identify the originator of this request.<br> |
| 21 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 22 | annotationId: string, The annotation identifier for the annotation to delete. (required)</tt></dd></dl> |
| 23 | |
| 24 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets an annotation by its id.<br> |
| 25 | <br> |
| 26 | Args:<br> |
| 27 | source: string, String to identify the originator of this request.<br> |
| 28 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 29 | annotationId: string, The annotation identifier for the annotation to retrieve. (required)<br> |
| 30 | <br> |
| 31 | Returns:<br> |
| 32 | An object of the form<br> |
| 33 | <br> |
| 34 | {<br> |
| 35 | "kind": "books#annotation", # Resource type.<br> |
| 36 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 37 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 38 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 39 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 40 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 41 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 42 | "startPosition": "A String", # The starting position for the range.<br> |
| 43 | "endPosition": "A String", # The ending position for the range.<br> |
| 44 | "startOffset": "A String", # The offset from the starting position.<br> |
| 45 | "endOffset": "A String", # The offset from the ending position.<br> |
| 46 | },<br> |
| 47 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 48 | "startPosition": "A String", # The starting position for the range.<br> |
| 49 | "endPosition": "A String", # The ending position for the range.<br> |
| 50 | "startOffset": "A String", # The offset from the starting position.<br> |
| 51 | "endOffset": "A String", # The offset from the ending position.<br> |
| 52 | },<br> |
| 53 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 54 | "startPosition": "A String", # The starting position for the range.<br> |
| 55 | "endPosition": "A String", # The ending position for the range.<br> |
| 56 | "startOffset": "A String", # The offset from the starting position.<br> |
| 57 | "endOffset": "A String", # The offset from the ending position.<br> |
| 58 | },<br> |
| 59 | },<br> |
| 60 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 61 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 62 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 63 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 64 | "startPosition": "A String", # The starting position for the range.<br> |
| 65 | "endPosition": "A String", # The ending position for the range.<br> |
| 66 | "startOffset": "A String", # The offset from the starting position.<br> |
| 67 | "endOffset": "A String", # The offset from the ending position.<br> |
| 68 | },<br> |
| 69 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 70 | "startPosition": "A String", # The starting position for the range.<br> |
| 71 | "endPosition": "A String", # The ending position for the range.<br> |
| 72 | "startOffset": "A String", # The offset from the starting position.<br> |
| 73 | "endOffset": "A String", # The offset from the ending position.<br> |
| 74 | },<br> |
| 75 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 76 | "startPosition": "A String", # The starting position for the range.<br> |
| 77 | "endPosition": "A String", # The ending position for the range.<br> |
| 78 | "startOffset": "A String", # The offset from the starting position.<br> |
| 79 | "endOffset": "A String", # The offset from the ending position.<br> |
| 80 | },<br> |
| 81 | },<br> |
| 82 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 83 | "pageIds": [ # Pages that this annotation spans.<br> |
| 84 | "A String",<br> |
| 85 | ],<br> |
| 86 | "layerId": "A String", # The layer this annotation is for.<br> |
| 87 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 88 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 89 | "data": "A String", # User-created data for this annotation.<br> |
| 90 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 91 | "selfLink": "A String", # URL to this resource.<br> |
| 92 | }</tt></dd></dl> |
| 93 | |
| 94 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new annotation.<br> |
| 95 | <br> |
| 96 | Args:<br> |
| 97 | body: object, The request body. (required)<br> |
| 98 | The object takes the form of:<br> |
| 99 | <br> |
| 100 | {<br> |
| 101 | "kind": "books#annotation", # Resource type.<br> |
| 102 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 103 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 104 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 105 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 106 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 107 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 108 | "startPosition": "A String", # The starting position for the range.<br> |
| 109 | "endPosition": "A String", # The ending position for the range.<br> |
| 110 | "startOffset": "A String", # The offset from the starting position.<br> |
| 111 | "endOffset": "A String", # The offset from the ending position.<br> |
| 112 | },<br> |
| 113 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 114 | "startPosition": "A String", # The starting position for the range.<br> |
| 115 | "endPosition": "A String", # The ending position for the range.<br> |
| 116 | "startOffset": "A String", # The offset from the starting position.<br> |
| 117 | "endOffset": "A String", # The offset from the ending position.<br> |
| 118 | },<br> |
| 119 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 120 | "startPosition": "A String", # The starting position for the range.<br> |
| 121 | "endPosition": "A String", # The ending position for the range.<br> |
| 122 | "startOffset": "A String", # The offset from the starting position.<br> |
| 123 | "endOffset": "A String", # The offset from the ending position.<br> |
| 124 | },<br> |
| 125 | },<br> |
| 126 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 127 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 128 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 129 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 130 | "startPosition": "A String", # The starting position for the range.<br> |
| 131 | "endPosition": "A String", # The ending position for the range.<br> |
| 132 | "startOffset": "A String", # The offset from the starting position.<br> |
| 133 | "endOffset": "A String", # The offset from the ending position.<br> |
| 134 | },<br> |
| 135 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 136 | "startPosition": "A String", # The starting position for the range.<br> |
| 137 | "endPosition": "A String", # The ending position for the range.<br> |
| 138 | "startOffset": "A String", # The offset from the starting position.<br> |
| 139 | "endOffset": "A String", # The offset from the ending position.<br> |
| 140 | },<br> |
| 141 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 142 | "startPosition": "A String", # The starting position for the range.<br> |
| 143 | "endPosition": "A String", # The ending position for the range.<br> |
| 144 | "startOffset": "A String", # The offset from the starting position.<br> |
| 145 | "endOffset": "A String", # The offset from the ending position.<br> |
| 146 | },<br> |
| 147 | },<br> |
| 148 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 149 | "pageIds": [ # Pages that this annotation spans.<br> |
| 150 | "A String",<br> |
| 151 | ],<br> |
| 152 | "layerId": "A String", # The layer this annotation is for.<br> |
| 153 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 154 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 155 | "data": "A String", # User-created data for this annotation.<br> |
| 156 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 157 | "selfLink": "A String", # URL to this resource.<br> |
| 158 | }<br> |
| 159 | <br> |
| 160 | source: string, String to identify the originator of this request.<br> |
| 161 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 162 | <br> |
| 163 | Returns:<br> |
| 164 | An object of the form<br> |
| 165 | <br> |
| 166 | {<br> |
| 167 | "kind": "books#annotation", # Resource type.<br> |
| 168 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 169 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 170 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 171 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 172 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 173 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 174 | "startPosition": "A String", # The starting position for the range.<br> |
| 175 | "endPosition": "A String", # The ending position for the range.<br> |
| 176 | "startOffset": "A String", # The offset from the starting position.<br> |
| 177 | "endOffset": "A String", # The offset from the ending position.<br> |
| 178 | },<br> |
| 179 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 180 | "startPosition": "A String", # The starting position for the range.<br> |
| 181 | "endPosition": "A String", # The ending position for the range.<br> |
| 182 | "startOffset": "A String", # The offset from the starting position.<br> |
| 183 | "endOffset": "A String", # The offset from the ending position.<br> |
| 184 | },<br> |
| 185 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 186 | "startPosition": "A String", # The starting position for the range.<br> |
| 187 | "endPosition": "A String", # The ending position for the range.<br> |
| 188 | "startOffset": "A String", # The offset from the starting position.<br> |
| 189 | "endOffset": "A String", # The offset from the ending position.<br> |
| 190 | },<br> |
| 191 | },<br> |
| 192 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 193 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 194 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 195 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 196 | "startPosition": "A String", # The starting position for the range.<br> |
| 197 | "endPosition": "A String", # The ending position for the range.<br> |
| 198 | "startOffset": "A String", # The offset from the starting position.<br> |
| 199 | "endOffset": "A String", # The offset from the ending position.<br> |
| 200 | },<br> |
| 201 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 202 | "startPosition": "A String", # The starting position for the range.<br> |
| 203 | "endPosition": "A String", # The ending position for the range.<br> |
| 204 | "startOffset": "A String", # The offset from the starting position.<br> |
| 205 | "endOffset": "A String", # The offset from the ending position.<br> |
| 206 | },<br> |
| 207 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 208 | "startPosition": "A String", # The starting position for the range.<br> |
| 209 | "endPosition": "A String", # The ending position for the range.<br> |
| 210 | "startOffset": "A String", # The offset from the starting position.<br> |
| 211 | "endOffset": "A String", # The offset from the ending position.<br> |
| 212 | },<br> |
| 213 | },<br> |
| 214 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 215 | "pageIds": [ # Pages that this annotation spans.<br> |
| 216 | "A String",<br> |
| 217 | ],<br> |
| 218 | "layerId": "A String", # The layer this annotation is for.<br> |
| 219 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 220 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 221 | "data": "A String", # User-created data for this annotation.<br> |
| 222 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 223 | "selfLink": "A String", # URL to this resource.<br> |
| 224 | }</tt></dd></dl> |
| 225 | |
| 226 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of annotations, possibly filtered.<br> |
| 227 | <br> |
| 228 | Args:<br> |
| 229 | pageToken: string, The value of the nextToken from the previous page.<br> |
| 230 | layerId: string, The layer id to limit annotation by.<br> |
| 231 | volumeId: string, The volume to restrict annotations to.<br> |
| 232 | maxResults: integer, Maximum number of results to return<br> |
| 233 | source: string, String to identify the originator of this request.<br> |
| 234 | pageIds: string, The page id(s) for the volume that is being queried. (repeated)<br> |
| 235 | contentVersion: string, The content version for the requested volume.<br> |
| 236 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 237 | <br> |
| 238 | Returns:<br> |
| 239 | An object of the form<br> |
| 240 | <br> |
| 241 | {<br> |
| 242 | "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.<br> |
| 243 | "items": [ # A list of annotations.<br> |
| 244 | {<br> |
| 245 | "kind": "books#annotation", # Resource type.<br> |
| 246 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 247 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 248 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 249 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 250 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 251 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 252 | "startPosition": "A String", # The starting position for the range.<br> |
| 253 | "endPosition": "A String", # The ending position for the range.<br> |
| 254 | "startOffset": "A String", # The offset from the starting position.<br> |
| 255 | "endOffset": "A String", # The offset from the ending position.<br> |
| 256 | },<br> |
| 257 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 258 | "startPosition": "A String", # The starting position for the range.<br> |
| 259 | "endPosition": "A String", # The ending position for the range.<br> |
| 260 | "startOffset": "A String", # The offset from the starting position.<br> |
| 261 | "endOffset": "A String", # The offset from the ending position.<br> |
| 262 | },<br> |
| 263 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 264 | "startPosition": "A String", # The starting position for the range.<br> |
| 265 | "endPosition": "A String", # The ending position for the range.<br> |
| 266 | "startOffset": "A String", # The offset from the starting position.<br> |
| 267 | "endOffset": "A String", # The offset from the ending position.<br> |
| 268 | },<br> |
| 269 | },<br> |
| 270 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 271 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 272 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 273 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 274 | "startPosition": "A String", # The starting position for the range.<br> |
| 275 | "endPosition": "A String", # The ending position for the range.<br> |
| 276 | "startOffset": "A String", # The offset from the starting position.<br> |
| 277 | "endOffset": "A String", # The offset from the ending position.<br> |
| 278 | },<br> |
| 279 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 280 | "startPosition": "A String", # The starting position for the range.<br> |
| 281 | "endPosition": "A String", # The ending position for the range.<br> |
| 282 | "startOffset": "A String", # The offset from the starting position.<br> |
| 283 | "endOffset": "A String", # The offset from the ending position.<br> |
| 284 | },<br> |
| 285 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 286 | "startPosition": "A String", # The starting position for the range.<br> |
| 287 | "endPosition": "A String", # The ending position for the range.<br> |
| 288 | "startOffset": "A String", # The offset from the starting position.<br> |
| 289 | "endOffset": "A String", # The offset from the ending position.<br> |
| 290 | },<br> |
| 291 | },<br> |
| 292 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 293 | "pageIds": [ # Pages that this annotation spans.<br> |
| 294 | "A String",<br> |
| 295 | ],<br> |
| 296 | "layerId": "A String", # The layer this annotation is for.<br> |
| 297 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 298 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 299 | "data": "A String", # User-created data for this annotation.<br> |
| 300 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 301 | "selfLink": "A String", # URL to this resource.<br> |
| 302 | },<br> |
| 303 | ],<br> |
| 304 | "kind": "books#annotations", # Resource type.<br> |
| 305 | "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.<br> |
| 306 | }</tt></dd></dl> |
| 307 | |
| 308 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 309 | <br> |
| 310 | Args:<br> |
| 311 | previous_request: The request for the previous page.<br> |
| 312 | previous_response: The response from the request for the previous page.<br> |
| 313 | <br> |
| 314 | Returns:<br> |
| 315 | A request object that you can call 'execute()' on to request the next<br> |
| 316 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 317 | |
| 318 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an existing annotation.<br> |
| 319 | <br> |
| 320 | Args:<br> |
| 321 | body: object, The request body. (required)<br> |
| 322 | The object takes the form of:<br> |
| 323 | <br> |
| 324 | {<br> |
| 325 | "kind": "books#annotation", # Resource type.<br> |
| 326 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 327 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 328 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 329 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 330 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 331 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 332 | "startPosition": "A String", # The starting position for the range.<br> |
| 333 | "endPosition": "A String", # The ending position for the range.<br> |
| 334 | "startOffset": "A String", # The offset from the starting position.<br> |
| 335 | "endOffset": "A String", # The offset from the ending position.<br> |
| 336 | },<br> |
| 337 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 338 | "startPosition": "A String", # The starting position for the range.<br> |
| 339 | "endPosition": "A String", # The ending position for the range.<br> |
| 340 | "startOffset": "A String", # The offset from the starting position.<br> |
| 341 | "endOffset": "A String", # The offset from the ending position.<br> |
| 342 | },<br> |
| 343 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 344 | "startPosition": "A String", # The starting position for the range.<br> |
| 345 | "endPosition": "A String", # The ending position for the range.<br> |
| 346 | "startOffset": "A String", # The offset from the starting position.<br> |
| 347 | "endOffset": "A String", # The offset from the ending position.<br> |
| 348 | },<br> |
| 349 | },<br> |
| 350 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 351 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 352 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 353 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 354 | "startPosition": "A String", # The starting position for the range.<br> |
| 355 | "endPosition": "A String", # The ending position for the range.<br> |
| 356 | "startOffset": "A String", # The offset from the starting position.<br> |
| 357 | "endOffset": "A String", # The offset from the ending position.<br> |
| 358 | },<br> |
| 359 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 360 | "startPosition": "A String", # The starting position for the range.<br> |
| 361 | "endPosition": "A String", # The ending position for the range.<br> |
| 362 | "startOffset": "A String", # The offset from the starting position.<br> |
| 363 | "endOffset": "A String", # The offset from the ending position.<br> |
| 364 | },<br> |
| 365 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 366 | "startPosition": "A String", # The starting position for the range.<br> |
| 367 | "endPosition": "A String", # The ending position for the range.<br> |
| 368 | "startOffset": "A String", # The offset from the starting position.<br> |
| 369 | "endOffset": "A String", # The offset from the ending position.<br> |
| 370 | },<br> |
| 371 | },<br> |
| 372 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 373 | "pageIds": [ # Pages that this annotation spans.<br> |
| 374 | "A String",<br> |
| 375 | ],<br> |
| 376 | "layerId": "A String", # The layer this annotation is for.<br> |
| 377 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 378 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 379 | "data": "A String", # User-created data for this annotation.<br> |
| 380 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 381 | "selfLink": "A String", # URL to this resource.<br> |
| 382 | }<br> |
| 383 | <br> |
| 384 | source: string, String to identify the originator of this request.<br> |
| 385 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 386 | annotationId: string, The annotation identifier for the annotation to update. (required)<br> |
| 387 | <br> |
| 388 | Returns:<br> |
| 389 | An object of the form<br> |
| 390 | <br> |
| 391 | {<br> |
| 392 | "kind": "books#annotation", # Resource type.<br> |
| 393 | "updated": "A String", # Timestamp for the last time this annotation was modified.<br> |
| 394 | "created": "A String", # Timestamp for the created time of this annotation.<br> |
| 395 | "beforeSelectedText": "A String", # Anchor text before excerpt.<br> |
| 396 | "currentVersionRanges": { # Selection ranges for the most recent content version.<br> |
| 397 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 398 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 399 | "startPosition": "A String", # The starting position for the range.<br> |
| 400 | "endPosition": "A String", # The ending position for the range.<br> |
| 401 | "startOffset": "A String", # The offset from the starting position.<br> |
| 402 | "endOffset": "A String", # The offset from the ending position.<br> |
| 403 | },<br> |
| 404 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 405 | "startPosition": "A String", # The starting position for the range.<br> |
| 406 | "endPosition": "A String", # The ending position for the range.<br> |
| 407 | "startOffset": "A String", # The offset from the starting position.<br> |
| 408 | "endOffset": "A String", # The offset from the ending position.<br> |
| 409 | },<br> |
| 410 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 411 | "startPosition": "A String", # The starting position for the range.<br> |
| 412 | "endPosition": "A String", # The ending position for the range.<br> |
| 413 | "startOffset": "A String", # The offset from the starting position.<br> |
| 414 | "endOffset": "A String", # The offset from the ending position.<br> |
| 415 | },<br> |
| 416 | },<br> |
| 417 | "afterSelectedText": "A String", # Anchor text after excerpt.<br> |
| 418 | "clientVersionRanges": { # Selection ranges sent from the client.<br> |
| 419 | "contentVersion": "A String", # Content version the client sent in.<br> |
| 420 | "gbTextRange": { # Range in GB text format for this annotation sent by client.<br> |
| 421 | "startPosition": "A String", # The starting position for the range.<br> |
| 422 | "endPosition": "A String", # The ending position for the range.<br> |
| 423 | "startOffset": "A String", # The offset from the starting position.<br> |
| 424 | "endOffset": "A String", # The offset from the ending position.<br> |
| 425 | },<br> |
| 426 | "cfiRange": { # Range in CFI format for this annotation sent by client.<br> |
| 427 | "startPosition": "A String", # The starting position for the range.<br> |
| 428 | "endPosition": "A String", # The ending position for the range.<br> |
| 429 | "startOffset": "A String", # The offset from the starting position.<br> |
| 430 | "endOffset": "A String", # The offset from the ending position.<br> |
| 431 | },<br> |
| 432 | "gbImageRange": { # Range in GB image format for this annotation sent by client.<br> |
| 433 | "startPosition": "A String", # The starting position for the range.<br> |
| 434 | "endPosition": "A String", # The ending position for the range.<br> |
| 435 | "startOffset": "A String", # The offset from the starting position.<br> |
| 436 | "endOffset": "A String", # The offset from the ending position.<br> |
| 437 | },<br> |
| 438 | },<br> |
| 439 | "volumeId": "A String", # The volume that this annotation belongs to.<br> |
| 440 | "pageIds": [ # Pages that this annotation spans.<br> |
| 441 | "A String",<br> |
| 442 | ],<br> |
| 443 | "layerId": "A String", # The layer this annotation is for.<br> |
| 444 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 445 | "highlightStyle": "A String", # The highlight style for this annotation.<br> |
| 446 | "data": "A String", # User-created data for this annotation.<br> |
| 447 | "id": "A String", # Id of this annotation, in the form of a GUID.<br> |
| 448 | "selfLink": "A String", # URL to this resource.<br> |
| 449 | }</tt></dd></dl> |
| 450 | |
| 451 | <hr> |
| 452 | Data descriptors defined here:<br> |
| 453 | <dl><dt><strong>__dict__</strong></dt> |
| 454 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 455 | </dl> |
| 456 | <dl><dt><strong>__weakref__</strong></dt> |
| 457 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 458 | </dl> |
| 459 | </td></tr></table> |
| 460 | </body></html> |