| 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.layers.html">layers</a> . <a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#get">get(volumeId, layerId, annotationId, locale=None, source=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Gets the volume annotation.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(volumeId, layerId, contentVersion, endOffset=None, endPosition=None, locale=None, maxResults=None, pageToken=None, showDeleted=None, source=None, startOffset=None, startPosition=None, updatedMax=None, updatedMin=None, volumeAnnotationsVersion=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Gets the volume annotations for a volume and layer.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | <code class="details" id="get">get(volumeId, layerId, annotationId, locale=None, source=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <pre>Gets the volume annotation. |
| 90 | |
| 91 | Args: |
| 92 | volumeId: string, The volume to retrieve annotations for. (required) |
| 93 | layerId: string, The ID for the layer to get the annotations. (required) |
| 94 | annotationId: string, The ID of the volume annotation to retrieve. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 96 | source: string, String to identify the originator of this request. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 97 | |
| 98 | Returns: |
| 99 | An object of the form: |
| 100 | |
| 101 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | "annotationDataId": "A String", # The annotation data id for this volume annotation. |
| 103 | "annotationDataLink": "A String", # Link to get data for this annotation. |
| 104 | "annotationType": "A String", # The type of annotation this is. |
| 105 | "contentRanges": { # The content ranges to identify the selected text. |
| 106 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 107 | "endOffset": "A String", # The offset from the ending position. |
| 108 | "endPosition": "A String", # The ending position for the range. |
| 109 | "startOffset": "A String", # The offset from the starting position. |
| 110 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 111 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 113 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 114 | "endOffset": "A String", # The offset from the ending position. |
| 115 | "endPosition": "A String", # The ending position for the range. |
| 116 | "startOffset": "A String", # The offset from the starting position. |
| 117 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 120 | "endOffset": "A String", # The offset from the ending position. |
| 121 | "endPosition": "A String", # The ending position for the range. |
| 122 | "startOffset": "A String", # The offset from the starting position. |
| 123 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | }, |
| 125 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "data": "A String", # Data for this annotation. |
| 127 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 128 | "id": "A String", # Unique id of this volume annotation. |
| 129 | "kind": "books#volumeannotation", # Resource Type |
| 130 | "layerId": "A String", # The Layer this annotation is for. |
| 131 | "pageIds": [ # Pages the annotation spans. |
| 132 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 133 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 134 | "selectedText": "A String", # Excerpt from the volume. |
| 135 | "selfLink": "A String", # URL to this resource. |
| 136 | "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). |
| 137 | "volumeId": "A String", # The Volume this annotation is for. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 138 | }</pre> |
| 139 | </div> |
| 140 | |
| 141 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | <code class="details" id="list">list(volumeId, layerId, contentVersion, endOffset=None, endPosition=None, locale=None, maxResults=None, pageToken=None, showDeleted=None, source=None, startOffset=None, startPosition=None, updatedMax=None, updatedMin=None, volumeAnnotationsVersion=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 143 | <pre>Gets the volume annotations for a volume and layer. |
| 144 | |
| 145 | Args: |
| 146 | volumeId: string, The volume to retrieve annotations for. (required) |
| 147 | layerId: string, The ID for the layer to get the annotations. (required) |
| 148 | contentVersion: string, The content version for the requested volume. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 149 | endOffset: string, The end offset to end retrieving data from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 150 | endPosition: string, The end position to end retrieving data from. |
| 151 | locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 152 | maxResults: integer, Maximum number of results to return |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | pageToken: string, The value of the nextToken from the previous page. |
| 154 | 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] | 155 | source: string, String to identify the originator of this request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | startOffset: string, The start offset to start retrieving data from. |
| 157 | startPosition: string, The start position to start retrieving data from. |
| 158 | updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| 159 | updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| 160 | volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 161 | |
| 162 | Returns: |
| 163 | An object of the form: |
| 164 | |
| 165 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "items": [ # A list of volume annotations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 167 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 168 | "annotationDataId": "A String", # The annotation data id for this volume annotation. |
| 169 | "annotationDataLink": "A String", # Link to get data for this annotation. |
| 170 | "annotationType": "A String", # The type of annotation this is. |
| 171 | "contentRanges": { # The content ranges to identify the selected text. |
| 172 | "cfiRange": { # Range in CFI format for this annotation for version above. |
| 173 | "endOffset": "A String", # The offset from the ending position. |
| 174 | "endPosition": "A String", # The ending position for the range. |
| 175 | "startOffset": "A String", # The offset from the starting position. |
| 176 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 177 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "contentVersion": "A String", # Content version applicable to ranges below. |
| 179 | "gbImageRange": { # Range in GB image format for this annotation for version above. |
| 180 | "endOffset": "A String", # The offset from the ending position. |
| 181 | "endPosition": "A String", # The ending position for the range. |
| 182 | "startOffset": "A String", # The offset from the starting position. |
| 183 | "startPosition": "A String", # The starting position for the range. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 184 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | "gbTextRange": { # Range in GB text format for this annotation for version above. |
| 186 | "endOffset": "A String", # The offset from the ending position. |
| 187 | "endPosition": "A String", # The ending position for the range. |
| 188 | "startOffset": "A String", # The offset from the starting position. |
| 189 | "startPosition": "A String", # The starting position for the range. |
| 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 | "data": "A String", # Data for this annotation. |
| 193 | "deleted": True or False, # Indicates that this annotation is deleted. |
| 194 | "id": "A String", # Unique id of this volume annotation. |
| 195 | "kind": "books#volumeannotation", # Resource Type |
| 196 | "layerId": "A String", # The Layer this annotation is for. |
| 197 | "pageIds": [ # Pages the annotation spans. |
| 198 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 200 | "selectedText": "A String", # Excerpt from the volume. |
| 201 | "selfLink": "A String", # URL to this resource. |
| 202 | "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). |
| 203 | "volumeId": "A String", # The Volume this annotation is for. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 204 | }, |
| 205 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 206 | "kind": "books#volumeannotations", # Resource type |
| 207 | "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. |
| 208 | "totalItems": 42, # The total number of volume annotations found. |
| 209 | "version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book). |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 210 | }</pre> |
| 211 | </div> |
| 212 | |
| 213 | <div class="method"> |
| 214 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 215 | <pre>Retrieves the next page of results. |
| 216 | |
| 217 | Args: |
| 218 | previous_request: The request for the previous page. (required) |
| 219 | previous_response: The response from the request for the previous page. (required) |
| 220 | |
| 221 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | 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] | 223 | page. Returns None if there are no more items in the collection. |
| 224 | </pre> |
| 225 | </div> |
| 226 | |
| 227 | </body></html> |