Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / books_v1.layers.html
blob: 2c734fa8e714bec1a58f28bd6ddb8bcef9bf5666 [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></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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]88 <code><a href="#get">get(volumeId, summaryId, contentVersion=None, source=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="firstline">Gets the layer summary for a volume.</p>
90<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91 <code><a href="#list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<p class="firstline">List the layer summaries for a volume.</p>
93<h3>Method Details</h3>
94<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 <code class="details" id="get">get(volumeId, summaryId, contentVersion=None, source=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96 <pre>Gets the layer summary for a volume.
97
98Args:
99 volumeId: string, The volume to retrieve layers for. (required)
100 summaryId: string, The ID for the layer to get the summary for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101 contentVersion: string, The content version for the requested volume.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 source: string, String to identify the originator of this request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103
104Returns:
105 An object of the form:
106
107 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
109 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
110 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
113 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
114 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
115 &quot;dataCount&quot;: 42, # The number of data items for this layer.
116 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
117 &quot;kind&quot;: &quot;books#layersummary&quot;, # Resource Type
118 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
119 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
120 &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).
121 &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.
122 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 }</pre>
124</div>
125
126<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 <code class="details" id="list">list(volumeId, contentVersion=None, maxResults=None, pageToken=None, source=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 <pre>List the layer summaries for a volume.
129
130Args:
131 volumeId: string, The volume to retrieve layers for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 contentVersion: string, The content version for the requested volume.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 maxResults: integer, Maximum number of results to return
134 pageToken: string, The value of the nextToken from the previous page.
135 source: string, String to identify the originator of this request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136
137Returns:
138 An object of the form:
139
140 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;items&quot;: [ # A list of layer summary items.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;annotationCount&quot;: 42, # The number of annotations for this layer.
144 &quot;annotationTypes&quot;: [ # The list of annotation types contained for this layer.
145 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;annotationsDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
148 &quot;annotationsLink&quot;: &quot;A String&quot;, # The link to get the annotations for this layer.
149 &quot;contentVersion&quot;: &quot;A String&quot;, # The content version this resource is for.
150 &quot;dataCount&quot;: 42, # The number of data items for this layer.
151 &quot;id&quot;: &quot;A String&quot;, # Unique id of this layer summary.
152 &quot;kind&quot;: &quot;books#layersummary&quot;, # Resource Type
153 &quot;layerId&quot;: &quot;A String&quot;, # The layer id for this summary.
154 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
155 &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).
156 &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.
157 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id this resource is for.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 },
159 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 &quot;kind&quot;: &quot;books#layersummaries&quot;, # Resource type.
161 &quot;totalItems&quot;: 42, # The total number of layer summaries found.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 }</pre>
163</div>
164
165</body></html>