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