Skip to main content

Gcp/drive

@swamp/gcp/drivev2026.07.21.4· 6d agoMODELS
01README

Google Cloud drive infrastructure models

02Release Notes
  • Added: children, parents, properties
  • Updated: approvals, changes, comments, drives, files, permissions, replies, revisions, teamdrives
03Models15
about.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
fn get(identifier: string)
Get a about
ArgumentTypeDescription
identifierstringThe name of the about
fn sync(identifier?: string)
Sync about state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific about by name (e.g. one discovered by list)
accessproposals.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
fileIdstringRequired. The ID of the item the request is on.
fn get(identifier: string)
Get a accessproposals
ArgumentTypeDescription
identifierstringThe name of the accessproposals
fn sync(identifier?: string)
Sync accessproposals state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific accessproposals by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List accessproposals resources
ArgumentTypeDescription
pageSize?numberOptional. The number of results per page.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn resolve(action?: any, role?: any, sendNotification?: any, view?: any)
resolve
ArgumentTypeDescription
action?any
role?any
sendNotification?any
view?any
approvals.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
fileIdstringRequired. The ID of the file that the approval is on.
fn get(identifier: string)
Get a approvals
ArgumentTypeDescription
identifierstringThe name of the approvals
fn sync(identifier?: string)
Sync approvals state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific approvals by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List approvals resources
ArgumentTypeDescription
pageSize?numberThe maximum number of approvals to return. When not set, at most 100 approvals are returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
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, fileContentChangeBehavior?: any, lockFile?: any, message?: any, reviewerEmails?: any)
start
ArgumentTypeDescription
dueTime?any
fileContentChangeBehavior?any
lockFile?any
message?any
reviewerEmails?any
apps.tsv2026.07.21.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
fn get(identifier: string)
Get a apps
ArgumentTypeDescription
identifierstringThe name of the apps
fn sync(identifier?: string)
Sync apps state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific apps by name (e.g. one discovered by list)
fn list(appFilterExtensions?: string, appFilterMimeTypes?: string, languageCode?: string, maxPages?: number)
List apps resources
ArgumentTypeDescription
appFilterExtensions?stringA comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given file extensions are included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists.
appFilterMimeTypes?stringA comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given MIME types will be included in the response. If `appFilterExtensions` are provided as well, the result is a union of the two resulting app lists.
languageCode?stringA language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
maxPages?numberMaximum number of pages to fetch (default: 10)
changes.tsv2026.07.21.3

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
pageTokenstringThe token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
fn get(identifier: string)
Get a changes
ArgumentTypeDescription
identifierstringThe name of the changes
fn sync(identifier?: string)
Sync changes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific changes by name (e.g. one discovered by list)
fn list(driveId?: string, includeCorpusRemovals?: boolean, includeItemsFromAllDrives?: boolean, includeLabels?: string, includePermissionsForView?: string, includeRemoved?: boolean, pageSize?: number, restrictToMyDrive?: boolean, spaces?: string, supportsAllDrives?: boolean, maxPages?: number)
List changes resources
ArgumentTypeDescription
driveId?stringThe shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
includeCorpusRemovals?booleanWhether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
includeItemsFromAllDrives?booleanWhether both My Drive and shared drive items should be included in results.
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.
includeRemoved?booleanWhether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
pageSize?numberThe maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
restrictToMyDrive?booleanWhether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
spaces?stringA comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
supportsAllDrives?booleanWhether the requesting application supports both My Drives and shared drives.
maxPages?numberMaximum number of pages to fetch (default: 10)
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
children.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
idstringThe ID of the child.
folderIdstringThe ID of the folder.
supportsAllDrives?stringWhether the requesting application supports both My Drives and shared drives.
fn create()
Create a children
fn get(identifier: string)
Get a children
ArgumentTypeDescription
identifierstringThe name of the children
fn delete(identifier: string)
Delete the children
ArgumentTypeDescription
identifierstringThe name of the children
fn sync(identifier?: string)
Sync children state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific children by name (e.g. one discovered by list)
fn list(maxResults?: number, orderBy?: string, q?: string, maxPages?: number)
List children resources
ArgumentTypeDescription
maxResults?numberMaximum number of children to return.
orderBy?stringA comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
q?stringQuery string for searching children.
maxPages?numberMaximum number of pages to fetch (default: 10)
comments.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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).
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(identifier?: string)
Update comments attributes
ArgumentTypeDescription
identifier?stringTarget a specific comments by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the comments
ArgumentTypeDescription
identifierstringThe name of the comments
fn sync(identifier?: string)
Sync comments state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific comments by name (e.g. one discovered by list)
fn list(includeDeleted?: boolean, pageSize?: number, startModifiedTime?: string, maxPages?: number)
List comments resources
ArgumentTypeDescription
includeDeleted?booleanWhether to include deleted comments. Deleted comments will not include their original content.
pageSize?numberThe maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.
startModifiedTime?stringThe minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
maxPages?numberMaximum number of pages to fetch (default: 10)
drives.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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(identifier?: string)
Update drives attributes
ArgumentTypeDescription
identifier?stringTarget a specific drives by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the drives
ArgumentTypeDescription
identifierstringThe name of the drives
fn sync(identifier?: string)
Sync drives state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific drives by name (e.g. one discovered by list)
fn list(pageSize?: number, q?: string, useDomainAdminAccess?: boolean, maxPages?: number)
List drives resources
ArgumentTypeDescription
pageSize?numberThe maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.
q?stringQuery string for searching shared drives.
useDomainAdminAccess?booleanIssue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn hide()
hide
fn unhide()
unhide
files.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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.
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).
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.
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(identifier?: string)
Update files attributes
ArgumentTypeDescription
identifier?stringTarget a specific files by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the files
ArgumentTypeDescription
identifierstringThe name of the files
fn sync(identifier?: string)
Sync files state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific files by name (e.g. one discovered by list)
fn list(corpora?: string, driveId?: string, includeItemsFromAllDrives?: boolean, includeLabels?: string, includePermissionsForView?: string, orderBy?: string, pageSize?: number, q?: string, spaces?: string, supportsAllDrives?: boolean, maxPages?: number)
List files resources
ArgumentTypeDescription
corpora?stringSpecifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
driveId?stringID of the shared drive to search.
includeItemsFromAllDrives?booleanWhether both My Drive and shared drive items should be included in results.
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.
orderBy?stringA comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
pageSize?numberThe maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.
q?stringA query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).
spaces?stringA comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
supportsAllDrives?booleanWhether the requesting application supports both My Drives and shared drives.
maxPages?numberMaximum number of pages to fetch (default: 10)
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
parents.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
idstringThe ID of the parent.
fileIdstringThe ID of the file.
supportsAllDrives?stringWhether the requesting application supports both My Drives and shared drives.
fn create()
Create a parents
fn get(identifier: string)
Get a parents
ArgumentTypeDescription
identifierstringThe name of the parents
fn delete(identifier: string)
Delete the parents
ArgumentTypeDescription
identifierstringThe name of the parents
fn sync(identifier?: string)
Sync parents state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific parents by name (e.g. one discovered by list)
fn list(maxPages?: number)
List parents resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
permissions.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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(identifier?: string)
Update permissions attributes
ArgumentTypeDescription
identifier?stringTarget a specific permissions by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
fn sync(identifier?: string)
Sync permissions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific permissions by name (e.g. one discovered by list)
fn list(includePermissionsForView?: string, pageSize?: number, supportsAllDrives?: boolean, useDomainAdminAccess?: boolean, maxPages?: number)
List permissions resources
ArgumentTypeDescription
includePermissionsForView?stringSpecifies which additional view's permissions to include in the response. Only `published` is supported.
pageSize?numberThe maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.
supportsAllDrives?booleanWhether the requesting application supports both My Drives and shared drives.
useDomainAdminAccess?booleanIssue 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).
maxPages?numberMaximum number of pages to fetch (default: 10)
properties.tsv2026.07.21.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
keystringThe key of this property.
value?stringThe value of this property.
visibility?stringThe visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
fileIdstringThe ID of the file.
fn create()
Create a properties
fn get(identifier: string)
Get a properties
ArgumentTypeDescription
identifierstringThe name of the properties
fn update(identifier?: string)
Update properties attributes
ArgumentTypeDescription
identifier?stringTarget a specific properties by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the properties
ArgumentTypeDescription
identifierstringThe name of the properties
fn sync(identifier?: string)
Sync properties state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific properties by name (e.g. one discovered by list)
fn list(maxPages?: number)
List properties resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
replies.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
action?stringThe action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
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(identifier?: string)
Update replies attributes
ArgumentTypeDescription
identifier?stringTarget a specific replies by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the replies
ArgumentTypeDescription
identifierstringThe name of the replies
fn sync(identifier?: string)
Sync replies state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific replies by name (e.g. one discovered by list)
fn list(includeDeleted?: boolean, pageSize?: number, maxPages?: number)
List replies resources
ArgumentTypeDescription
includeDeleted?booleanWhether to include deleted replies. Deleted replies don't include their original content.
pageSize?numberThe maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
revisions.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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.
fileIdstringThe ID of the file.
fn get(identifier: string)
Get a revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
fn update(identifier?: string)
Update revisions attributes
ArgumentTypeDescription
identifier?stringTarget a specific revisions by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
fn sync(identifier?: string)
Sync revisions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific revisions by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List revisions resources
ArgumentTypeDescription
pageSize?numberThe maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
teamdrives.tsv2026.07.21.4

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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(identifier?: string)
Update teamdrives attributes
ArgumentTypeDescription
identifier?stringTarget a specific teamdrives by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the teamdrives
ArgumentTypeDescription
identifierstringThe name of the teamdrives
fn sync(identifier?: string)
Sync teamdrives state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific teamdrives by name (e.g. one discovered by list)
fn list(pageSize?: number, q?: string, useDomainAdminAccess?: boolean, maxPages?: number)
List teamdrives resources
ArgumentTypeDescription
pageSize?numberMaximum number of Team Drives to return.
q?stringQuery string for searching Team Drives.
useDomainAdminAccess?booleanIssue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
04Previous Versions19
2026.07.21.1
  • Updated: comments, drives, files, permissions, replies, revisions, teamdrives, children, parents, properties
2026.07.20.2
  • Added: children, parents, properties
  • Updated: approvals, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.07.20.1
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.07.19.2
  • Updated: accessproposals, approvals, changes, revisions
2026.07.19.1
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives, children, parents, properties
2026.07.18.1
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives, children, parents, properties
2026.07.17.2
  • Updated: drives, files, teamdrives
2026.07.17.1
  • Updated: files, permissions, children, parents
2026.07.15.1
  • Updated: approvals, changes, comments, drives, files, permissions, replies, revisions
2026.06.25.1
  • Updated: changes, files
2026.06.08.2
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives, children, parents, properties
2026.06.07.1
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives, children, parents, properties
2026.06.05.1
  • Added: children, parents, properties
2026.05.26.1
  • Updated: approvals, changes, drives, files, permissions, teamdrives
2026.05.25.2
  • Updated: apps, drives, files, teamdrives

Modified 1 models

2026.05.24.1
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.05.21.2
  • Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
2026.05.21.1
2026.05.20.1
  • Updated: approvals, changes, drives, files, permissions, teamdrives
05Stats
A
100 / 100
Downloads
2
Archive size
195.3 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