blob: e92ebbcef1e91f23a051fa10a28bd93ed85e9a55 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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.series.html">series</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="books_v1.series.membership.html">membership()</a></code>
79</p>
80<p class="firstline">Returns the membership Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#get">get(series_id)</a></code></p>
84<p class="firstline">Returns Series metadata for the given series ids.</p>
85<h3>Method Details</h3>
86<div class="method">
87 <code class="details" id="get">get(series_id)</code>
88 <pre>Returns Series metadata for the given series ids.
89
90Args:
91 series_id: string, String that identifies the series (required) (repeated)
92
93Returns:
94 An object of the form:
95
96 {
Bu Sun Kim65020912020-05-20 12:08:20 -070097 &quot;kind&quot;: &quot;books#series&quot;, # Resource type.
98 &quot;series&quot;: [
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080099 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700100 &quot;bannerImageUrl&quot;: &quot;A String&quot;,
101 &quot;eligibleForSubscription&quot;: True or False,
102 &quot;imageUrl&quot;: &quot;A String&quot;,
103 &quot;isComplete&quot;: True or False,
104 &quot;seriesFormatType&quot;: &quot;A String&quot;,
105 &quot;seriesId&quot;: &quot;A String&quot;,
106 &quot;seriesSubscriptionReleaseInfo&quot;: {
107 &quot;cancellationTimestampUs&quot;: &quot;A String&quot;, # Cancellation date of the series subscription (or when it ends).
108 &quot;currentReleaseInfo&quot;: { # Release information for the last release.
109 &quot;amountInMicros&quot;: &quot;A String&quot;, # Amount in micros of the specified currency code.
110 &quot;currencyCode&quot;: &quot;A String&quot;, # Currency code of the amount.
111 &quot;releaseNumber&quot;: &quot;A String&quot;, # The release number of this issue/volume/book.
112 &quot;releaseTimestampUs&quot;: &quot;A String&quot;, # The release date.
Dan O'Mearadd494642020-05-01 07:42:23 -0700113 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 &quot;nextReleaseInfo&quot;: { # Release information for the next release.
115 &quot;amountInMicros&quot;: &quot;A String&quot;, # Amount in micros of the specified currency code.
116 &quot;currencyCode&quot;: &quot;A String&quot;, # Currency code of the amount.
117 &quot;releaseNumber&quot;: &quot;A String&quot;, # The release number of this issue/volume/book.
118 &quot;releaseTimestampUs&quot;: &quot;A String&quot;, # The release date.
Dan O'Mearadd494642020-05-01 07:42:23 -0700119 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;seriesSubscriptionType&quot;: &quot;A String&quot;, # series subscription type.
Dan O'Mearadd494642020-05-01 07:42:23 -0700121 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 &quot;seriesType&quot;: &quot;A String&quot;,
123 &quot;subscriptionId&quot;: &quot;A String&quot;,
124 &quot;title&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800125 },
126 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800127 }</pre>
128</div>
129
130</body></html>