Books API . bookshelves

Instance Methods

volumes()

Returns the volumes Resource.

close()

Close httplib2 connections.

get(userId, shelf, source=None, x__xgafv=None)

Retrieves metadata for a specific bookshelf for the specified user.

list(userId, source=None, x__xgafv=None)

Retrieves a list of public bookshelves for the specified user.

Method Details

close()
Close httplib2 connections.
get(userId, shelf, source=None, x__xgafv=None)
Retrieves metadata for a specific bookshelf for the specified user.

Args:
  userId: string, ID of user for whom to retrieve bookshelves. (required)
  shelf: string, ID of bookshelf to retrieve. (required)
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
  "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
  "description": "A String", # Description of this bookshelf.
  "id": 42, # Id of this bookshelf, only unique by user.
  "kind": "A String", # Resource type for bookshelf metadata.
  "selfLink": "A String", # URL to this resource.
  "title": "A String", # Title of this bookshelf.
  "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
  "volumeCount": 42, # Number of volumes in this bookshelf.
  "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
}
list(userId, source=None, x__xgafv=None)
Retrieves a list of public bookshelves for the specified user.

Args:
  userId: string, ID of user for whom to retrieve bookshelves. (required)
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "items": [ # A list of bookshelves.
    {
      "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
      "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
      "description": "A String", # Description of this bookshelf.
      "id": 42, # Id of this bookshelf, only unique by user.
      "kind": "A String", # Resource type for bookshelf metadata.
      "selfLink": "A String", # URL to this resource.
      "title": "A String", # Title of this bookshelf.
      "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
      "volumeCount": 42, # Number of volumes in this bookshelf.
      "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
    },
  ],
  "kind": "A String", # Resource type.
}