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"> 78 <code><a href="#get">get(volumeId, layerId, annotationId, source=None, locale=None)</a></code></p> 79 <p class="firstline">Gets the volume annotation.</p> 80 <p class="toc_element"> 81 <code><a href="#list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</a></code></p> 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"> 88 <code class="details" id="get">get(volumeId, layerId, annotationId, source=None, locale=None)</code> 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) 95 source: string, String to identify the originator of this request. 96 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 97 98 Returns: 99 An object of the form: 100 101 { 102 "annotationType": "A String", # The type of annotation this is. 103 "kind": "books#volumeannotation", # Resource Type 104 "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). 105 "deleted": True or False, # Indicates that this annotation is deleted. 106 "contentRanges": { # The content ranges to identify the selected text. 107 "contentVersion": "A String", # Content version applicable to ranges below. 108 "gbTextRange": { # Range in GB text format for this annotation for version above. 109 "startPosition": "A String", # The starting position for the range. 110 "endPosition": "A String", # The ending position for the range. 111 "startOffset": "A String", # The offset from the starting position. 112 "endOffset": "A String", # The offset from the ending position. 113 }, 114 "cfiRange": { # Range in CFI format for this annotation for version above. 115 "startPosition": "A String", # The starting position for the range. 116 "endPosition": "A String", # The ending position for the range. 117 "startOffset": "A String", # The offset from the starting position. 118 "endOffset": "A String", # The offset from the ending position. 119 }, 120 "gbImageRange": { # Range in GB image format for this annotation for version above. 121 "startPosition": "A String", # The starting position for the range. 122 "endPosition": "A String", # The ending position for the range. 123 "startOffset": "A String", # The offset from the starting position. 124 "endOffset": "A String", # The offset from the ending position. 125 }, 126 }, 127 "selectedText": "A String", # Excerpt from the volume. 128 "volumeId": "A String", # The Volume this annotation is for. 129 "annotationDataId": "A String", # The annotation data id for this volume annotation. 130 "annotationDataLink": "A String", # Link to get data for this annotation. 131 "pageIds": [ # Pages the annotation spans. 132 "A String", 133 ], 134 "layerId": "A String", # The Layer this annotation is for. 135 "data": "A String", # Data for this annotation. 136 "id": "A String", # Unique id of this volume annotation. 137 "selfLink": "A String", # URL to this resource. 138 }</pre> 139 </div> 140 141 <div class="method"> 142 <code class="details" id="list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</code> 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) 149 endPosition: string, The end position to end retrieving data from. 150 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 151 startOffset: string, The start offset to start retrieving data from. 152 volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting. 153 pageToken: string, The value of the nextToken from the previous page. 154 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). 155 endOffset: string, The end offset to end retrieving data from. 156 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. 157 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). 158 maxResults: integer, Maximum number of results to return 159 startPosition: string, The start position to start retrieving data from. 160 source: string, String to identify the originator of this request. 161 162 Returns: 163 An object of the form: 164 165 { 166 "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. 167 "items": [ # A list of volume annotations. 168 { 169 "annotationType": "A String", # The type of annotation this is. 170 "kind": "books#volumeannotation", # Resource Type 171 "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). 172 "deleted": True or False, # Indicates that this annotation is deleted. 173 "contentRanges": { # The content ranges to identify the selected text. 174 "contentVersion": "A String", # Content version applicable to ranges below. 175 "gbTextRange": { # Range in GB text format for this annotation for version above. 176 "startPosition": "A String", # The starting position for the range. 177 "endPosition": "A String", # The ending position for the range. 178 "startOffset": "A String", # The offset from the starting position. 179 "endOffset": "A String", # The offset from the ending position. 180 }, 181 "cfiRange": { # Range in CFI format for this annotation for version above. 182 "startPosition": "A String", # The starting position for the range. 183 "endPosition": "A String", # The ending position for the range. 184 "startOffset": "A String", # The offset from the starting position. 185 "endOffset": "A String", # The offset from the ending position. 186 }, 187 "gbImageRange": { # Range in GB image format for this annotation for version above. 188 "startPosition": "A String", # The starting position for the range. 189 "endPosition": "A String", # The ending position for the range. 190 "startOffset": "A String", # The offset from the starting position. 191 "endOffset": "A String", # The offset from the ending position. 192 }, 193 }, 194 "selectedText": "A String", # Excerpt from the volume. 195 "volumeId": "A String", # The Volume this annotation is for. 196 "annotationDataId": "A String", # The annotation data id for this volume annotation. 197 "annotationDataLink": "A String", # Link to get data for this annotation. 198 "pageIds": [ # Pages the annotation spans. 199 "A String", 200 ], 201 "layerId": "A String", # The Layer this annotation is for. 202 "data": "A String", # Data for this annotation. 203 "id": "A String", # Unique id of this volume annotation. 204 "selfLink": "A String", # URL to this resource. 205 }, 206 ], 207 "kind": "books#volumeannotations", # Resource type 208 "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). 209 "totalItems": 42, # The total number of volume annotations found. 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: 222 A request object that you can call 'execute()' on to request the next 223 page. Returns None if there are no more items in the collection. 224 </pre> 225 </div> 226 227 </body></html>
