provider mylibrary GET /books/v1/mylibrary/annotations
@utdk/google/books /books/v1/mylibrary/annotations
mylibrary.annotations.list
Retrieves a list of annotations, possibly filtered.
$.xgafv query
V1 error format.
enum: 1, 2
access_token query
OAuth access token.
string
alt query
Data format for response.
enum: json, media, proto
callback query
JSONP
string
fields query
Selector specifying which fields to include in a partial response.
string
key query
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string
oauth_token query
OAuth 2.0 token for the current user.
string
prettyPrint query
Returns response with indentations and line breaks.
boolean
quotaUser query
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
upload_protocol query
Upload protocol for media (e.g. "raw", "multipart").
string
uploadType query
Legacy upload protocol for media (e.g. "media", "multipart").
string
contentVersion query
The content version for the requested volume.
string
layerId query
The layer ID to limit annotation by.
string
layerIds query
The layer ID(s) to limit annotation by.
array
maxResults query
Maximum number of results to return
integer
pageToken query
The value of the nextToken from the previous page.
string
showDeleted query
Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
boolean
source query
String to identify the originator of this request.
string
updatedMax query
RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
string
updatedMin query
RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
string
volumeId query
The volume to restrict annotations to.
string

Try it

Authentication
Configure credentials for Books API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

mylibraryAnnotationsList
GET/books/v1/mylibrary/annotations
Retrieves a list of annotations, possibly filtered.

V1 error format.

OAuth access token.

Data format for response.

JSONP

Selector specifying which fields to include in a partial response.

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

OAuth 2.0 token for the current user.

Returns response with indentations and line breaks.

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Upload protocol for media (e.g. "raw", "multipart").

Legacy upload protocol for media (e.g. "media", "multipart").

The content version for the requested volume.

The layer ID to limit annotation by.

The layer ID(s) to limit annotation by.

Maximum number of results to return

The value of the nextToken from the previous page.

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

String to identify the originator of this request.

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

The volume to restrict annotations to.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import google_books from '@utdk/google/books';

await google_books.mylibraryAnnotationsList()