@swamp/gcp/books
v2026.04.23.1
Google Cloud books infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudbookscloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/books@swamp/gcp/books/bookshelvesv2026.04.23.1bookshelves.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
syncSync bookshelves state from GCP
Resources
state(infinite)— Retrieves metadata for a specific bookshelf for the specified user.
@swamp/gcp/books/bookshelves-volumesv2026.04.23.1bookshelves_volumes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
syncSync volumes state from GCP
Resources
state(infinite)— Retrieves volumes in a specific bookshelf for the specified user.
@swamp/gcp/books/layersv2026.04.23.1layers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a layers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the layers |
syncSync layers state from GCP
Resources
state(infinite)— Gets the layer summary for a volume.
@swamp/gcp/books/layers-annotationdatav2026.04.23.1layers_annotationdata.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a annotationData
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotationData |
syncSync annotationData state from GCP
Resources
state(infinite)— Gets the annotation data.
@swamp/gcp/books/layers-volumeannotationsv2026.04.23.1layers_volumeannotations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a volumeAnnotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumeAnnotations |
syncSync volumeAnnotations state from GCP
Resources
state(infinite)— Gets the volume annotation.
@swamp/gcp/books/mylibrary-annotationsv2026.04.23.1mylibrary_annotations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| afterSelectedText? | string | Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. |
| beforeSelectedText? | string | Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. |
| clientVersionRanges? | object | Selection ranges sent from the client. |
| created? | string | Timestamp for the created time of this annotation. |
| currentVersionRanges? | object | Selection ranges for the most recent content version. |
| data? | string | User-created data for this annotation. |
| deleted? | boolean | Indicates that this annotation is deleted. |
| highlightStyle? | string | The highlight style for this annotation. |
| id? | string | Id of this annotation, in the form of a GUID. |
| layerId? | string | The layer this annotation is for. |
| layerSummary? | object | |
| pageIds? | array | Pages that this annotation spans. |
| selectedText? | string | Excerpt from the volume. |
| updated? | string | Timestamp for the last time this annotation was modified. |
| volumeId? | string | The volume that this annotation belongs to. |
| annotationId? | string | The ID for the annotation to insert. |
| country? | string | ISO-3166-1 code to override the IP-based location. |
| showOnlySummaryInResponse? | string | Requests that only the summary of the specified layer be provided in the response. |
| source? | string | String to identify the originator of this request. |
createCreate a annotations
getGet a annotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotations |
updateUpdate annotations attributes
deleteDelete the annotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotations |
syncSync annotations state from GCP
summarysummary
Resources
state(infinite)— Retrieves a list of annotations, possibly filtered.
@swamp/gcp/books/mylibrary-bookshelvesv2026.04.23.1mylibrary_bookshelves.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
deleteDelete the bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
syncSync bookshelves state from GCP
add_volumeadd volume
clear_volumesclear volumes
move_volumemove volume
Resources
state(infinite)— Retrieves metadata for a specific bookshelf belonging to the authenticated user.
@swamp/gcp/books/mylibrary-bookshelves-volumesv2026.04.23.1mylibrary_bookshelves_volumes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
syncSync volumes state from GCP
Resources
state(infinite)— Gets volume information for volumes on a bookshelf.
@swamp/gcp/books/mylibrary-readingpositionsv2026.04.23.1mylibrary_readingpositions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a readingpositions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the readingpositions |
syncSync readingpositions state from GCP
set_positionset position
Resources
state(infinite)— Retrieves my reading position information for a volume.
@swamp/gcp/books/notificationv2026.04.23.1notification.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a notification
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notification |
syncSync notification state from GCP
Resources
state(infinite)— Returns notification details for a given notification id.
@swamp/gcp/books/personalizedstreamv2026.04.23.1personalizedstream.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a personalizedstream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the personalizedstream |
syncSync personalizedstream state from GCP
Resources
state(infinite)— Returns a stream of personalized book clusters
@swamp/gcp/books/promoofferv2026.04.23.1promooffer.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a promooffer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the promooffer |
syncSync promooffer state from GCP
acceptaccept
dismissdismiss
Resources
state(infinite)— Returns a list of promo offers available to the user
@swamp/gcp/books/seriesv2026.04.23.1series.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a series
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the series |
syncSync series state from GCP
Resources
state(infinite)— Returns Series metadata for the given series ids.
@swamp/gcp/books/series-membershipv2026.04.23.1series_membership.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a membership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the membership |
syncSync membership state from GCP
Resources
state(infinite)— Returns Series membership data given the series id.
@swamp/gcp/books/volumesv2026.04.23.1volumes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
syncSync volumes state from GCP
Resources
state(infinite)— Gets volume information for a single volume.
@swamp/gcp/books/volumes-associatedv2026.04.23.1volumes_associated.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a associated
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the associated |
syncSync associated state from GCP
Resources
state(infinite)— Return a list of associated books.
@swamp/gcp/books/volumes-mybooksv2026.04.23.1volumes_mybooks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a mybooks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mybooks |
syncSync mybooks state from GCP
Resources
state(infinite)— Return a list of books in My Library.
@swamp/gcp/books/volumes-recommendedv2026.04.23.1volumes_recommended.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a recommended
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the recommended |
syncSync recommended state from GCP
raterate
Resources
state(infinite)— Return a list of recommended books for the current user.
@swamp/gcp/books/volumes-useruploadedv2026.04.23.1volumes_useruploaded.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a useruploaded
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the useruploaded |
syncSync useruploaded state from GCP
Resources
state(infinite)— Return a list of books uploaded by the current user.
2026.04.04.149.6 KBApr 4, 2026
Google Cloud books infrastructure models
Release Notes
- Updated: bookshelves_volumes, layers_annotationdata, mylibrary_bookshelves_volumes, personalizedstream, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbookscloudinfrastructure
2026.04.03.349.6 KBApr 3, 2026
Google Cloud books infrastructure models
Release Notes
- Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbookscloudinfrastructure
2026.04.03.147.6 KBApr 3, 2026
Google Cloud books infrastructure models
Release Notes
- Updated: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbookscloudinfrastructure
2026.04.02.247.5 KBApr 2, 2026
Google Cloud books infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbookscloudinfrastructure
2026.03.27.146.3 KBMar 27, 2026
Google Cloud books infrastructure models
Release Notes
- Added: bookshelves, bookshelves_volumes, layers, layers_annotationdata, layers_volumeannotations, mylibrary_annotations, mylibrary_bookshelves, mylibrary_bookshelves_volumes, mylibrary_readingpositions, notification, personalizedstream, promooffer, series, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudbookscloudinfrastructure