drive (v3)
PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to create it.
CODEBLOCK0
Helper Commands
| Command | Description |
|---|
+upload | Upload a file with automatic metadata |
API Resources
about
- get — Gets information about the user, the user's Drive, and system capabilities. For more information, see Return user info. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.
accessproposals
- get — Retrieves an access proposal by ID. For more information, see Manage pending access proposals.
- list — List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.
- resolve — Approves or denies an access proposal. For more information, see Manage pending access proposals.
approvals
- get — Gets an Approval by ID.
- list — Lists the Approvals on a file.
apps
- get — Gets a specific app. For more information, see Return user info.
- list — Lists a user's installed apps. For more information, see Return user info.
changes
- getStartPageToken — Gets the starting pageToken for listing future changes. For more information, see Retrieve changes.
- list — Lists the changes for a user or shared drive. For more information, see Retrieve changes.
- watch — Subscribes to changes for a user. For more information, see Notifications for resource changes.
channels
- stop — Stops watching resources through this channel. For more information, see Notifications for resource changes.
comments
- create — Creates a comment on a file. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.
- delete — Deletes a comment. For more information, see Manage comments and replies.
- get — Gets a comment by ID. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.
- list — Lists a file's comments. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.
- update — Updates a comment with patch semantics. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.
drives
- create — Creates a shared drive. For more information, see Manage shared drives.
- get — Gets a shared drive's metadata by ID. For more information, see Manage shared drives.
- hide — Hides a shared drive from the default view. For more information, see Manage shared drives.
- list — Lists the user's shared drives. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide.
- unhide — Restores a shared drive to the default view. For more information, see Manage shared drives.
- update — Updates the metadata for a shared drive. For more information, see Manage shared drives.
files
- copy — Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files.
- create — Creates a file. For more information, see Create and manage files. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded.
- download — Downloads the content of a file. For more information, see Download and export files. Operations are valid for 24 hours from the time of creation.
- export — Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see Download and export files. Note that the exported content is limited to 10 MB.
- generateIds — Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files.
- get — Gets a file's metadata or content by ID. For more information, see Search for files and folders. If you provide the URL parameter alt=media, then the response includes the file contents in the response body. Downloading content with alt=media only works if the file is stored in Drive.
- list — Lists the user's files. For more information, see Search for files and folders. This method accepts the q parameter, which is a search query combining one or more search terms. This method returns all files by default, including trashed files. If you don't want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results.
- listLabels — Lists the labels on a file. For more information, see List labels on a file.
- modifyLabels — Modifies the set of labels applied to a file. For more information, see Set a label field on a file. Returns a list of the labels that were added or modified.
- update — Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value.
- watch — Subscribes to changes to a file. For more information, see Notifications for resource changes.
operations
- get — Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
permissions
- create — Creates a permission for a file or shared drive. For more information, see Share files, folders, and drives. Warning: Concurrent permissions operations on the same file aren't supported; only the last update is applied.
- delete — Deletes a permission. For more information, see Share files, folders, and drives. Warning: Concurrent permissions operations on the same file aren't supported; only the last update is applied.
- get — Gets a permission by ID. For more information, see Share files, folders, and drives.
- list — Lists a file's or shared drive's permissions. For more information, see Share files, folders, and drives.
- update — Updates a permission with patch semantics. For more information, see Share files, folders, and drives. Warning: Concurrent permissions operations on the same file aren't supported; only the last update is applied.
replies
- create — Creates a reply to a comment. For more information, see Manage comments and replies.
- delete — Deletes a reply. For more information, see Manage comments and replies.
- get — Gets a reply by ID. For more information, see Manage comments and replies.
- list — Lists a comment's replies. For more information, see Manage comments and replies.
- update — Updates a reply with patch semantics. For more information, see Manage comments and replies.
revisions
- delete — Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see Manage file revisions.
- get — Gets a revision's metadata or content by ID. For more information, see Manage file revisions.
- list — Lists a file's revisions. For more information, see Manage file revisions. Important: The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision.
- update — Updates a revision with patch semantics. For more information, see Manage file revisions.
teamdrives
- create — Deprecated: Use drives.create instead.
- get — Deprecated: Use drives.get instead.
- list — Deprecated: Use drives.list instead.
- update — Deprecated: Use drives.update instead.
Discovering Commands
Before calling any API method, inspect it:
CODEBLOCK1
Use gws schema output to build your --params and --json flags.
drive (v3)
前置条件： 阅读 ../gws-shared/SKILL.md 了解认证、全局标志和安全规则。如果缺失，请运行 gws generate-skills 创建。
bash
gws drive <资源> <方法> [标志]
辅助命令
API 资源
about
- get — 获取用户、用户云端硬盘及系统能力的信息。更多信息请参阅返回用户信息。必需：必须设置 fields 参数。要返回所需的精确字段，请参阅返回特定字段。
accessproposals
- get — 通过ID检索访问提案。更多信息请参阅管理待处理的访问提案。
- list — 列出文件上的访问提案。更多信息请参阅管理待处理的访问提案。注意：只有审批者才能列出文件上的访问提案。如果用户不是审批者，将返回403错误。
- resolve — 批准或拒绝访问提案。更多信息请参阅管理待处理的访问提案。
approvals
- get — 通过ID获取审批。
- list — 列出文件上的审批。
apps
- get — 获取特定应用。更多信息请参阅返回用户信息。
- list — 列出用户已安装的应用。更多信息请参阅返回用户信息。
changes
- getStartPageToken — 获取用于列出未来更改的起始pageToken。更多信息请参阅检索更改。
- list — 列出用户或共享云端硬盘的更改。更多信息请参阅检索更改。
- watch — 订阅用户的更改。更多信息请参阅资源更改通知。
channels
- stop — 停止通过此频道监控资源。更多信息请参阅资源更改通知。
comments
- create — 在文件上创建评论。更多信息请参阅管理评论和回复。必需：必须设置 fields 参数。要返回所需的精确字段，请参阅返回特定字段。
- delete — 删除评论。更多信息请参阅管理评论和回复。
- get — 通过ID获取评论。更多信息请参阅管理评论和回复。必需：必须设置 fields 参数。要返回所需的精确字段，请参阅返回特定字段。
- list — 列出文件的评论。更多信息请参阅管理评论和回复。必需：必须设置 fields 参数。要返回所需的精确字段，请参阅返回特定字段。
- update — 使用补丁语义更新评论。更多信息请参阅管理评论和回复。必需：必须设置 fields 参数。要返回所需的精确字段，请参阅返回特定字段。
drives
- create — 创建共享云端硬盘。更多信息请参阅管理共享云端硬盘。
- get — 通过ID获取共享云端硬盘的元数据。更多信息请参阅管理共享云端硬盘。
- hide — 从默认视图中隐藏共享云端硬盘。更多信息请参阅管理共享云端硬盘。
- list — 列出用户的共享云端硬盘。此方法接受 q 参数，这是一个组合一个或多个搜索词的搜索查询。更多信息请参阅搜索共享云端硬盘指南。
- unhide — 将共享云端硬盘恢复到默认视图。更多信息请参阅管理共享云端硬盘。
- update — 更新共享云端硬盘的元数据。更多信息请参阅管理共享云端硬盘。
files
- copy — 创建文件的副本，并使用补丁语义应用任何请求的更新。更多信息请参阅创建和管理文件。
- create — 创建文件。更多信息请参阅创建和管理文件。此方法支持 /upload URI，并接受具有以下特征的上传媒体： - 最大文件大小： 5,120 GB - 接受的媒体MIME类型： /（请指定有效的MIME类型，而不是字面值 /。字面值 / 仅用于表示可以上传任何有效的MIME类型。
- download — 下载文件的内容。更多信息请参阅下载和导出文件。操作自创建之时起24小时内有效。
- export — 将Google Workspace文档导出为请求的MIME类型，并返回导出的字节内容。更多信息请参阅下载和导出文件。注意，导出的内容限制为10 MB。
- generateIds — 生成一组文件ID，可在创建或复制请求中提供。更多信息请参阅创建和管理文件。
- get — 通过ID获取文件的元数据或内容。更多信息请参阅搜索文件和文件夹。如果提供URL参数 alt=media，则响应体中将包含文件内容。使用 alt=media 下载内容仅适用于存储在云端硬盘中的文件。
- list — 列出用户的文件。更多信息请参阅搜索文件和文件夹。此方法接受 q 参数，这是一个组合一个或多个搜索词的搜索查询。此方法默认返回所有文件，包括已删除的文件。如果不希望已删除的文件出现在列表中，请使用 trashed=false 查询参数从结果中移除已删除的文件。
- listLabels — 列出文件上的标签。更多信息请参阅列出文件上的标签。
- modifyLabels — 修改应用于文件的标签集。更多信息请参阅在文件上设置标签字段。返回已添加或修改的标签列表。
- update — 更新文件的元数据、内容或两者。调用此方法时，仅填充要修改的请求字段。更新字段时，某些字段可能会自动更改，例如 modifiedDate。此方法支持补丁语义。此方法支持 /upload URI，并接受具有以下特征的上传媒体： - 最大文件大小： 5,120 GB - 接受的媒体MIME类型： /
