KOkollalabs
LibraryService

ListBooks

Changed on

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

Request

  • Base URL
    https://library-example.googleapis.com
  • Auth
    none declared

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

OK

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

  • v1ac9d37cae0e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

  • v1639a4ec995caRevision changes
    • info

      the response property // became required for the status