Bookshelf
Stay organized with collections
Save and categorize content based on your preferences.
The Bookshelf
collection allows you to view bookshelf metadata as well as to modify the contents of a bookshelf.
Resource Representations
A Bookshelf resource represents the metadata for a bookshelf, it does not include the volumes in the bookshelf.
{
"kind": "books#bookshelf",
"id": integer
,
"selfLink": string
,
"title": string
,
"description": string
,
"access": string
,
"updated": datetime
,
"created": datetime
,
"volumeCount": integer
,
"volumesLastUpdated": datetime
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-26 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eBookshelf\u003c/code\u003e collection enables you to view and manage bookshelf metadata and contents.\u003c/p\u003e\n"],["\u003cp\u003ePublic methods allow access to bookshelf data without authentication, while private methods require authentication for "My Library" interactions.\u003c/p\u003e\n"],["\u003cp\u003eA Bookshelf resource represents metadata such as title, description, access level, and volume count, but it does not include the actual volumes within the bookshelf.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve lists of bookshelves, individual bookshelf details, and modify "My Library" bookshelves using the provided methods.\u003c/p\u003e\n"]]],[],null,["# Bookshelf\n\nThe `Bookshelf` collection allows you to view bookshelf metadata as well as to modify the contents of a bookshelf.\n\nMethods\n-------\n\n\u003cbr /\u003e\n\nThe following methods apply to the public data about bookshelves and don't require authentication.\n[books.bookshelves.list](#method_books_bookshelves_list) \n[books.bookshelves.get](#method_books_bookshelves_get) \n\nThe following methods apply to the private, \"My Library\" view of bookshelves and require authentication.\n[books.mylibrary.bookshelves.list](#method_books_mylibrary_bookshelves_list) \n[books.mylibrary.bookshelves.get](#method_books_mylibrary_bookshelves_get) \n[books.mylibrary.bookshelves.addVolume](#method_books_mylibrary_bookshelves_addVolume) \n[books.mylibrary.bookshelves.removeVolume](#method_books_mylibrary_bookshelves_removeVolume) \n[books.mylibrary.bookshelves.clearVolumes](#method_books_mylibrary_bookshelves_clearVolumes)\n\n\u003cbr /\u003e\n\n[list](/books/docs/v1/reference/bookshelves/list)\n: Retrieves a list of public [Bookshelf resource](/books/docs/v1/reference/bookshelves) for the specified user.\n\n[get](/books/docs/v1/reference/bookshelves/get)\n: Retrieves a specific [Bookshelf resource](/books/docs/v1/reference/bookshelves) for the specified user.\n\nResource Representations\n------------------------\n\nA Bookshelf resource represents the metadata for a bookshelf, it does not include the volumes in the bookshelf.\n\n```text\n{\n \"kind\": \"books#bookshelf\",\n \"id\": integer,\n \"selfLink\": string,\n \"title\": string,\n \"description\": string,\n \"access\": string,\n \"updated\": datetime,\n \"created\": datetime,\n \"volumeCount\": integer,\n \"volumesLastUpdated\": datetime\n}\n```\n\n| Property Name | Value | Description | Notes |\n|----------------------|------------|--------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type for bookshelf metadata. | |\n| `id` | `integer` | ID of this bookshelf. | |\n| `title` | `string` | Title of this bookshelf. | |\n| `description` | `string` | Description of this bookshelf. | |\n| `access` | `string` | Whether this bookshelf is PUBLIC or PRIVATE. | |\n| `updated` | `datetime` | Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). | |\n| `created` | `datetime` | Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). | |\n| `volumeCount` | `integer` | Number of volumes in this bookshelf. | |\n| `volumesLastUpdated` | `datetime` | Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). | |\n| `selfLink` | `string` | URL to this resource. | |"]]
