• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
88  <code><a href="#get">get(volumeId, summaryId, source=None, contentVersion=None)</a></code></p>
89<p class="firstline">Gets the layer summary for a volume.</p>
90<p class="toc_element">
91  <code><a href="#list">list(volumeId, pageToken=None, maxResults=None, source=None, contentVersion=None)</a></code></p>
92<p class="firstline">List the layer summaries for a volume.</p>
93<h3>Method Details</h3>
94<div class="method">
95    <code class="details" id="get">get(volumeId, summaryId, source=None, contentVersion=None)</code>
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)
101  source: string, String to identify the originator of this request.
102  contentVersion: string, The content version for the requested volume.
103
104Returns:
105  An object of the form:
106
107    {
108    "kind": "books#layersummary", # Resource Type
109    "annotationCount": 42, # The number of annotations for this layer.
110    "dataCount": 42, # The number of data items for this layer.
111    "annotationsLink": "A String", # The link to get the annotations for this layer.
112    "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
113    "volumeId": "A String", # The volume id this resource is for.
114    "id": "A String", # Unique id of this layer summary.
115    "annotationTypes": [ # The list of annotation types contained for this layer.
116      "A String",
117    ],
118    "contentVersion": "A String", # The content version this resource is for.
119    "layerId": "A String", # The layer id for this summary.
120    "volumeAnnotationsVersion": "A String", # The current version of this layer'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.
121    "annotationsDataLink": "A String", # Link to get data for this annotation.
122    "selfLink": "A String", # URL to this resource.
123  }</pre>
124</div>
125
126<div class="method">
127    <code class="details" id="list">list(volumeId, pageToken=None, maxResults=None, source=None, contentVersion=None)</code>
128  <pre>List the layer summaries for a volume.
129
130Args:
131  volumeId: string, The volume to retrieve layers for. (required)
132  pageToken: string, The value of the nextToken from the previous page.
133  maxResults: integer, Maximum number of results to return
134  source: string, String to identify the originator of this request.
135  contentVersion: string, The content version for the requested volume.
136
137Returns:
138  An object of the form:
139
140    {
141    "totalItems": 42, # The total number of layer summaries found.
142    "items": [ # A list of layer summary items.
143      {
144        "kind": "books#layersummary", # Resource Type
145        "annotationCount": 42, # The number of annotations for this layer.
146        "dataCount": 42, # The number of data items for this layer.
147        "annotationsLink": "A String", # The link to get the annotations for this layer.
148        "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
149        "volumeId": "A String", # The volume id this resource is for.
150        "id": "A String", # Unique id of this layer summary.
151        "annotationTypes": [ # The list of annotation types contained for this layer.
152          "A String",
153        ],
154        "contentVersion": "A String", # The content version this resource is for.
155        "layerId": "A String", # The layer id for this summary.
156        "volumeAnnotationsVersion": "A String", # The current version of this layer'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        "annotationsDataLink": "A String", # Link to get data for this annotation.
158        "selfLink": "A String", # URL to this resource.
159      },
160    ],
161    "kind": "books#layersummaries", # Resource type.
162  }</pre>
163</div>
164
165</body></html>