Google_Service_Books_LayersAnnotationData_Resource

The "annotationData" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Books.php  
  1. class Google_Service_Books_LayersAnnotationData_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets the annotation data. (annotationData.get) 
  5. * @param string $volumeId The volume to retrieve annotations for. 
  6. * @param string $layerId The ID for the layer to get the annotations. 
  7. * @param string $annotationDataId The ID of the annotation data to retrieve. 
  8. * @param string $contentVersion The content version for the volume you are 
  9. * trying to retrieve. 
  10. * @param array $optParams Optional parameters. 
  11. * @opt_param int scale The requested scale for the image. 
  12. * @opt_param string source String to identify the originator of this request. 
  13. * @opt_param bool allowWebDefinitions For the dictionary layer. Whether or not 
  14. * to allow web definitions. 
  15. * @opt_param int h The requested pixel height for any images. If height is 
  16. * provided width must also be provided. 
  17. * @opt_param string locale The locale information for the data. ISO-639-1 
  18. * language and ISO-3166-1 country code. Ex: 'en_US'. 
  19. * @opt_param int w The requested pixel width for any images. If width is 
  20. * provided height must also be provided. 
  21. * @return Google_Service_Books_Annotationdata 
  22. */ 
  23. public function get($volumeId, $layerId, $annotationDataId, $contentVersion, $optParams = array()) 
  24. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'annotationDataId' => $annotationDataId, 'contentVersion' => $contentVersion); 
  25. $params = array_merge($params, $optParams); 
  26. return $this->call('get', array($params), "Google_Service_Books_Annotationdata"); 
  27.  
  28. /** 
  29. * Gets the annotation data for a volume and layer. 
  30. * (annotationData.listLayersAnnotationData) 
  31. * @param string $volumeId The volume to retrieve annotation data for. 
  32. * @param string $layerId The ID for the layer to get the annotation data. 
  33. * @param string $contentVersion The content version for the requested volume. 
  34. * @param array $optParams Optional parameters. 
  35. * @opt_param int scale The requested scale for the image. 
  36. * @opt_param string source String to identify the originator of this request. 
  37. * @opt_param string locale The locale information for the data. ISO-639-1 
  38. * language and ISO-3166-1 country code. Ex: 'en_US'. 
  39. * @opt_param int h The requested pixel height for any images. If height is 
  40. * provided width must also be provided. 
  41. * @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated 
  42. * prior to this timestamp (exclusive). 
  43. * @opt_param string maxResults Maximum number of results to return 
  44. * @opt_param string annotationDataId The list of Annotation Data Ids to 
  45. * retrieve. Pagination is ignored if this is set. 
  46. * @opt_param string pageToken The value of the nextToken from the previous 
  47. * page. 
  48. * @opt_param int w The requested pixel width for any images. If width is 
  49. * provided height must also be provided. 
  50. * @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated 
  51. * since this timestamp (inclusive). 
  52. * @return Google_Service_Books_Annotationsdata 
  53. */ 
  54. public function listLayersAnnotationData($volumeId, $layerId, $contentVersion, $optParams = array()) 
  55. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'contentVersion' => $contentVersion); 
  56. $params = array_merge($params, $optParams); 
  57. return $this->call('list', array($params), "Google_Service_Books_Annotationsdata");