Bookshelf

  • The Bookshelf collection allows viewing and modifying bookshelf metadata and contents.

  • There are methods for accessing public bookshelf data without authentication and private "My Library" data with authentication.

  • A Bookshelf resource represents bookshelf metadata but does not include the volumes within the bookshelf.

  • The Bookshelf resource includes properties such as ID, title, access level, and counts of volumes.
The Bookshelf collection allows you to view bookshelf metadata as well as to modify the contents of a bookshelf.

Methods

The following methods apply to the public data about bookshelves and don't require authentication.
books.bookshelves.list

list
Retrieves a list of public Bookshelf resource for the specified user.
get
Retrieves a specific Bookshelf resource for the specified user.

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
}
Property Name Value Description Notes
kind string Resource type for bookshelf metadata.
id integer ID of this bookshelf.
title string Title of this bookshelf.
description string Description of this bookshelf.
access string Whether this bookshelf is PUBLIC or PRIVATE.
updated datetime Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
created datetime Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
volumeCount integer Number of volumes in this bookshelf.
volumesLastUpdated datetime Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).