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.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, source=None, reason=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)</a></code></p> 87 <p class="firstline">Clears all volumes from a bookshelf.</p> 88 <p class="toc_element"> 89 <code><a href="#get">get(shelf, source=None)</a></code></p> 90 <p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p> 91 <p class="toc_element"> 92 <code><a href="#list">list(source=None)</a></code></p> 93 <p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p> 94 <p class="toc_element"> 95 <code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None)</a></code></p> 96 <p class="firstline">Moves a volume within a bookshelf.</p> 97 <p class="toc_element"> 98 <code><a href="#removeVolume">removeVolume(shelf, volumeId, source=None, reason=None)</a></code></p> 99 <p class="firstline">Removes a volume from a bookshelf.</p> 100 <h3>Method Details</h3> 101 <div class="method"> 102 <code class="details" id="addVolume">addVolume(shelf, volumeId, source=None, reason=None)</code> 103 <pre>Adds a volume to a bookshelf. 104 105 Args: 106 shelf: string, ID of bookshelf to which to add a volume. (required) 107 volumeId: string, ID of volume to add. (required) 108 source: string, String to identify the originator of this request. 109 reason: string, The reason for which the book is added to the library. 110 Allowed values 111 IOS_PREX - Volumes added from the PREX flow on iOS. 112 IOS_SEARCH - Volumes added from the Search flow on iOS. 113 ONBOARDING - Volumes added from the Onboarding flow. 114 </pre> 115 </div> 116 117 <div class="method"> 118 <code class="details" id="clearVolumes">clearVolumes(shelf, source=None)</code> 119 <pre>Clears all volumes from a bookshelf. 120 121 Args: 122 shelf: string, ID of bookshelf from which to remove a volume. (required) 123 source: string, String to identify the originator of this request. 124 </pre> 125 </div> 126 127 <div class="method"> 128 <code class="details" id="get">get(shelf, source=None)</code> 129 <pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user. 130 131 Args: 132 shelf: string, ID of bookshelf to retrieve. (required) 133 source: string, String to identify the originator of this request. 134 135 Returns: 136 An object of the form: 137 138 { 139 "kind": "books#bookshelf", # Resource type for bookshelf metadata. 140 "description": "A String", # Description of this bookshelf. 141 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). 142 "volumeCount": 42, # Number of volumes in this bookshelf. 143 "title": "A String", # Title of this bookshelf. 144 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). 145 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. 146 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). 147 "id": 42, # Id of this bookshelf, only unique by user. 148 "selfLink": "A String", # URL to this resource. 149 }</pre> 150 </div> 151 152 <div class="method"> 153 <code class="details" id="list">list(source=None)</code> 154 <pre>Retrieves a list of bookshelves belonging to the authenticated user. 155 156 Args: 157 source: string, String to identify the originator of this request. 158 159 Returns: 160 An object of the form: 161 162 { 163 "items": [ # A list of bookshelves. 164 { 165 "kind": "books#bookshelf", # Resource type for bookshelf metadata. 166 "description": "A String", # Description of this bookshelf. 167 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). 168 "volumeCount": 42, # Number of volumes in this bookshelf. 169 "title": "A String", # Title of this bookshelf. 170 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). 171 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE. 172 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). 173 "id": 42, # Id of this bookshelf, only unique by user. 174 "selfLink": "A String", # URL to this resource. 175 }, 176 ], 177 "kind": "books#bookshelves", # Resource type. 178 }</pre> 179 </div> 180 181 <div class="method"> 182 <code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None)</code> 183 <pre>Moves a volume within a bookshelf. 184 185 Args: 186 shelf: string, ID of bookshelf with the volume. (required) 187 volumeId: string, ID of volume to move. (required) 188 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) 189 source: string, String to identify the originator of this request. 190 </pre> 191 </div> 192 193 <div class="method"> 194 <code class="details" id="removeVolume">removeVolume(shelf, volumeId, source=None, reason=None)</code> 195 <pre>Removes a volume from a bookshelf. 196 197 Args: 198 shelf: string, ID of bookshelf from which to remove a volume. (required) 199 volumeId: string, ID of volume to remove. (required) 200 source: string, String to identify the originator of this request. 201 reason: string, The reason for which the book is removed from the library. 202 Allowed values 203 ONBOARDING - Samples removed from the Onboarding flow. 204 </pre> 205 </div> 206 207 </body></html>
