1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the volume annotation.</p> 83<p class="toc_element"> 84 <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, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the volume annotations for a volume and layer.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=None)</code> 97 <pre>Gets the volume annotation. 98 99Args: 100 volumeId: string, The volume to retrieve annotations for. (required) 101 layerId: string, The ID for the layer to get the annotations. (required) 102 annotationId: string, The ID of the volume annotation to retrieve. (required) 103 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 104 source: string, String to identify the originator of this request. 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { 114 "annotationDataId": "A String", # The annotation data id for this volume annotation. 115 "annotationDataLink": "A String", # Link to get data for this annotation. 116 "annotationType": "A String", # The type of annotation this is. 117 "contentRanges": { # The content ranges to identify the selected text. 118 "cfiRange": { # Range in CFI format for this annotation for version above. 119 "endOffset": "A String", # The offset from the ending position. 120 "endPosition": "A String", # The ending position for the range. 121 "startOffset": "A String", # The offset from the starting position. 122 "startPosition": "A String", # The starting position for the range. 123 }, 124 "contentVersion": "A String", # Content version applicable to ranges below. 125 "gbImageRange": { # Range in GB image format for this annotation for version above. 126 "endOffset": "A String", # The offset from the ending position. 127 "endPosition": "A String", # The ending position for the range. 128 "startOffset": "A String", # The offset from the starting position. 129 "startPosition": "A String", # The starting position for the range. 130 }, 131 "gbTextRange": { # Range in GB text format for this annotation for version above. 132 "endOffset": "A String", # The offset from the ending position. 133 "endPosition": "A String", # The ending position for the range. 134 "startOffset": "A String", # The offset from the starting position. 135 "startPosition": "A String", # The starting position for the range. 136 }, 137 }, 138 "data": "A String", # Data for this annotation. 139 "deleted": True or False, # Indicates that this annotation is deleted. 140 "id": "A String", # Unique id of this volume annotation. 141 "kind": "A String", # Resource Type 142 "layerId": "A String", # The Layer this annotation is for. 143 "pageIds": [ # Pages the annotation spans. 144 "A String", 145 ], 146 "selectedText": "A String", # Excerpt from the volume. 147 "selfLink": "A String", # URL to this resource. 148 "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). 149 "volumeId": "A String", # The Volume this annotation is for. 150}</pre> 151</div> 152 153<div class="method"> 154 <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, x__xgafv=None)</code> 155 <pre>Gets the volume annotations for a volume and layer. 156 157Args: 158 volumeId: string, The volume to retrieve annotations for. (required) 159 layerId: string, The ID for the layer to get the annotations. (required) 160 contentVersion: string, The content version for the requested volume. (required) 161 endOffset: string, The end offset to end retrieving data from. 162 endPosition: string, The end position to end retrieving data from. 163 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 164 maxResults: integer, Maximum number of results to return 165 pageToken: string, The value of the nextToken from the previous page. 166 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. 167 source: string, String to identify the originator of this request. 168 startOffset: string, The start offset to start retrieving data from. 169 startPosition: string, The start position to start retrieving data from. 170 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). 171 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). 172 volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting. 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { 182 "items": [ # A list of volume annotations. 183 { 184 "annotationDataId": "A String", # The annotation data id for this volume annotation. 185 "annotationDataLink": "A String", # Link to get data for this annotation. 186 "annotationType": "A String", # The type of annotation this is. 187 "contentRanges": { # The content ranges to identify the selected text. 188 "cfiRange": { # Range in CFI format for this annotation for version above. 189 "endOffset": "A String", # The offset from the ending position. 190 "endPosition": "A String", # The ending position for the range. 191 "startOffset": "A String", # The offset from the starting position. 192 "startPosition": "A String", # The starting position for the range. 193 }, 194 "contentVersion": "A String", # Content version applicable to ranges below. 195 "gbImageRange": { # Range in GB image format for this annotation for version above. 196 "endOffset": "A String", # The offset from the ending position. 197 "endPosition": "A String", # The ending position for the range. 198 "startOffset": "A String", # The offset from the starting position. 199 "startPosition": "A String", # The starting position for the range. 200 }, 201 "gbTextRange": { # Range in GB text format for this annotation for version above. 202 "endOffset": "A String", # The offset from the ending position. 203 "endPosition": "A String", # The ending position for the range. 204 "startOffset": "A String", # The offset from the starting position. 205 "startPosition": "A String", # The starting position for the range. 206 }, 207 }, 208 "data": "A String", # Data for this annotation. 209 "deleted": True or False, # Indicates that this annotation is deleted. 210 "id": "A String", # Unique id of this volume annotation. 211 "kind": "A String", # Resource Type 212 "layerId": "A String", # The Layer this annotation is for. 213 "pageIds": [ # Pages the annotation spans. 214 "A String", 215 ], 216 "selectedText": "A String", # Excerpt from the volume. 217 "selfLink": "A String", # URL to this resource. 218 "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). 219 "volumeId": "A String", # The Volume this annotation is for. 220 }, 221 ], 222 "kind": "A String", # Resource type 223 "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. 224 "totalItems": 42, # The total number of volume annotations found. 225 "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). 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 231 <pre>Retrieves the next page of results. 232 233Args: 234 previous_request: The request for the previous page. (required) 235 previous_response: The response from the request for the previous page. (required) 236 237Returns: 238 A request object that you can call 'execute()' on to request the next 239 page. Returns None if there are no more items in the collection. 240 </pre> 241</div> 242 243</body></html>