Google_Service_Books_Volumes_Resource Class Reference

The "volumes" collection of methods. More...

Inheritance diagram for Google_Service_Books_Volumes_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($volumeId, $optParams=array())
	Gets volume information for a single volume.
	listVolumes ($q, $optParams=array())
	Performs a book search.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "volumes" collection of methods.

Typical usage is: $booksService = new Google_Service_Books(...); $volumes = $booksService->volumes;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_Books_Volumes_Resource::get	(		$volumeId,
			$optParams = array() )

Gets volume information for a single volume.

(volumes.get)

Parameters

string	$volumeId	ID of volume to retrieve.
array	$optParams	Optional parameters.

@opt_param bool user_library_consistent_read @opt_param string projection Restrict information returned to a set of selected fields. @opt_param string country ISO-3166-1 code to override the IP-based location. @opt_param string source String to identify the originator of this request. @opt_param string partner Brand results for partner ID.

Return values

Google_Service_Books_Volume

listVolumes()

Google_Service_Books_Volumes_Resource::listVolumes	(		$q,
			$optParams = array() )

Performs a book search.

(volumes.listVolumes)

Parameters

string	$q	Full-text search query string.
array	$optParams	Optional parameters.

@opt_param string orderBy Sort search results. @opt_param string projection Restrict information returned to a set of selected fields. @opt_param string libraryRestrict Restrict search to this user's library. @opt_param string langRestrict Restrict results to books with this language code. @opt_param bool showPreorders Set to true to show books available for preorder. Defaults to false. @opt_param string printType Restrict to books or magazines. @opt_param string maxResults Maximum number of results to return. @opt_param string filter Filter search results. @opt_param string source String to identify the originator of this request. @opt_param string startIndex Index of the first result to return (starts at 0) @opt_param string download Restrict to volumes by download availability. @opt_param string partner Restrict and brand results for partner ID.

Return values

Google_Service_Books_Volumes

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Books.php