@swamp/gcp/drive
v2026.04.23.1
Google Cloud drive infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-clouddrivecloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/driveteamdrives.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| backgroundImageFile? | object | The ID of an image file in Drive to use for the background image. |
| backgroundImageLink? | string | A short-lived link to this Team Drive's background image. |
| capabilities? | object | Whether the current user can add children to folders in this Team Drive. |
| colorRgb? | string | The 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? | string | The time at which the Team Drive was created (RFC 3339 date-time). |
| id? | string | The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| name? | string | The name of this Team Drive. |
| orgUnitId? | string | The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`. |
| restrictions? | object | Whether administrative privileges on this Team Drive are required to modify restrictions. |
| themeId? | string | The 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`. |
| requestId | string | Required. 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. |
createCreate a teamdrives
getGet a teamdrives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamdrives |
updateUpdate teamdrives attributes
deleteDelete the teamdrives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamdrives |
syncSync teamdrives state from GCP
permissions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| allowFileDiscovery? | boolean | Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. |
| domain? | string | The domain to which this permission refers. |
| emailAddress? | string | The email address of the user or group to which this permission refers. |
| expirationTime? | string | The 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? | boolean | When `true`, only organizers, owners, and users with permissions added directly on the item can access it. |
| pendingOwner? | boolean | Whether 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. |
| role | string | The 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). |
| type | string | The 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? | string | Indicates 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). |
| fileId | string | The ID of the file or shared drive. |
| emailMessage? | string | A plain text custom message to include in the notification email. |
| moveToNewOwnersRoot? | string | This 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? | string | Whether 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? | string | Whether the requesting application supports both My Drives and shared drives. |
| transferOwnership? | string | Whether 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? | string | Issue 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). |
createCreate a permissions
getGet a permissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the permissions |
updateUpdate permissions attributes
deleteDelete the permissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the permissions |
syncSync permissions state from GCP
comments.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| anchor? | string | A 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? | object | Output only. A plain text displayable name for this user. |
| content | string | The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed. |
| createdTime? | string | The time at which the comment was created (RFC 3339 date-time). |
| modifiedTime? | string | The last time the comment or any of its replies was modified (RFC 3339 date-time). |
| quotedFileContent? | object | The MIME type of the quoted content. |
| fileId | string | The ID of the file. |
createCreate a comments
getGet a comments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the comments |
updateUpdate comments attributes
deleteDelete the comments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the comments |
syncSync comments state from GCP
about.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a about
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the about |
syncSync about state from GCP
replies.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| action? | string | The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen` |
| author? | object | Output only. A plain text displayable name for this user. |
| content? | string | The 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? | string | The time at which the reply was created (RFC 3339 date-time). |
| modifiedTime? | string | The last time the reply was modified (RFC 3339 date-time). |
| fileId | string | The ID of the file. |
| commentId | string | The ID of the comment. |
createCreate a replies
getGet a replies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the replies |
updateUpdate replies attributes
deleteDelete the replies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the replies |
syncSync replies state from GCP
approvals.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a approvals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the approvals |
syncSync approvals state from GCP
apps.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a apps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apps |
syncSync apps state from GCP
drives.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| backgroundImageFile? | object | The ID of an image file in Google Drive to use for the background image. |
| colorRgb? | string | The 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? | string | The time at which the shared drive was created (RFC 3339 date-time). |
| hidden? | boolean | Whether the shared drive is hidden from default view. |
| name? | string | The name of this shared drive. |
| restrictions? | object | Whether administrative privileges on this shared drive are required to modify restrictions. |
| themeId? | string | The 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`. |
| requestId | string | Required. 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. |
createCreate a drives
getGet a drives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the drives |
updateUpdate drives attributes
deleteDelete the drives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the drives |
syncSync drives state from GCP
hidehide
unhideunhide
revisions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| exportLinks? | record | Output only. Links for exporting Docs Editors files to specific formats. |
| id? | string | Output only. The ID of the revision. |
| keepForever? | boolean | Whether 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? | string | Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. |
| lastModifyingUser? | object | Output only. A plain text displayable name for this user. |
| md5Checksum? | string | Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive. |
| mimeType? | string | Output only. The MIME type of the revision. |
| modifiedTime? | string | The last time the revision was modified (RFC 3339 date-time). |
| originalFilename? | string | Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive. |
| publishAuto? | boolean | Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files. |
| published? | boolean | Whether this revision is published. This is only applicable to Docs Editors files. |
| publishedLink? | string | Output only. A link to the published revision. This is only populated for Docs Editors files. |
| publishedOutsideDomain? | boolean | Whether this revision is published outside the domain. This is only applicable to Docs Editors files. |
| size? | string | Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive. |
getGet a revisions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the revisions |
updateUpdate revisions attributes
deleteDelete the revisions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the revisions |
syncSync revisions state from GCP
files.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| appProperties? | record | A 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? | object | Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small |
| contentHints? | object | Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. |
| contentRestrictions? | array | Whether 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? | boolean | Whether the options to copy, print, or download this file should be disabled for readers and commenters. |
| createdTime? | string | The time at which the file was created (RFC 3339 date-time). |
| description? | string | A short description of the file. |
| downloadRestrictions? | object | Whether download and copy is restricted for readers. |
| folderColorRgb? | string | The 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? | string | The ID of the file. |
| inheritedPermissionsDisabled? | boolean | Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. |
| lastModifyingUser? | object | Output only. A plain text displayable name for this user. |
| linkShareMetadata? | object | Output only. Whether the file is eligible for security update. |
| mimeType? | string | The 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? | string | The last time the file was modified by the user (RFC 3339 date-time). |
| modifiedTime? | string | he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. |
| name? | string | The 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? | string | The 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? | array | The 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? | record | A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. |
| sharedWithMeTime? | string | The time at which the file was shared with the user, if applicable (RFC 3339 date-time). |
| sharingUser? | object | Output only. A plain text displayable name for this user. |
| shortcutDetails? | object | The ID of the file that this shortcut points to. Can only be set on `files.create` requests. |
| starred? | boolean | Whether the user has starred the file. |
| trashed? | boolean | Whether 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? | string | The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. |
| trashingUser? | object | Output only. A plain text displayable name for this user. |
| viewedByMeTime? | string | The last time the file was viewed by the user (RFC 3339 date-time). |
| writersCanShare? | boolean | Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. |
| ignoreDefaultVisibility? | string | Whether 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? | string | A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. |
| includePermissionsForView? | string | Specifies which additional view's permissions to include in the response. Only `published` is supported. |
| keepRevisionForever? | string | Whether 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? | string | A language hint for OCR processing during image import (ISO 639-1 code). |
| supportsAllDrives? | string | Whether the requesting application supports both My Drives and shared drives. |
| useContentAsIndexableText? | string | Whether to use the uploaded content as indexable text. |
createCreate a files
getGet a files
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the files |
updateUpdate files attributes
deleteDelete the files
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the files |
syncSync files state from GCP
copycopy
| Argument | Type | Description |
|---|---|---|
| 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 |
downloaddownload
empty_trashempty trash
exportexport
generate_cse_tokengenerate cse token
generate_idsgenerate ids
list_labelslist labels
modify_labelsmodify labels
| Argument | Type | Description |
|---|---|---|
| kind? | any | |
| labelModifications? | any |
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
accessproposals.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a accessproposals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accessproposals |
syncSync accessproposals state from GCP
resolveresolve
| Argument | Type | Description |
|---|---|---|
| action? | any | |
| role? | any | |
| sendNotification? | any | |
| view? | any |
changes.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a changes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the changes |
syncSync changes state from GCP
get_start_page_tokenget start page token
watchwatch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
2026.04.09.179.6 KBApr 9, 2026
Google Cloud drive infrastructure models
Release Notes
- Updated: changes, files
Changelog
Models
~methods: +get_start_page_token, +watch, -create, -update, -delete
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure
2026.04.04.178.1 KBApr 4, 2026
Google Cloud drive infrastructure models
Release Notes
- Updated: changes
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure
2026.04.03.377.9 KBApr 3, 2026
Google Cloud drive infrastructure models
Release Notes
- Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure
2026.04.03.177.1 KBApr 3, 2026
Google Cloud drive infrastructure models
Release Notes
- Updated: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure
2026.04.02.276.9 KBApr 2, 2026
Google Cloud drive infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure
2026.03.27.175.0 KBMar 27, 2026
Google Cloud drive infrastructure models
Release Notes
- Added: about, accessproposals, approvals, apps, changes, comments, drives, files, permissions, replies, revisions, teamdrives
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddrivecloudinfrastructure