shelves

Creates, updates, deletes, gets or lists a shelves resource.

Overview

Name	shelves
Type	Resource
Id	google.libraryagent.shelves

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	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	The theme of the shelf

list

Successful response

Name	Datatype	Description
name	string	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	The theme of the shelf

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	shelvesId		Gets a shelf. Returns NOT_FOUND if the shelf does not exist.
list	select		pageSize, pageToken	Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
shelvesId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

SELECT
name,
theme
FROM google.libraryagent.shelves
WHERE shelvesId = '{{ shelvesId }}' -- required;

list

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

SELECT
name,
theme
FROM google.libraryagent.shelves
WHERE pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';