Documentation

Google_Service_Books_Resource_Volumes extends Google_Service_Resource
in package

The "volumes" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Books_Volume
Gets volume information for a single volume. (volumes.get)
listVolumes()  : Google_Service_Books_Volumes
Performs a book search. (volumes.listVolumes)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets volume information for a single volume. (volumes.get)

public get(string $volumeId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Volume
Parameters
$volumeId : string

ID of volume to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string partner Brand results for partner ID.

opt_param

string country ISO-3166-1 code to override the IP-based location.

opt_param

string projection Restrict information returned to a set of selected fields.

opt_param

string source string to identify the originator of this request.

opt_param

bool user_library_consistent_read

opt_param

bool includeNonComicsSeries Set to true to include non-comics series. Defaults to false.

Return values
Google_Service_Books_Volume —

listVolumes()

Performs a book search. (volumes.listVolumes)

public listVolumes([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Volumes
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string projection Restrict information returned to a set of selected fields.

opt_param

string source String to identify the originator of this request.

opt_param

string download Restrict to volumes by download availability.

opt_param

string langRestrict Restrict results to books with this language code.

opt_param

string printType Restrict to books or magazines.

opt_param

bool showPreorders Set to true to show books available for preorder. Defaults to false.

opt_param

string q Full-text search query string.

opt_param

string libraryRestrict Restrict search to this user's library.

opt_param

string partner Restrict and brand results for partner ID.

opt_param

string orderBy Sort search results.

opt_param

string maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

opt_param

string maxResults Maximum number of results to return.

opt_param

string filter Filter search results.

opt_param

string startIndex Index of the first result to return (starts at 0)

Return values
Google_Service_Books_Volumes —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results