Skip to main content

annotations

Overview

Nameannotations
TypeResource
Idgoogledevelopers.books.annotations

Fields

NameDatatypeDescription
idstringId of this annotation, in the form of a GUID.
updatedstringTimestamp for the last time this annotation was modified.
pageIdsarrayPages that this annotation spans.
highlightStylestringThe highlight style for this annotation.
afterSelectedTextstringAnchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
layerIdstringThe layer this annotation is for.
datastringUser-created data for this annotation.
currentVersionRangesobjectSelection ranges for the most recent content version.
beforeSelectedTextstringAnchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
clientVersionRangesobjectSelection ranges sent from the client.
selfLinkstringURL to this resource.
selectedTextstringExcerpt from the volume.
volumeIdstringThe volume that this annotation belongs to.
kindstringResource type.
createdstringTimestamp for the created time of this annotation.
deletedbooleanIndicates that this annotation is deleted.
layerSummaryobject

Methods

NameAccessible byRequired ParamsDescription
mylibrary_annotations_listSELECTRetrieves a list of annotations, possibly filtered.
mylibrary_annotations_deleteDELETEannotationIdDeletes an annotation.
mylibrary_annotations_insertEXECInserts a new annotation.
mylibrary_annotations_summaryEXEClayerIds, volumeIdGets the summary of specified layers.
mylibrary_annotations_updateEXECannotationIdUpdates an existing annotation.