Debian Codegraph @

docs/dyn/books_v1.layers.html

raw
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></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">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Gets the layer summary for a volume.</p>
93 <p class="toc_element">
94 <code><a href="#list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">List the layer summaries for a volume.</p>
96 <h3>Method Details</h3>
97 <div class="method">
98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100 </div>
101
102 <div class="method">
103 <code class="details" id="get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</code>
104 <pre>Gets the layer summary for a volume.
105
106 Args:
107 volumeId: string, The volume to retrieve layers for. (required)
108 summaryId: string, The ID for the layer to get the summary for. (required)
109 contentVersion: string, The content version for the requested volume.
110 source: string, String to identify the originator of this request.
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 {
120 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
121 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
122 &quot;A String&quot;,
123 ],
124 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
125 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
126 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
127 &quot;dataCount&quot;: 42, # The number of data items for this layer.
128 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
129 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
130 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
131 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
132 &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).
133 &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.
134 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
135 }</pre>
136 </div>
137
138 <div class="method">
139 <code class="details" id="list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None, x__xgafv=None)</code>
140 <pre>List the layer summaries for a volume.
141
142 Args:
143 volumeId: string, The volume to retrieve layers for. (required)
144 contentVersion: string, The content version for the requested volume.
145 maxResults: integer, Maximum number of results to return
146 pageToken: string, The value of the nextToken from the previous page.
147 source: string, String to identify the originator of this request.
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153 Returns:
154 An object of the form:
155
156 {
157 &quot;items&quot;: [ # A list of layer summary items.
158 {
159 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
160 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
161 &quot;A String&quot;,
162 ],
163 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
164 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
165 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
166 &quot;dataCount&quot;: 42, # The number of data items for this layer.
167 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
168 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
169 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
170 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
171 &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).
172 &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.
173 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
174 },
175 ],
176 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
177 &quot;totalItems&quot;: 42, # The total number of layer summaries found.
178 }</pre>
179 </div>
180
181 </body></html>