/v1/{parent}/books

GET

/v1/{parent}/books

shelves

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://libraryagent.googleapis.com//v1//books'

Response Example

{
  "books": [
    {
      "author": "string",
      "name": "string",
      "read": true,
      "title": "string"
    }
  ],
  "nextPageToken": "string"
}

Request

Path Params

parent

string

required

Required. The name of the shelf whose books we'd like to list.

Query Params

pageSize

integer

optional

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

pageToken

string

optional

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

Responses

🟢200Successful response

application/json

Body

Response message for LibraryAgent.ListBooks.

books

array[object (GoogleExampleLibraryagentV1Book) {4}]

optional

The list of books.

author

string

optional

The name of the book author.

name

string

optional

The resource name of the book. Book names have the form shelves/{shelf_id}/books/{book_id}. The name is ignored when creating a book.

read

boolean

optional

Value indicating whether the book has been read.

title

string

optional

The title of the book.

nextPageToken

string

optional

A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to ListBooks method to retrieve the next page of results.

Modified at 2023-08-15 06:49:51

/v1/{name}:return