Google_VolumesServiceResource

The "volumes" collection of methods.

Defined (1)

The class is defined in the following location(s).

/inc/google-api-php-client/src/contrib/Google_BooksService.php  
  1. class Google_VolumesServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Performs a book search. (volumes.list) 
  6. * @param string $q Full-text search query string. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string orderBy Sort search results. 
  9. * @opt_param string projection Restrict information returned to a set of selected fields. 
  10. * @opt_param string libraryRestrict Restrict search to this user's library. 
  11. * @opt_param string langRestrict Restrict results to books with this language code. 
  12. * @opt_param bool showPreorders Set to true to show books available for preorder. Defaults to false. 
  13. * @opt_param string printType Restrict to books or magazines. 
  14. * @opt_param string maxResults Maximum number of results to return. 
  15. * @opt_param string filter Filter search results. 
  16. * @opt_param string source String to identify the originator of this request. 
  17. * @opt_param string startIndex Index of the first result to return (starts at 0) 
  18. * @opt_param string download Restrict to volumes by download availability. 
  19. * @opt_param string partner Restrict and brand results for partner ID. 
  20. * @return Google_Volumes 
  21. */ 
  22. public function listVolumes($q, $optParams = array()) { 
  23. $params = array('q' => $q); 
  24. $params = array_merge($params, $optParams); 
  25. $data = $this->__call('list', array($params)); 
  26. if ($this->useObjects()) { 
  27. return new Google_Volumes($data); 
  28. } else { 
  29. return $data; 
  30. /** 
  31. * Gets volume information for a single volume. (volumes.get) 
  32. * @param string $volumeId ID of volume to retrieve. 
  33. * @param array $optParams Optional parameters. 
  34. * @opt_param string source String to identify the originator of this request. 
  35. * @opt_param string country ISO-3166-1 code to override the IP-based location. 
  36. * @opt_param string projection Restrict information returned to a set of selected fields. 
  37. * @opt_param string partner Brand results for partner ID. 
  38. * @return Google_Volume 
  39. */ 
  40. public function get($volumeId, $optParams = array()) { 
  41. $params = array('volumeId' => $volumeId); 
  42. $params = array_merge($params, $optParams); 
  43. $data = $this->__call('get', array($params)); 
  44. if ($this->useObjects()) { 
  45. return new Google_Volume($data); 
  46. } else { 
  47. return $data;