/v1/shelves

GET

/v1/shelves

shelves

Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
  "nextPageToken": "string",
  "shelves": [
    {
      "name": "string",
      "theme": "string"
    }
  ]
}

Request

Query Params

pageSize

integer

optional

Requested page size. Server may return fewer shelves 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 ListShelvesResponse.next_page_token returned from the previous call to ListShelves method.

Responses

🟢200Successful response

application/json

Body

Response message for LibraryAgent.ListShelves.

nextPageToken

string

optional

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

shelves

array[object (GoogleExampleLibraryagentV1Shelf) {2}]

optional

The list of shelves.

name

string

optional

Output only. The resource name of the shelf. Shelf names have the form shelves/{shelf_id}. The name is ignored when creating a shelf.

theme

string

optional

The theme of the shelf

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

/v1/{name}