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.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.bookshelves.html">bookshelves</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="books_v1.mylibrary.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="#addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Adds a volume to a bookshelf.</p> 85<p class="toc_element"> 86 <code><a href="#clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Clears all volumes from a bookshelf.</p> 88<p class="toc_element"> 89 <code><a href="#close">close()</a></code></p> 90<p class="firstline">Close httplib2 connections.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(shelf, source=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(source=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p> 97<p class="toc_element"> 98 <code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Moves a volume within a bookshelf.</p> 100<p class="toc_element"> 101 <code><a href="#removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Removes a volume from a bookshelf.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code> 106 <pre>Adds a volume to a bookshelf. 107 108Args: 109 shelf: string, ID of bookshelf to which to add a volume. (required) 110 volumeId: string, ID of volume to add. (required) 111 reason: string, The reason for which the book is added to the library. 112 Allowed values 113 REASON_UNDEFINED - 114 IOS_PREX - Volumes added from the PREX flow on iOS. 115 IOS_SEARCH - Volumes added from the Search flow on iOS. 116 ONBOARDING - Volumes added from the Onboarding flow. 117 source: string, String to identify the originator of this request. 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 127}</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</code> 132 <pre>Clears all volumes from a bookshelf. 133 134Args: 135 shelf: string, ID of bookshelf from which to remove a volume. (required) 136 source: string, String to identify the originator of this request. 137 x__xgafv: string, V1 error format. 138 Allowed values 139 1 - v1 error format 140 2 - v2 error format 141 142Returns: 143 An object of the form: 144 145 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 146}</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="close">close()</code> 151 <pre>Close httplib2 connections.</pre> 152</div> 153 154<div class="method"> 155 <code class="details" id="get">get(shelf, source=None, x__xgafv=None)</code> 156 <pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user. 157 158Args: 159 shelf: string, ID of bookshelf to retrieve. (required) 160 source: string, String to identify the originator of this request. 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { 170 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. 171 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). 172 "description": "A String", # Description of this bookshelf. 173 "id": 42, # Id of this bookshelf, only unique by user. 174 "kind": "A String", # Resource type for bookshelf metadata. 175 "selfLink": "A String", # URL to this resource. 176 "title": "A String", # Title of this bookshelf. 177 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). 178 "volumeCount": 42, # Number of volumes in this bookshelf. 179 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). 180}</pre> 181</div> 182 183<div class="method"> 184 <code class="details" id="list">list(source=None, x__xgafv=None)</code> 185 <pre>Retrieves a list of bookshelves belonging to the authenticated user. 186 187Args: 188 source: string, String to identify the originator of this request. 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { 198 "items": [ # A list of bookshelves. 199 { 200 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. 201 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). 202 "description": "A String", # Description of this bookshelf. 203 "id": 42, # Id of this bookshelf, only unique by user. 204 "kind": "A String", # Resource type for bookshelf metadata. 205 "selfLink": "A String", # URL to this resource. 206 "title": "A String", # Title of this bookshelf. 207 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). 208 "volumeCount": 42, # Number of volumes in this bookshelf. 209 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). 210 }, 211 ], 212 "kind": "A String", # Resource type. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</code> 218 <pre>Moves a volume within a bookshelf. 219 220Args: 221 shelf: string, ID of bookshelf with the volume. (required) 222 volumeId: string, ID of volume to move. (required) 223 volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required) 224 source: string, String to identify the originator of this request. 225 x__xgafv: string, V1 error format. 226 Allowed values 227 1 - v1 error format 228 2 - v2 error format 229 230Returns: 231 An object of the form: 232 233 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 234}</pre> 235</div> 236 237<div class="method"> 238 <code class="details" id="removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code> 239 <pre>Removes a volume from a bookshelf. 240 241Args: 242 shelf: string, ID of bookshelf from which to remove a volume. (required) 243 volumeId: string, ID of volume to remove. (required) 244 reason: string, The reason for which the book is removed from the library. 245 Allowed values 246 REASON_UNDEFINED - 247 ONBOARDING - Samples removed from the Onboarding flow. 248 source: string, String to identify the originator of this request. 249 x__xgafv: string, V1 error format. 250 Allowed values 251 1 - v1 error format 252 2 - v2 error format 253 254Returns: 255 An object of the form: 256 257 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 258}</pre> 259</div> 260 261</body></html>