docs/dyn/books_v1.bookshelves.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.bookshelves.html">bookshelves</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="books_v1.bookshelves.volumes.html">volumes()</a></code>
</p>
<p class="firstline">Returns the volumes Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(userId, shelf, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves metadata for a specific bookshelf for the specified user.</p>
<p class="toc_element">
  <code><a href="#list">list(userId, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of public bookshelves for the specified user.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(userId, shelf, source=None, x__xgafv=None)</code>
  <pre>Retrieves metadata for a specific bookshelf for the specified user.

Args:
  userId: string, ID of user for whom to retrieve bookshelves. (required)
  shelf: string, ID of bookshelf to retrieve. (required)
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
  &quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
  &quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
  &quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
  &quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
  &quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
  &quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
  &quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(userId, source=None, x__xgafv=None)</code>
  <pre>Retrieves a list of public bookshelves for the specified user.

Args:
  userId: string, ID of user for whom to retrieve bookshelves. (required)
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;items&quot;: [ # A list of bookshelves.
    {
      &quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
      &quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
      &quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
      &quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
      &quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
      &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
      &quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
      &quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
      &quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
      &quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
}</pre>
</div>

</body></html>