LibraryService

ListBooks

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

get/v1/shelves/{shelf}/books

Path parameters

shelfstring required

The shelf id.

Query parameters

page_sizeinteger

Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.

page_tokenstring

A token identifying a page of results the server should return. Typically, this is the value of [ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token]. returned from the previous call to ListBooks method.

Response

next_page_tokenstring

A token to retrieve next page of results. Pass this value in the [ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token] field in the subsequent call to ListBooks method to retrieve the next page of results.

Changes

Changed in 9 of the 12 revisions of this API.106

Apr 11, 2022v1ac9d37cae0e02See the full diff
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
Feb 23, 2022v1639a4ec995ca1See the full diff
- ○
  the response property // became required for the status
  response-property-became-required
Jan 12, 2022v1dbd82bd71d471See the full diff
- ▲
  the // response's property format changed from RFC3339 to date-time for status
  response-property-type-changed
Jan 12, 2022v100e696b6b84a11See the full diff
- ▲
  the // response's property format changed from date-time to RFC3339 for status
  response-property-type-changed
- ○
  the // response's property pattern ^shelves/[a-z2-7]{26}/books/[a-z2-7]{26}$ was added for the status
  response-property-pattern-added
Jan 12, 2022v1fab7e7c2f60c1See the full diff
- ▲
  the // response's property format changed from RFC3339 to date-time for status
  response-property-type-changed
Jan 11, 2022v126b3bc7b51691See the full diff
- ▲
  for the query request parameter page_size, the type changed from string to integer, and format from no format to int32
  request-parameter-type-changed
Jan 11, 2022v12a0f5e3b87341See the full diff
- ○
  api operation id ListBooks removed and replaced with LibraryService_ListBooks
  api-operation-id-removed
Jan 11, 2022v10dea6034d9691See the full diff
- ○
  api operation id LibraryService_ListBooks removed and replaced with ListBooks
  api-operation-id-removed
Dec 9, 2021v11f7e8ced536942See the full diff
- ▲
  the response's body type changed from object to no type for status
  response-body-type-changed
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the // response's property format changed from date-time to RFC3339 for status
  response-property-type-changed
- ○
  for the query request parameter page_size, the type was generalized from integer to string, and format from int32 to no format
  request-parameter-type-generalized
- ○
  the // response's property pattern ^shelves/[a-z2-7]{26}/books/[a-z2-7]{26}$ was removed for the status
  response-property-pattern-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history