Gcp/books
@swamp/gcp/booksv2026.06.08.2
01README
Google Cloud books infrastructure models
02Release 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
03Models
bookshelves.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
fn sync()
Sync bookshelves state from GCP
fn list(source?: string, maxPages?: number)
List bookshelves resources
| Argument | Type | Description |
|---|---|---|
| source? | string | String to identify the originator of this request. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
bookshelves_volumes.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
fn sync()
Sync volumes state from GCP
fn list(maxResults?: number, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)
List volumes resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return |
| showPreorders? | boolean | Set to true to show pre-ordered books. Defaults to false. |
| source? | string | String to identify the originator of this request. |
| startIndex? | number | Index of the first element to return (starts at 0) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
layers.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a layers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the layers |
fn sync()
Sync layers state from GCP
fn list(contentVersion?: string, maxResults?: number, source?: string, maxPages?: number)
List layers resources
| Argument | Type | Description |
|---|---|---|
| contentVersion? | string | The content version for the requested volume. |
| maxResults? | number | Maximum number of results to return |
| source? | string | String to identify the originator of this request. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
layers_annotationdata.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a annotationData
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotationData |
fn sync()
Sync annotationData state from GCP
fn list(annotationDataId?: string, contentVersion?: string, h?: number, locale?: string, maxResults?: number, scale?: number, source?: string, updatedMax?: string, updatedMin?: string, w?: number, maxPages?: number)
List annotationData resources
| Argument | Type | Description |
|---|---|---|
| annotationDataId? | string | The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. |
| contentVersion? | string | The content version for the requested volume. |
| h? | number | The requested pixel height for any images. If height is provided width must also be provided. |
| locale? | string | The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| maxResults? | number | Maximum number of results to return |
| scale? | number | The requested scale for the image. |
| source? | string | String to identify the originator of this request. |
| updatedMax? | string | RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| updatedMin? | string | RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| w? | number | The requested pixel width for any images. If width is provided height must also be provided. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
layers_volumeannotations.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a volumeAnnotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumeAnnotations |
fn sync()
Sync volumeAnnotations state from GCP
fn list(contentVersion?: string, endOffset?: string, endPosition?: string, locale?: string, maxResults?: number, showDeleted?: boolean, source?: string, startOffset?: string, startPosition?: string, updatedMax?: string, updatedMin?: string, volumeAnnotationsVersion?: string, maxPages?: number)
List volumeAnnotations resources
| Argument | Type | Description |
|---|---|---|
| contentVersion? | string | The content version for the requested volume. |
| endOffset? | string | The end offset to end retrieving data from. |
| endPosition? | string | The end position to end retrieving data from. |
| locale? | string | The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| maxResults? | number | Maximum number of results to return |
| showDeleted? | boolean | Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. |
| source? | string | String to identify the originator of this request. |
| startOffset? | string | The start offset to start retrieving data from. |
| startPosition? | string | The start position to start retrieving data from. |
| updatedMax? | string | RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| updatedMin? | string | RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| volumeAnnotationsVersion? | string | The version of the volume annotations that you are requesting. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
mylibrary_annotations.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| 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 | The offset from the ending position. |
| created? | string | Timestamp for the created time of this annotation. |
| currentVersionRanges? | object | The offset from the ending position. |
| 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 | Maximum allowed characters on this layer, especially for the "copy" layer. |
| 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. |
fn create()
Create a annotations
fn get(identifier: string)
Get a annotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotations |
fn update()
Update annotations attributes
fn delete(identifier: string)
Delete the annotations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the annotations |
fn sync()
Sync annotations state from GCP
fn list(contentVersion?: string, layerId?: string, layerIds?: string, maxResults?: number, showDeleted?: boolean, source?: string, updatedMax?: string, updatedMin?: string, volumeId?: string, maxPages?: number)
List annotations resources
| Argument | Type | Description |
|---|---|---|
| contentVersion? | string | The content version for the requested volume. |
| layerId? | string | The layer ID to limit annotation by. |
| layerIds? | string | The layer ID(s) to limit annotation by. |
| maxResults? | number | Maximum number of results to return |
| showDeleted? | boolean | Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. |
| source? | string | String to identify the originator of this request. |
| updatedMax? | string | RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| updatedMin? | string | RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| volumeId? | string | The volume to restrict annotations to. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn summary()
summary
mylibrary_bookshelves.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
fn delete(identifier: string)
Delete the bookshelves
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bookshelves |
fn sync()
Sync bookshelves state from GCP
fn list(source?: string, maxPages?: number)
List bookshelves resources
| Argument | Type | Description |
|---|---|---|
| source? | string | String to identify the originator of this request. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_volume()
add volume
fn clear_volumes()
clear volumes
fn move_volume()
move volume
mylibrary_bookshelves_volumes.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
fn sync()
Sync volumes state from GCP
fn list(country?: string, maxResults?: number, projection?: string, q?: string, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)
List volumes resources
| Argument | Type | Description |
|---|---|---|
| country? | string | ISO-3166-1 code to override the IP-based location. |
| maxResults? | number | Maximum number of results to return |
| projection? | string | Restrict information returned to a set of selected fields. |
| q? | string | Full-text search query string in this bookshelf. |
| showPreorders? | boolean | Set to true to show pre-ordered books. Defaults to false. |
| source? | string | String to identify the originator of this request. |
| startIndex? | number | Index of the first element to return (starts at 0) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
mylibrary_readingpositions.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a readingpositions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the readingpositions |
fn sync()
Sync readingpositions state from GCP
fn set_position()
set position
notification.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a notification
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notification |
fn sync()
Sync notification state from GCP
personalizedstream.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a personalizedstream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the personalizedstream |
fn sync()
Sync personalizedstream state from GCP
promooffer.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a promooffer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the promooffer |
fn sync()
Sync promooffer state from GCP
fn accept()
accept
fn dismiss()
dismiss
series.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a series
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the series |
fn sync()
Sync series state from GCP
series_membership.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a membership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the membership |
fn sync()
Sync membership state from GCP
volumes.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a volumes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the volumes |
fn sync()
Sync volumes state from GCP
fn list(download?: string, filter?: string, langRestrict?: string, libraryRestrict?: string, maxAllowedMaturityRating?: string, maxResults?: number, orderBy?: string, partner?: string, printType?: string, projection?: string, q?: string, showPreorders?: boolean, source?: string, startIndex?: number, maxPages?: number)
List volumes resources
| Argument | Type | Description |
|---|---|---|
| download? | string | Restrict to volumes by download availability. |
| filter? | string | Filter search results. |
| langRestrict? | string | Restrict results to books with this language code. |
| libraryRestrict? | string | Restrict search to this user's library. |
| maxAllowedMaturityRating? | string | The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. |
| maxResults? | number | Maximum number of results to return. |
| orderBy? | string | Sort search results. |
| partner? | string | Restrict and brand results for partner ID. |
| printType? | string | Restrict to books or magazines. |
| projection? | string | Restrict information returned to a set of selected fields. |
| q? | string | Full-text search query string. |
| showPreorders? | boolean | Set to true to show books available for preorder. Defaults to false. |
| source? | string | String to identify the originator of this request. |
| startIndex? | number | Index of the first result to return (starts at 0) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
volumes_associated.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a associated
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the associated |
fn sync()
Sync associated state from GCP
fn list(association?: string, locale?: string, maxAllowedMaturityRating?: string, source?: string, maxPages?: number)
List associated resources
| Argument | Type | Description |
|---|---|---|
| association? | string | Association type. |
| locale? | string | ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. |
| maxAllowedMaturityRating? | string | The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. |
| source? | string | String to identify the originator of this request. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
volumes_mybooks.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a mybooks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mybooks |
fn sync()
Sync mybooks state from GCP
fn list(acquireMethod?: string, country?: string, locale?: string, maxResults?: number, processingState?: string, source?: string, startIndex?: number, maxPages?: number)
List mybooks resources
| Argument | Type | Description |
|---|---|---|
| acquireMethod? | string | How the book was acquired |
| country? | string | ISO-3166-1 code to override the IP-based location. |
| locale? | string | ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations. |
| maxResults? | number | Maximum number of results to return. |
| processingState? | string | The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. |
| source? | string | String to identify the originator of this request. |
| startIndex? | number | Index of the first result to return (starts at 0) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
volumes_recommended.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a recommended
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the recommended |
fn sync()
Sync recommended state from GCP
fn list(locale?: string, maxAllowedMaturityRating?: string, source?: string, maxPages?: number)
List recommended resources
| Argument | Type | Description |
|---|---|---|
| locale? | string | ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. |
| maxAllowedMaturityRating? | string | The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. |
| source? | string | String to identify the originator of this request. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn rate()
rate
volumes_useruploaded.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a useruploaded
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the useruploaded |
fn sync()
Sync useruploaded state from GCP
fn list(locale?: string, maxResults?: number, processingState?: string, source?: string, startIndex?: number, volumeId?: string, maxPages?: number)
List useruploaded resources
| Argument | Type | Description |
|---|---|---|
| locale? | string | ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. |
| maxResults? | number | Maximum number of results to return. |
| processingState? | string | The processing state of the user uploaded volumes to be returned. |
| source? | string | String to identify the originator of this request. |
| startIndex? | number | Index of the first result to return (starts at 0) |
| volumeId? | string | The ids of the volumes to be returned. If not specified all that match the processingState are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
04Previous Versions
2026.06.07.1Jun 7, 2026
- 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
2026.05.25.2May 25, 2026
- Updated: mylibrary_annotations, mylibrary_bookshelves, volumes_mybooks, volumes_recommended, volumes_useruploaded
Modified 13 models
2026.05.24.1May 24, 2026
- 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
2026.05.21.2May 21, 2026
- 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
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: bookshelves_volumes, layers_annotationdata, mylibrary_bookshelves_volumes, personalizedstream, series_membership, volumes, volumes_associated, volumes_mybooks, volumes_recommended, volumes_useruploaded
2026.04.03.3Apr 3, 2026
- 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
2026.04.03.1Apr 3, 2026
- 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
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- 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
05Stats
A
100 / 100
Downloads
0
Archive size
117.7 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels