| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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.bookshelves.html">bookshelves</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="books_v1.bookshelves.volumes.html">volumes()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the volumes Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#get">get(userId, shelf, source=None)</a></code></p> |
| 84 | <p class="firstline">Retrieves metadata for a specific bookshelf for the specified user.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#list">list(userId, source=None)</a></code></p> |
| 87 | <p class="firstline">Retrieves a list of public bookshelves for the specified user.</p> |
| 88 | <h3>Method Details</h3> |
| 89 | <div class="method"> |
| 90 | <code class="details" id="get">get(userId, shelf, source=None)</code> |
| 91 | <pre>Retrieves metadata for a specific bookshelf for the specified user. |
| 92 | |
| 93 | Args: |
| 94 | userId: string, ID of user for whom to retrieve bookshelves. (required) |
| 95 | shelf: string, ID of bookshelf to retrieve. (required) |
| 96 | source: string, String to identify the originator of this request. |
| 97 | |
| 98 | Returns: |
| 99 | An object of the form: |
| 100 | |
| 101 | { |
| 102 | "kind": "books#bookshelf", # Resource type for bookshelf metadata. |
| 103 | "description": "A String", # Description of this bookshelf. |
| 104 | "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 105 | "volumeCount": 42, # Number of volumes in this bookshelf. |
| 106 | "title": "A String", # Title of this bookshelf. |
| 107 | "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 108 | "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. |
| 109 | "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 110 | "id": 42, # Id of this bookshelf, only unique by user. |
| 111 | "selfLink": "A String", # URL to this resource. |
| 112 | }</pre> |
| 113 | </div> |
| 114 | |
| 115 | <div class="method"> |
| 116 | <code class="details" id="list">list(userId, source=None)</code> |
| 117 | <pre>Retrieves a list of public bookshelves for the specified user. |
| 118 | |
| 119 | Args: |
| 120 | userId: string, ID of user for whom to retrieve bookshelves. (required) |
| 121 | source: string, String to identify the originator of this request. |
| 122 | |
| 123 | Returns: |
| 124 | An object of the form: |
| 125 | |
| 126 | { |
| 127 | "items": [ # A list of bookshelves. |
| 128 | { |
| 129 | "kind": "books#bookshelf", # Resource type for bookshelf metadata. |
| 130 | "description": "A String", # Description of this bookshelf. |
| 131 | "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 132 | "volumeCount": 42, # Number of volumes in this bookshelf. |
| 133 | "title": "A String", # Title of this bookshelf. |
| 134 | "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 135 | "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. |
| 136 | "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). |
| 137 | "id": 42, # Id of this bookshelf, only unique by user. |
| 138 | "selfLink": "A String", # URL to this resource. |
| 139 | }, |
| 140 | ], |
| 141 | "kind": "books#bookshelves", # Resource type. |
| 142 | }</pre> |
| 143 | </div> |
| 144 | |
| 145 | </body></html> |