blob: 791631baddb23f99cb4edab6d260b8d18c200fd0 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="books_v1.layers.annotationData.html">annotationData()</a></code>
79</p>
80<p class="firstline">Returns the annotationData Resource.</p>
81
82<p class="toc_element">
83 <code><a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations()</a></code>
84</p>
85<p class="firstline">Returns the volumeAnnotations Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080091 <code><a href="#get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040092<p class="firstline">Gets the layer summary for a volume.</p>
93<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080094 <code><a href="#list">list(volumeId, pageToken=None, maxResults=None, contentVersion=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="firstline">List the layer summaries for a volume.</p>
96<h3>Method Details</h3>
97<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
102<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800103 <code class="details" id="get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400104 <pre>Gets the layer summary for a volume.
105
106Args:
107 volumeId: string, The volume to retrieve layers for. (required)
108 summaryId: string, The ID for the layer to get the summary for. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 contentVersion: string, The content version for the requested volume.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800110 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400115
116Returns:
117 An object of the form:
118
119 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
121 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400122 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800123 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
124 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
125 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
126 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
127 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700128 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800129 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
130 &quot;volumeAnnotationsVersion&quot;: &quot;A String&quot;, # The current version of this layer&#x27;s volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
131 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
132 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
133 &quot;dataCount&quot;: 42, # The number of data items for this layer.
134 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
John Asmuth614db982014-04-24 15:46:26 -0400135 }</pre>
136</div>
137
138<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800139 <code class="details" id="list">list(volumeId, pageToken=None, maxResults=None, contentVersion=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400140 <pre>List the layer summaries for a volume.
141
142Args:
143 volumeId: string, The volume to retrieve layers for. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800144 pageToken: string, The value of the nextToken from the previous page.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800145 maxResults: integer, Maximum number of results to return
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700146 contentVersion: string, The content version for the requested volume.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400152
153Returns:
154 An object of the form:
155
156 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800157 &quot;totalItems&quot;: 42, # The total number of layer summaries found.
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 &quot;items&quot;: [ # A list of layer summary items.
John Asmuth614db982014-04-24 15:46:26 -0400159 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
161 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400162 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800163 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
164 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
165 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
166 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
167 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700168 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800169 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
170 &quot;volumeAnnotationsVersion&quot;: &quot;A String&quot;, # The current version of this layer&#x27;s volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
171 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
172 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
173 &quot;dataCount&quot;: 42, # The number of data items for this layer.
174 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
John Asmuth614db982014-04-24 15:46:26 -0400175 },
176 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700177 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
John Asmuth614db982014-04-24 15:46:26 -0400178 }</pre>
179</div>
180
181</body></html>