Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d60d1e7de700af0037eab545b5d8ab1fcb014775 / . / docs / dyn / books_v1.layers.annotationData.html
blob: e0772aa0a0ba58022f42e41e588f621e528a88f8 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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.annotationData.html">annotationData</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)</a></code></p>
79<p class="firstline">Gets the annotation data.</p>
80<p class="toc_element">
81 <code><a href="#list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</a></code></p>
82<p class="firstline">Gets the annotation data 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, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)</code>
89 <pre>Gets the annotation data.
90
91Args:
92 volumeId: string, The volume to retrieve annotations for. (required)
93 layerId: string, The ID for the layer to get the annotations. (required)
94 annotationDataId: string, The ID of the annotation data to retrieve. (required)
95 contentVersion: string, The content version for the volume you are trying to retrieve. (required)
96 scale: integer, The requested scale for the image.
97 source: string, String to identify the originator of this request.
98 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
99 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
100 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
101
102Returns:
103 An object of the form:
104
105 {
106 "annotationType": "A String", # The type of annotation this data is for.
107 "kind": "books#annotationdata", # Resource Type
108 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
109 "volumeId": "A String", # The volume id for this data. *
110 "encoded_data": "A String", # Base64 encoded data for this annotation data.
111 "layerId": "A String", # The Layer id for this data. *
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]112 "data": "",
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]113 "id": "A String", # Unique id for this annotation data.
114 "selfLink": "A String", # URL for this resource. *
115 }</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</code>
120 <pre>Gets the annotation data for a volume and layer.
121
122Args:
123 volumeId: string, The volume to retrieve annotation data for. (required)
124 layerId: string, The ID for the layer to get the annotation data. (required)
125 contentVersion: string, The content version for the requested volume. (required)
126 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
127 scale: integer, The requested scale for the image.
128 pageToken: string, The value of the nextToken from the previous page.
129 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
130 source: string, String to identify the originator of this request.
131 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
132 maxResults: integer, Maximum number of results to return
133 annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
134 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
135 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
136
137Returns:
138 An object of the form:
139
140 {
141 "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.
142 "items": [ # A list of Annotation Data.
143 {
144 "annotationType": "A String", # The type of annotation this data is for.
145 "kind": "books#annotationdata", # Resource Type
146 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
147 "volumeId": "A String", # The volume id for this data. *
148 "encoded_data": "A String", # Base64 encoded data for this annotation data.
149 "layerId": "A String", # The Layer id for this data. *
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]150 "data": "",
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]151 "id": "A String", # Unique id for this annotation data.
152 "selfLink": "A String", # URL for this resource. *
153 },
154 ],
155 "kind": "books#annotationsdata", # Resource type
156 "totalItems": 42, # The total number of volume annotations found.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
169 A request object that you can call 'execute()' on to request the next
170 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]171 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]172</div>
173
174</body></html>