Skip to main content

Gcp/drive

@swamp/gcp/drivev2026.05.20.1· 1d agoMODELS
01README

Google Cloud drive infrastructure models

02Release Notes
  • Updated: approvals, changes, drives, files, permissions, teamdrives
03Models12
about.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a about
ArgumentTypeDescription
identifierstringThe name of the about
fn sync()
Sync about state from GCP
accessproposals.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a accessproposals
ArgumentTypeDescription
identifierstringThe name of the accessproposals
fn sync()
Sync accessproposals state from GCP
fn resolve(action?: any, role?: any, sendNotification?: any, view?: any)
resolve
ArgumentTypeDescription
action?any
role?any
sendNotification?any
view?any
approvals.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a approvals
ArgumentTypeDescription
identifierstringThe name of the approvals
fn sync()
Sync approvals state from GCP
fn approve(message?: any)
approve
ArgumentTypeDescription
message?any
fn cancel(message?: any)
cancel
ArgumentTypeDescription
message?any
fn comment(message?: any)
comment
ArgumentTypeDescription
message?any
fn decline(message?: any)
decline
ArgumentTypeDescription
message?any
fn reassign(addReviewers?: any, message?: any, replaceReviewers?: any)
reassign
ArgumentTypeDescription
addReviewers?any
message?any
replaceReviewers?any
fn start(dueTime?: any, lockFile?: any, message?: any, reviewerEmails?: any)
start
ArgumentTypeDescription
dueTime?any
lockFile?any
message?any
reviewerEmails?any
apps.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a apps
ArgumentTypeDescription
identifierstringThe name of the apps
fn sync()
Sync apps state from GCP
changes.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a changes
ArgumentTypeDescription
identifierstringThe name of the changes
fn sync()
Sync changes state from GCP
fn get_start_page_token()
get start page token
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
comments.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
anchor?stringA region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
author?objectOutput only. A plain text displayable name for this user.
contentstringThe plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
createdTime?stringThe time at which the comment was created (RFC 3339 date-time).
modifiedTime?stringThe last time the comment or any of its replies was modified (RFC 3339 date-time).
quotedFileContent?objectThe MIME type of the quoted content.
fileIdstringThe ID of the file.
fn create()
Create a comments
fn get(identifier: string)
Get a comments
ArgumentTypeDescription
identifierstringThe name of the comments
fn update()
Update comments attributes
fn delete(identifier: string)
Delete the comments
ArgumentTypeDescription
identifierstringThe name of the comments
fn sync()
Sync comments state from GCP
drives.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
backgroundImageFile?objectThe ID of an image file in Google Drive to use for the background image.
colorRgb?stringThe color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
createdTime?stringThe time at which the shared drive was created (RFC 3339 date-time).
hidden?booleanWhether the shared drive is hidden from default view.
name?stringThe name of this shared drive.
restrictions?objectWhether administrative privileges on this shared drive are required to modify restrictions.
themeId?stringThe ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
requestIdstringRequired. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
fn create()
Create a drives
fn get(identifier: string)
Get a drives
ArgumentTypeDescription
identifierstringThe name of the drives
fn update()
Update drives attributes
fn delete(identifier: string)
Delete the drives
ArgumentTypeDescription
identifierstringThe name of the drives
fn sync()
Sync drives state from GCP
fn hide()
hide
fn unhide()
unhide
files.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
appProperties?recordA collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
clientEncryptionDetails?objectChunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small
contentHints?objectText to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.
contentRestrictions?arrayWhether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
copyRequiresWriterPermission?booleanWhether the options to copy, print, or download this file should be disabled for readers and commenters.
createdTime?stringThe time at which the file was created (RFC 3339 date-time).
description?stringA short description of the file.
downloadRestrictions?objectWhether download and copy is restricted for readers.
folderColorRgb?stringThe color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
id?stringThe ID of the file.
inheritedPermissionsDisabled?booleanWhether this file has inherited permissions disabled. Inherited permissions are enabled by default.
labelInfo?objectOnly present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
lastModifyingUser?objectOutput only. A plain text displayable name for this user.
linkShareMetadata?objectOutput only. Whether the file is eligible for security update.
mimeType?stringThe MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
modifiedByMeTime?stringThe last time the file was modified by the user (RFC 3339 date-time).
modifiedTime?stringhe last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
name?stringThe name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
originalFilename?stringThe original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.
parents?arrayThe ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
properties?recordA collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
sharedWithMeTime?stringThe time at which the file was shared with the user, if applicable (RFC 3339 date-time).
sharingUser?objectOutput only. A plain text displayable name for this user.
shortcutDetails?objectThe ID of the file that this shortcut points to. Can only be set on `files.create` requests.
starred?booleanWhether the user has starred the file.
trashed?booleanWhether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted.
trashedTime?stringThe time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
trashingUser?objectOutput only. A plain text displayable name for this user.
viewedByMeTime?stringThe last time the file was viewed by the user (RFC 3339 date-time).
writersCanShare?booleanWhether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
ignoreDefaultVisibility?stringWhether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
includeLabels?stringA comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView?stringSpecifies which additional view's permissions to include in the response. Only `published` is supported.
keepRevisionForever?stringWhether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocrLanguage?stringA language hint for OCR processing during image import (ISO 639-1 code).
supportsAllDrives?stringWhether the requesting application supports both My Drives and shared drives.
useContentAsIndexableText?stringWhether to use the uploaded content as indexable text.
fn create()
Create a files
fn get(identifier: string)
Get a files
ArgumentTypeDescription
identifierstringThe name of the files
fn update()
Update files attributes
fn delete(identifier: string)
Delete the files
ArgumentTypeDescription
identifierstringThe name of the files
fn sync()
Sync files state from GCP
fn copy(appProperties?: any, capabilities?: any, clientEncryptionDetails?: any, contentHints?: any, contentRestrictions?: any, copyRequiresWriterPermission?: any, createdTime?: any, description?: any, downloadRestrictions?: any, driveId?: any, explicitlyTrashed?: any, exportLinks?: any, fileExtension?: any, folderColorRgb?: any, fullFileExtension?: any, hasAugmentedPermissions?: any, hasThumbnail?: any, headRevisionId?: any, iconLink?: any, id?: any, imageMediaMetadata?: any, inheritedPermissionsDisabled?: any, isAppAuthorized?: any, kind?: any, labelInfo?: any, lastModifyingUser?: any, linkShareMetadata?: any, md5Checksum?: any, mimeType?: any, modifiedByMe?: any, modifiedByMeTime?: any, modifiedTime?: any, name?: any, originalFilename?: any, ownedByMe?: any, owners?: any, parents?: any, permissionIds?: any, permissions?: any, properties?: any, quotaBytesUsed?: any, resourceKey?: any, sha1Checksum?: any, sha256Checksum?: any, shared?: any, sharedWithMeTime?: any, sharingUser?: any, shortcutDetails?: any, size?: any, spaces?: any, starred?: any, teamDriveId?: any, thumbnailLink?: any, thumbnailVersion?: any, trashed?: any, trashedTime?: any, trashingUser?: any, version?: any, videoMediaMetadata?: any, viewedByMe?: any, viewedByMeTime?: any, viewersCanCopyContent?: any, webContentLink?: any, webViewLink?: any, writersCanShare?: any)
copy
ArgumentTypeDescription
appProperties?any
capabilities?any
clientEncryptionDetails?any
contentHints?any
contentRestrictions?any
copyRequiresWriterPermission?any
createdTime?any
description?any
downloadRestrictions?any
driveId?any
explicitlyTrashed?any
exportLinks?any
fileExtension?any
folderColorRgb?any
fullFileExtension?any
hasAugmentedPermissions?any
hasThumbnail?any
headRevisionId?any
iconLink?any
id?any
imageMediaMetadata?any
inheritedPermissionsDisabled?any
isAppAuthorized?any
kind?any
labelInfo?any
lastModifyingUser?any
linkShareMetadata?any
md5Checksum?any
mimeType?any
modifiedByMe?any
modifiedByMeTime?any
modifiedTime?any
name?any
originalFilename?any
ownedByMe?any
owners?any
parents?any
permissionIds?any
permissions?any
properties?any
quotaBytesUsed?any
resourceKey?any
sha1Checksum?any
sha256Checksum?any
shared?any
sharedWithMeTime?any
sharingUser?any
shortcutDetails?any
size?any
spaces?any
starred?any
teamDriveId?any
thumbnailLink?any
thumbnailVersion?any
trashed?any
trashedTime?any
trashingUser?any
version?any
videoMediaMetadata?any
viewedByMe?any
viewedByMeTime?any
viewersCanCopyContent?any
webContentLink?any
webViewLink?any
writersCanShare?any
fn download()
download
fn empty_trash()
empty trash
fn export()
export
fn generate_cse_token()
generate cse token
fn generate_ids()
generate ids
fn list_labels()
list labels
fn modify_labels(kind?: any, labelModifications?: any)
modify labels
ArgumentTypeDescription
kind?any
labelModifications?any
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
ArgumentTypeDescription
address?any
expiration?any
id?any
kind?any
params?any
payload?any
resourceId?any
resourceUri?any
token?any
type?any
permissions.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
allowFileDiscovery?booleanWhether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
expirationTime?stringThe time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
inheritedPermissionsDisabled?booleanWhen `true`, only organizers, owners, and users with permissions added directly on the item can access it.
pendingOwner?booleanWhether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.
rolestringThe role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
typestringThe type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.
view?stringIndicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).
fileIdstringThe ID of the file or shared drive.
emailMessage?stringA plain text custom message to include in the notification email.
moveToNewOwnersRoot?stringThis parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.
sendNotificationEmail?stringWhether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
supportsAllDrives?stringWhether the requesting application supports both My Drives and shared drives.
transferOwnership?stringWhether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).
useDomainAdminAccess?stringIssue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).
fn create()
Create a permissions
fn get(identifier: string)
Get a permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
fn update()
Update permissions attributes
fn delete(identifier: string)
Delete the permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
fn sync()
Sync permissions state from GCP
replies.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
action?stringThe action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
author?objectOutput only. A plain text displayable name for this user.
content?stringThe plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
createdTime?stringThe time at which the reply was created (RFC 3339 date-time).
modifiedTime?stringThe last time the reply was modified (RFC 3339 date-time).
fileIdstringThe ID of the file.
commentIdstringThe ID of the comment.
fn create()
Create a replies
fn get(identifier: string)
Get a replies
ArgumentTypeDescription
identifierstringThe name of the replies
fn update()
Update replies attributes
fn delete(identifier: string)
Delete the replies
ArgumentTypeDescription
identifierstringThe name of the replies
fn sync()
Sync replies state from GCP
revisions.tsv2026.05.19.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
exportLinks?recordOutput only. Links for exporting Docs Editors files to specific formats.
id?stringOutput only. The ID of the revision.
keepForever?booleanWhether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
kind?stringOutput only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`.
lastModifyingUser?objectOutput only. A plain text displayable name for this user.
md5Checksum?stringOutput only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
mimeType?stringOutput only. The MIME type of the revision.
modifiedTime?stringThe last time the revision was modified (RFC 3339 date-time).
originalFilename?stringOutput only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.
publishAuto?booleanWhether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.
published?booleanWhether this revision is published. This is only applicable to Docs Editors files.
publishedLink?stringOutput only. A link to the published revision. This is only populated for Docs Editors files.
publishedOutsideDomain?booleanWhether this revision is published outside the domain. This is only applicable to Docs Editors files.
size?stringOutput only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
fn get(identifier: string)
Get a revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
fn update()
Update revisions attributes
fn delete(identifier: string)
Delete the revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
fn sync()
Sync revisions state from GCP
teamdrives.tsv2026.05.20.1

Global Arguments

ArgumentTypeDescription
backgroundImageFile?objectThe ID of an image file in Drive to use for the background image.
backgroundImageLink?stringA short-lived link to this Team Drive's background image.
capabilities?objectWhether the current user can add children to folders in this Team Drive.
colorRgb?stringThe color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
createdTime?stringThe time at which the Team Drive was created (RFC 3339 date-time).
id?stringThe ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
name?stringThe name of this Team Drive.
orgUnitId?stringThe organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
restrictions?objectWhether administrative privileges on this Team Drive are required to modify restrictions.
themeId?stringThe ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
requestIdstringRequired. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
fn create()
Create a teamdrives
fn get(identifier: string)
Get a teamdrives
ArgumentTypeDescription
identifierstringThe name of the teamdrives
fn update()
Update teamdrives attributes
fn delete(identifier: string)
Delete the teamdrives
ArgumentTypeDescription
identifierstringThe name of the teamdrives
fn sync()
Sync teamdrives state from GCP
04Previous Versions11
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026

Modified 1 models

2026.05.01.1May 1, 2026
  • Updated: approvals, changes, drives, files, permissions, teamdrives
2026.04.23.1Apr 23, 2026
2026.04.09.1Apr 9, 2026
  • Updated: changes, files

Modified 1 models

2026.04.04.1Apr 4, 2026
  • Updated: changes
2026.04.03.3Apr 3, 2026
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.04.03.1Apr 3, 2026
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
  • Added: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
05Stats
A
100 / 100
Downloads
1
Archive size
110.8 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 types1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels