VolumesListOptions

import type { VolumesListOptions } from "https://googleapis.deno.dev/v1/books:v1.ts";

Additional options for Books#volumesList.

interface VolumesListOptions {

download?: "DOWNLOAD_UNDEFINED" | "EPUB";

filter?:

| "FILTER_UNDEFINED"

| "ebooks"

| "free-ebooks"

| "full"

| "paid-ebooks"

| "partial";

langRestrict?: string;

libraryRestrict?: "LIBRARY_RESTRICT_UNDEFINED" | "my-library" | "no-restrict";

maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature";

maxResults?: number;

orderBy?: "ORDER_BY_UNDEFINED" | "newest" | "relevance";

partner?: string;

printType?:

| "PRINT_TYPE_UNDEFINED"

| "ALL"

| "BOOKS"

| "MAGAZINES";

projection?: "PROJECTION_UNDEFINED" | "FULL" | "LITE";

q: string;

showPreorders?: boolean;

source?: string;

startIndex?: number;

}

§Properties

download?: "DOWNLOAD_UNDEFINED" | "EPUB"

[src]

Restrict to volumes by download availability.

[src]

Filter search results.

langRestrict?: string

[src]

Restrict results to books with this language code.

libraryRestrict?: "LIBRARY_RESTRICT_UNDEFINED" | "my-library" | "no-restrict"

[src]

Restrict search to this user's library.

maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"

[src]

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

maxResults?: number

[src]

Maximum number of results to return.

orderBy?: "ORDER_BY_UNDEFINED" | "newest" | "relevance"

[src]

Sort search results.

partner?: string

[src]

Restrict and brand results for partner ID.

printType?: "PRINT_TYPE_UNDEFINED" | "ALL" | "BOOKS" | "MAGAZINES"

[src]

Restrict to books or magazines.

projection?: "PROJECTION_UNDEFINED" | "FULL" | "LITE"

[src]

Restrict information returned to a set of selected fields.

q: string

[src]

Full-text search query string.

showPreorders?: boolean

[src]

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

source?: string

[src]

String to identify the originator of this request.

startIndex?: number

[src]

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