Drive commands
Look up Google Drive CLI commands, API methods, flags and exit codes in the generated reference.
Command and option reference for the built Drive CLI.
Global options
These options apply to the selected profile and current invocation.
| Option | What it does |
|---|---|
-V, --version | output the version number. |
--profile <name> | Google account profile. Default: default. |
--json | print machine-readable JSON. |
--jsonl | print machine-readable JSON lines. |
--agent-json | show control and direction characters visibly in machine output. |
--quiet | suppress optional diagnostics. |
--timeout <duration> | whole-command deadline, e.g. 30s. |
--max-output-bytes <n> | bound buffered result output. Default: 4194304. |
--read-only | refuse local and remote mutations. |
--offline | answer only operations that use local cached data. |
--dry-run | validate command/policy and preview without acting. |
--yes | answer a policy confirmation; cannot override deny or readonly. |
--allow-dangerous | answer a permanent-deletion confirmation. |
--permission <key=level> | temporary policy override; repeat to add keys. |
drive session
Google browser sign-in and local account profiles
drive session start
Approve Google access in your browser; read-only unless --write is requested
This command can change Google data or send data to the configured model.
drive session start [options]| Option | What it does |
|---|---|
--client-file <file> | Desktop OAuth application JSON. |
--credential-storage <storage> | keyring or explicit private-file storage. Default: keyring. |
--no-browser | print the sign-in URL without opening a browser. |
--write | request remote Drive/Docs mutation permissions. |
--activity | also request Drive Activity history permissions. |
--apps | also request the installed Drive applications permission. |
drive session list
Configured account profiles; no credentials are printed
drive session listdrive session end
Remove this profile's local sign-in; cached data is retained
This command changes local state.
drive session enddrive folders
Select Google folders for local ingestion
drive folders add
Include a folder and its descendants
This command changes local state.
drive folders add <url-or-id>| Argument | Requirement | What it is |
|---|---|---|
url-or-id | required |
drive folders list
Selected folder IDs
drive folders listdrive folders remove
Stop importing a folder; sync removes sources outside the remaining scope
This command changes local state.
drive folders remove <url-or-id>| Argument | Requirement | What it is |
|---|---|---|
url-or-id | required |
drive sync
Fetch selected sources and resume a durable pending batch
This command changes local state.
drive sync [options]| Option | What it does |
|---|---|
--max <n> | maximum source operations this run. Default: 200. |
--rescan | reconcile selected folders from a fresh change token. |
--embed | embed pending shared note chunks using an already-downloaded model. |
drive status
Local sync checkpoint, cached sources and pending work
drive statusdrive documents
Locally imported sources and exports
drive documents list
Imported sources with original Google URLs
drive documents list [options]| Option | What it does |
|---|---|
--tag <tag> | filter by a local shared tag. |
--person <reference> | filter by a linked shared person reference. |
drive documents show
Imported text with tab and source metadata
drive documents show <url-or-id>| Argument | Requirement | What it is |
|---|---|---|
url-or-id | required |
drive documents export
Write the native Markdown snapshot; existing files are refused
This command changes local state.
drive documents export <url-or-id> [options]| Argument | Requirement | What it is |
|---|---|---|
url-or-id | required |
| Option | What it does |
|---|---|
--out <file> | destination Markdown file. |
drive documents context
Source document, tags, links, notes, memories and observed editors
drive documents context <document>| Argument | Requirement | What it is |
|---|---|---|
document | required |
drive documents get
Live Docs JSON with every tab
drive documents get <document>| Argument | Requirement | What it is |
|---|---|---|
document | required |
drive documents create
This command can change Google data or send data to the configured model.
drive documents create [options]| Option | What it does |
|---|---|
--title <title> |
drive documents update
This command can change Google data or send data to the configured model.
drive documents update <document> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required |
| Option | What it does |
|---|---|
--body <json> | Docs batchUpdate body, including requests and optional writeControl. |
drive documents history
drive documents history <document> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required |
| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
--activity | read actor/activity events instead of revisions; requires session start --activity. |
drive search
Shared keyword and optional semantic search over imported Google sources
drive search <query> [options]| Argument | Requirement | What it is |
|---|---|---|
query | required |
| Option | What it does |
|---|---|
--limit <n> | maximum results. Default: 20. |
--offset <n> | results to skip. Default: 0. |
--exact | keyword search only, without stemming or meaning. |
drive tags
Local tags on shared documents; preserved through resync
drive tags list
drive tags list <document>| Argument | Requirement | What it is |
|---|---|---|
document | required |
drive tags add
This command changes local state.
drive tags add <document> <tags>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
tags | required |
drive tags remove
This command changes local state.
drive tags remove <document> <tags>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
tags | required |
drive links
Connect documents to shared people, projects, notes and other references
drive links list
drive links list <document>| Argument | Requirement | What it is |
|---|---|---|
document | required |
drive links add
This command changes local state.
drive links add <document> <target-reference> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required | |
target-reference | required |
| Option | What it does |
|---|---|
--kind <kind> | One of: links-to, about, evidence, created-from, related-to, assigned-to. Default: related-to. |
--role <role> | |
--evidence <text> |
drive links remove
This command changes local state.
drive links remove <document> <link-id>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
link-id | required |
drive notes
Local shared memos about a source document
drive notes add
This command changes local state.
drive notes add <document> <text> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required | |
text | required |
| Option | What it does |
|---|---|
--title <title> |
drive notes list
drive notes list <document> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required |
| Option | What it does |
|---|---|
--search <text> | |
--limit <n> | maximum notes. Default: 50. |
--offset <n> | notes to skip. Default: 0. |
drive notes show
drive notes show <document> <note-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
note-reference | required |
drive notes edit
This command changes local state.
drive notes edit <document> <note-reference> <text> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required | |
note-reference | required | |
text | required |
| Option | What it does |
|---|---|
--revision <n> | revision from notes show; refuses stale edits. |
drive notes remove
This command changes local state.
drive notes remove <document> <note-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
note-reference | required |
drive memories
Evidence-backed shared memories; AI output remains proposed
drive memories add
This command changes local state.
drive memories add <document> <text> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required | |
text | required |
| Option | What it does |
|---|---|
--scope <scope> | One of: personal, work. |
--kind <kind> | One of: summary, digest, fact, preference. Default: fact. |
--supersedes <memory-reference> | replace an earlier memory about this same source. |
drive memories list
drive memories list <document> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required |
| Option | What it does |
|---|---|
--scope <scope> | One of: personal, work. |
--kind <kind> | One of: summary, digest, fact, preference. |
--limit <n> | maximum memories. Default: 50. |
drive memories show
drive memories show <document> <memory-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
memory-reference | required |
drive memories confirm
This command changes local state.
drive memories confirm <document> <memory-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
memory-reference | required |
drive memories stale
This command changes local state.
drive memories stale <document> <memory-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
memory-reference | required |
drive memories search
drive memories search <document> <query> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required | |
query | required |
| Option | What it does |
|---|---|
--scope <scope> | One of: personal, work. |
drive memories extract
Explicitly send selected text to the configured shared model; preview proposals or save them
This command can change Google data or send data to the configured model.
drive memories extract <document> [options]| Argument | Requirement | What it is |
|---|---|---|
document | required |
| Option | What it does |
|---|---|
--scope <scope> | One of: personal, work. |
--tab <id> | extract only this cached Google Docs tab. |
--save | save proposed memories with quotes and source snapshot hash. |
drive people
Google-observed identities and explicit links to shared people
drive people list
drive people list <document>| Argument | Requirement | What it is |
|---|---|---|
document | required |
drive people link
This command changes local state.
drive people link <document> <google-id> <person-reference>| Argument | Requirement | What it is |
|---|---|---|
document | required | |
google-id | required | |
person-reference | required |
drive api
Discover and call the official Drive, Docs and Activity SDK methods
drive api methods
drive api methods [options]| Option | What it does |
|---|---|
--service <name> | drive, docs or driveactivity. |
drive api call
This command can change Google data or send data to the configured model.
drive api call <method> [options]| Argument | Requirement | What it is |
|---|---|---|
method | required |
| Option | What it does |
|---|---|
--params <json> | JSON query/path parameters. Default: [object Object]. |
--body <json> | JSON request body. |
--allow-write | explicitly permit a mutating generic method. |
--allow-delete | explicitly permit permanent deletion or emptying trash. |
drive api docs-documents-batch-update
Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. — write (POST v1/documents/{documentId}:batchUpdate)
This command can change Google data or send data to the configured model.
drive api docs-documents-batch-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--alt <value> | Data format for response. |
--callback <value> | JSONP. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--document-id <value> | The ID of the document to update. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api docs-documents-create
Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document. — write (POST v1/documents)
This command can change Google data or send data to the configured model.
drive api docs-documents-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--alt <value> | Data format for response. |
--callback <value> | JSONP. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api docs-documents-get
Gets the latest version of the specified document. — read (GET v1/documents/{documentId})
drive api docs-documents-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--alt <value> | Data format for response. |
--callback <value> | JSONP. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--document-id <value> | The ID of the document to retrieve. |
--comments-view-mode <value> | The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to true or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. |
--include-tabs-content <value> | Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When true: Document content populates in the Document.tabs field instead of the text content fields in Document. - When false: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. If you use a field mask that references the Document.tabs field (or any subfield), the API implicitly treats the request as if you set include_tabs_content to true. |
--suggestions-view-mode <value> | The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used. |
drive api drive-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. — read (GET about)
drive api drive-about-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
drive api drive-accessproposals-get
Retrieves an access proposal by ID. For more information, see Manage pending access proposals. — read (GET files/{fileId}/accessproposals/{proposalId})
drive api drive-accessproposals-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--proposal-id <value> | Required. The ID of the access proposal to resolve. |
--file-id <value> | Required. The ID of the item the request is on. |
drive api drive-accessproposals-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. — read (GET files/{fileId}/accessproposals)
drive api drive-accessproposals-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--page-token <value> | Optional. The continuation token on the list of access requests. |
--file-id <value> | Required. The ID of the item the request is on. |
--page-size <value> | Optional. The number of results per page. |
drive api drive-accessproposals-resolve
Approves or denies an access proposal. For more information, see Manage pending access proposals. — write (POST files/{fileId}/accessproposals/{proposalId}:resolve)
This command can change Google data or send data to the configured model.
drive api drive-accessproposals-resolve [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the item the request is on. |
--proposal-id <value> | Required. The ID of the access proposal to resolve. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-approve
Approves an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of APPROVED. If this is the last required reviewer response, this also completes the approval and sets the approval Status to APPROVED. — write (POST files/{fileId}/approvals/{approvalId}:approve)
This command can change Google data or send data to the configured model.
drive api drive-approvals-approve [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--approval-id <value> | Required. The ID of the approval to approve. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-cancel
Cancels an approval. For more information, see Manage approvals. Updates the approval Status to CANCELLED. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS. — write (POST files/{fileId}/approvals/{approvalId}:cancel)
This command can change Google data or send data to the configured model.
drive api drive-approvals-cancel [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--approval-id <value> | Required. The ID of the approval to cancel. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-comment
Comments on an approval. For more information, see Manage approvals. This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log. — write (POST files/{fileId}/approvals/{approvalId}:comment)
This command can change Google data or send data to the configured model.
drive api drive-approvals-comment [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--approval-id <value> | Required. The ID of the approval to comment on. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-decline
Declines an approval. For more information, see Manage approvals. This is used to update the ReviewerResponse of the requesting user with a Response of DECLINED. This also completes the approval and sets the approval Status to DECLINED. — write (POST files/{fileId}/approvals/{approvalId}:decline)
This command can change Google data or send data to the configured model.
drive api drive-approvals-decline [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--approval-id <value> | Required. The ID of the approval to decline. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-get
Gets an approval by ID. For more information, see Manage approvals. — read (GET files/{fileId}/approvals/{approvalId})
drive api drive-approvals-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--approval-id <value> | Required. The ID of the approval. |
drive api drive-approvals-list
Lists the approvals on a file. For more information, see Manage approvals. By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the fields query parameter. To return the exact fields you need, see Return specific fields. — read (GET files/{fileId}/approvals)
drive api drive-approvals-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--page-size <value> | The maximum number of approvals to return. When not set, at most 100 approvals are returned. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response. |
drive api drive-approvals-reassign
Reassigns the reviewers on an approval. For more information, see Manage approvals. Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the writer permission on the file while the approval Status is IN_PROGRESS and the Response for the reviewer being reassigned is NO_RESPONSE. A user with the reader permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed. — write (POST files/{fileId}/approvals/{approvalId}:reassign)
This command can change Google data or send data to the configured model.
drive api drive-approvals-reassign [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--approval-id <value> | Required. The ID of the approval to reassign. |
--file-id <value> | Required. The ID of the file that the approval is on. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-approvals-start
Starts an approval on a file. For more information, see Manage approvals. — write (POST files/{fileId}/approvals:start)
This command can change Google data or send data to the configured model.
drive api drive-approvals-start [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file that the approval is created on. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-apps-get
Gets a specific app. For more information, see Return user info. — read (GET apps/{appId})
drive api drive-apps-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--app-id <value> | The ID of the app. |
drive api drive-apps-list
Lists a user's installed apps. For more information, see Return user info. — read (GET apps)
drive api drive-apps-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--language-code <value> | A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). |
--app-filter-extensions <value> | A 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. |
--app-filter-mime-types <value> | A 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. |
drive api drive-changes-get-start-page-token
Gets the starting pageToken for listing future changes. For more information, see Retrieve changes. — read (GET changes/startPageToken)
drive api drive-changes-get-start-page-token [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--drive-id <value> | The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--team-drive-id <value> | Deprecated: Use driveId instead. |
drive api drive-changes-list
Lists the changes for a user or shared drive. For more information, see Retrieve changes. — read (GET changes)
drive api drive-changes-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--drive-id <value> | The 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. |
--restrict-to-my-drive <value> | Whether 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. |
--include-items-from-all-drives <value> | Whether both My Drive and shared drive items should be included in results. |
--include-corpus-removals <value> | Whether 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. |
--include-team-drive-items <value> | Deprecated: Use includeItemsFromAllDrives instead. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--page-token <value> | The 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. |
--page-size <value> | The 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. |
--include-removed <value> | Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--team-drive-id <value> | Deprecated: Use driveId instead. |
--spaces <value> | A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. |
drive api drive-changes-watch
Subscribes to changes for a user. For more information, see Notifications for resource changes. — write (POST changes/watch)
This command can change Google data or send data to the configured model.
drive api drive-changes-watch [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--spaces <value> | A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. |
--include-items-from-all-drives <value> | Whether both My Drive and shared drive items should be included in results. |
--page-size <value> | The 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. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--restrict-to-my-drive <value> | Whether 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. |
--team-drive-id <value> | Deprecated: Use driveId instead. |
--include-corpus-removals <value> | Whether 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. |
--include-team-drive-items <value> | Deprecated: Use includeItemsFromAllDrives instead. |
--include-removed <value> | Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. |
--drive-id <value> | The 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. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
--page-token <value> | The 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. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-channels-stop
Stops watching resources through this channel. For more information, see Notifications for resource changes. — write (POST channels/stop)
This command can change Google data or send data to the configured model.
drive api drive-channels-stop [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-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. — write (POST files/{fileId}/comments)
This command can change Google data or send data to the configured model.
drive api drive-comments-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-comments-delete
Deletes a comment. For more information, see Manage comments and replies. — destructive (DELETE files/{fileId}/comments/{commentId})
This command can change Google data or send data to the configured model.
drive api drive-comments-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--comment-id <value> | The ID of the comment. |
--file-id <value> | The ID of the file. |
drive api drive-comments-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. — read (GET files/{fileId}/comments/{commentId})
drive api drive-comments-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--include-deleted <value> | Whether to return deleted comments. Deleted comments will not include their original content. |
--comment-id <value> | The ID of the comment. |
drive api drive-comments-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. — read (GET files/{fileId}/comments)
drive api drive-comments-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--include-deleted <value> | Whether to include deleted comments. Deleted comments will not include their original content. |
--page-size <value> | The 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. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
--file-id <value> | The ID of the file. |
--start-modified-time <value> | The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). |
drive api drive-comments-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. — write (PATCH files/{fileId}/comments/{commentId})
This command can change Google data or send data to the configured model.
drive api drive-comments-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--comment-id <value> | The ID of the comment. |
--file-id <value> | The ID of the file. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-drives-create
Creates a shared drive. For more information, see Manage shared drives. — write (POST drives)
This command can change Google data or send data to the configured model.
drive api drive-drives-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--request-id <value> | 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. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-drives-delete
Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. For more information, see Manage shared drives. — destructive (DELETE drives/{driveId})
This command can change Google data or send data to the configured model.
drive api drive-drives-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--drive-id <value> | The ID of the shared drive. |
--use-domain-admin-access <value> | Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. |
--allow-item-deletion <value> | Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true. |
drive api drive-drives-get
Gets a shared drive's metadata by ID. For more information, see Manage shared drives. — read (GET drives/{driveId})
drive api drive-drives-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--drive-id <value> | The ID of the shared drive. |
--use-domain-admin-access <value> | Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. |
drive api drive-drives-hide
Hides a shared drive from the default view. For more information, see Manage shared drives. — write (POST drives/{driveId}/hide)
This command can change Google data or send data to the configured model.
drive api drive-drives-hide [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--drive-id <value> | The ID of the shared drive. |
drive api drive-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. — read (GET drives)
drive api drive-drives-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--q <value> | Query string for searching shared drives. |
--page-token <value> | Page token for shared drives. |
--page-size <value> | The 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. |
--use-domain-admin-access <value> | Issue 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. |
drive api drive-drives-unhide
Restores a shared drive to the default view. For more information, see Manage shared drives. — write (POST drives/{driveId}/unhide)
This command can change Google data or send data to the configured model.
drive api drive-drives-unhide [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--drive-id <value> | The ID of the shared drive. |
drive api drive-drives-update
Updates the metadata for a shared drive. For more information, see Manage shared drives. — write (PATCH drives/{driveId})
This command can change Google data or send data to the configured model.
drive api drive-drives-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--use-domain-admin-access <value> | Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. |
--drive-id <value> | The ID of the shared drive. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-files-copy
Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files. — write (POST files/{fileId}/copy)
This command can change Google data or send data to the configured model.
drive api drive-files-copy [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--ignore-default-visibility <value> | 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. |
--keep-revision-forever <value> | 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. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--copy-comments <value> | Whether to copy the open (unresolved) comments associated with the file. |
--enforce-single-parent <value> | Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. |
--ocr-language <value> | A language hint for OCR processing during image import (ISO 639-1 code). |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-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. For more information, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data. Apps creating shortcuts with the create method must specify the MIME type application/vnd.google-apps.shortcut. Apps should specify a file extension in the name property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "name": "cat.jpg" in the metadata. Subsequent GET requests include the read-only fileExtension property populated with the extension originally specified in the name property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. — write (POST files)
This command can change Google data or send data to the configured model.
drive api drive-files-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--enforce-single-parent <value> | Deprecated: Creating files in multiple folders is no longer supported. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--ignore-default-visibility <value> | 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. |
--ocr-language <value> | A language hint for OCR processing during image import (ISO 639-1 code). |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--use-content-as-indexable-text <value> | Whether to use the uploaded content as indexable text. |
--keep-revision-forever <value> | 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. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-files-delete
Permanently deletes a file owned by the user without moving it to the trash. For more information, see Trash or delete files and folders. If the file belongs to a shared drive, the user must be an organizer on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. — destructive (DELETE files/{fileId})
This command can change Google data or send data to the configured model.
drive api drive-files-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--file-id <value> | The ID of the file. |
--enforce-single-parent <value> | Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. |
drive api drive-files-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. — read (POST files/{fileId}/download)
drive api drive-files-download [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | Required. The ID of the file to download. |
--mime-type <value> | Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see Export MIME types for Google Workspace documents. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. |
--revision-id <value> | Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns INVALID_ARGUMENT if downloading a specific revision on the file is unsupported. |
drive api drive-files-empty-trash
Permanently deletes all of the user's trashed files. For more information, see Trash or delete files and folders. — destructive (DELETE files/trash)
This command can change Google data or send data to the configured model.
drive api drive-files-empty-trash [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--enforce-single-parent <value> | Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. |
--drive-id <value> | If set, empties the trash of the provided shared drive. |
drive api drive-files-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. — read (GET files/{fileId}/export)
drive api drive-files-export [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--mime-type <value> | Required. The MIME type of the format requested for this export. For a list of supported MIME types, see Export MIME types for Google Workspace documents. |
--file-id <value> | The ID of the file. |
drive api drive-files-generate-cse-token
Generates a CSE token which can be used to create or update CSE files. — read (GET files/generateCseToken)
drive api drive-files-generate-cse-token [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--parent <value> | The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request. |
--file-id <value> | The ID of the file for which the JWT should be generated. If not provided, an id will be generated. |
drive api drive-files-generate-ids
Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files. — read (GET files/generateIds)
drive api drive-files-generate-ids [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--space <value> | The space in which the IDs can be used to create files. Supported values are drive and appDataFolder. (Default: drive.) For more information, see File organization. |
--type <value> | The type of items which the IDs can be used for. Supported values are files and shortcuts. Note that shortcuts are only supported in the drive space. (Default: files.) For more information, see File organization. |
--count <value> | The number of IDs to return. |
drive api drive-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. To download Google Docs, Sheets, and Slides use files.export instead. For more information, see Download and export files. — read (GET files/{fileId})
drive api drive-files-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--acknowledge-abuse <value> | Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--file-id <value> | The ID of the file. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
drive api drive-files-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. — read (GET files)
drive api drive-files-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--corpus <value> | Deprecated: The source of files to list. Use corpora instead. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--corpora <value> | Specifies 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. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--page-size <value> | The 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. |
--spaces <value> | A comma-separated list of spaces to query within the corpora. Supported values are drive and appDataFolder. For more information, see File organization. |
--team-drive-id <value> | Deprecated: Use driveId instead. |
--order-by <value> | A 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. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response. |
--include-team-drive-items <value> | Deprecated: Use includeItemsFromAllDrives instead. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--include-items-from-all-drives <value> | Whether both My Drive and shared drive items should be included in results. |
--q <value> | A query for filtering the file results. For supported syntax, see Search for files and folders. |
--drive-id <value> | ID of the shared drive to search. |
drive api drive-files-list-labels
Lists the labels on a file. For more information, see List labels on a file. — read (GET files/{fileId}/listLabels)
drive api drive-files-list-labels [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--max-results <value> | The maximum number of labels to return per page. When not set, defaults to 100. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response. |
--file-id <value> | The ID for the file. |
drive api drive-files-modify-labels
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. — write (POST files/{fileId}/modifyLabels)
This command can change Google data or send data to the configured model.
drive api drive-files-modify-labels [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file to which the labels belong. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-files-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. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data. — write (PATCH files/{fileId})
This command can change Google data or send data to the configured model.
drive api drive-files-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--ocr-language <value> | A language hint for OCR processing during image import (ISO 639-1 code). |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--enforce-single-parent <value> | Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead. |
--add-parents <value> | A comma-separated list of parent IDs to add. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--keep-revision-forever <value> | 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. |
--file-id <value> | The ID of the file. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--remove-parents <value> | A comma-separated list of parent IDs to remove. |
--use-content-as-indexable-text <value> | Whether to use the uploaded content as indexable text. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-files-watch
Subscribes to changes to a file. For more information, see Notifications for resource changes. — write (POST files/{fileId}/watch)
This command can change Google data or send data to the configured model.
drive api drive-files-watch [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--include-labels <value> | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--acknowledge-abuse <value> | Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-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. — read (GET operations/{name})
drive api drive-operations-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--name <value> | The name of the operation resource. |
drive api drive-permissions-create
Creates a permission for a file or shared drive. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — write (POST files/{fileId}/permissions)
This command can change Google data or send data to the configured model.
drive api drive-permissions-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--enforce-expansive-access <value> | Deprecated: All requests use the expansive access rules. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--send-notification-email <value> | 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. |
--use-domain-admin-access <value> | 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. |
--transfer-ownership <value> | 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. |
--file-id <value> | The ID of the file or shared drive. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--email-message <value> | A plain text custom message to include in the notification email. |
--enforce-single-parent <value> | Deprecated: See moveToNewOwnersRoot for details. |
--move-to-new-owners-root <value> | 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. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-permissions-delete
Deletes a permission. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — destructive (DELETE files/{fileId}/permissions/{permissionId})
This command can change Google data or send data to the configured model.
drive api drive-permissions-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--use-domain-admin-access <value> | 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. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--permission-id <value> | The ID of the permission. |
--enforce-expansive-access <value> | Deprecated: All requests use the expansive access rules. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--file-id <value> | The ID of the file or shared drive. |
drive api drive-permissions-get
Gets a permission by ID. For more information, see Share files, folders, and drives. — read (GET files/{fileId}/permissions/{permissionId})
drive api drive-permissions-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--permission-id <value> | The ID of the permission. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--use-domain-admin-access <value> | 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. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--file-id <value> | The ID of the file. |
drive api drive-permissions-list
Lists a file's or shared drive's permissions. For more information, see Share files, folders, and drives. — read (GET files/{fileId}/permissions)
drive api drive-permissions-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--use-domain-admin-access <value> | 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. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response. |
--file-id <value> | The ID of the file or shared drive. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--page-size <value> | The 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. |
--include-permissions-for-view <value> | Specifies which additional view's permissions to include in the response. Only published is supported. |
drive api drive-permissions-update
Updates a permission with patch semantics. For more information, see Share files, folders, and drives. Warning: Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied. — write (PATCH files/{fileId}/permissions/{permissionId})
This command can change Google data or send data to the configured model.
drive api drive-permissions-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--use-domain-admin-access <value> | 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. |
--transfer-ownership <value> | 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. |
--enforce-expansive-access <value> | Deprecated: All requests use the expansive access rules. |
--supports-all-drives <value> | Whether the requesting application supports both My Drives and shared drives. |
--supports-team-drives <value> | Deprecated: Use supportsAllDrives instead. |
--file-id <value> | The ID of the file or shared drive. |
--remove-expiration <value> | Whether to remove the expiration date. |
--permission-id <value> | The ID of the permission. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-replies-create
Creates a reply to a comment. For more information, see Manage comments and replies. — write (POST files/{fileId}/comments/{commentId}/replies)
This command can change Google data or send data to the configured model.
drive api drive-replies-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--comment-id <value> | The ID of the comment. |
--file-id <value> | The ID of the file. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-replies-delete
Deletes a reply. For more information, see Manage comments and replies. — destructive (DELETE files/{fileId}/comments/{commentId}/replies/{replyId})
This command can change Google data or send data to the configured model.
drive api drive-replies-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--comment-id <value> | The ID of the comment. |
--reply-id <value> | The ID of the reply. |
--file-id <value> | The ID of the file. |
drive api drive-replies-get
Gets a reply by ID. For more information, see Manage comments and replies. — read (GET files/{fileId}/comments/{commentId}/replies/{replyId})
drive api drive-replies-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--include-deleted <value> | Whether to return deleted replies. Deleted replies don't include their original content. |
--file-id <value> | The ID of the file. |
--comment-id <value> | The ID of the comment. |
--reply-id <value> | The ID of the reply. |
drive api drive-replies-list
Lists a comment's replies. For more information, see Manage comments and replies. — read (GET files/{fileId}/comments/{commentId}/replies)
drive api drive-replies-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--page-size <value> | The 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. |
--file-id <value> | The ID of the file. |
--comment-id <value> | The ID of the comment. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from the previous response. |
--include-deleted <value> | Whether to include deleted replies. Deleted replies don't include their original content. |
drive api drive-replies-update
Updates a reply with patch semantics. For more information, see Manage comments and replies. — write (PATCH files/{fileId}/comments/{commentId}/replies/{replyId})
This command can change Google data or send data to the configured model.
drive api drive-replies-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--comment-id <value> | The ID of the comment. |
--file-id <value> | The ID of the file. |
--reply-id <value> | The ID of the reply. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-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. — destructive (DELETE files/{fileId}/revisions/{revisionId})
This command can change Google data or send data to the configured model.
drive api drive-revisions-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--revision-id <value> | The ID of the revision. |
drive api drive-revisions-get
Gets a revision's metadata or content by ID. For more information, see Manage file revisions. — read (GET files/{fileId}/revisions/{revisionId})
drive api drive-revisions-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--revision-id <value> | The ID of the revision. |
--file-id <value> | The ID of the file. |
--acknowledge-abuse <value> | Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides. |
drive api drive-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. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API. — read (GET files/{fileId}/revisions)
drive api drive-revisions-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--page-size <value> | The 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. |
--file-id <value> | The ID of the file. |
--page-token <value> | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
drive api drive-revisions-update
Updates a revision with patch semantics. For more information, see Manage file revisions. — write (PATCH files/{fileId}/revisions/{revisionId})
This command can change Google data or send data to the configured model.
drive api drive-revisions-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--file-id <value> | The ID of the file. |
--revision-id <value> | The ID of the revision. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-teamdrives-create
Deprecated: Use drives.create instead. — write (POST teamdrives)
This command can change Google data or send data to the configured model.
drive api drive-teamdrives-create [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--request-id <value> | 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. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api drive-teamdrives-delete
Deprecated: Use drives.delete instead. — destructive (DELETE teamdrives/{teamDriveId})
This command can change Google data or send data to the configured model.
drive api drive-teamdrives-delete [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--team-drive-id <value> | The ID of the Team Drive. |
drive api drive-teamdrives-get
Deprecated: Use drives.get instead. — read (GET teamdrives/{teamDriveId})
drive api drive-teamdrives-get [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--team-drive-id <value> | The ID of the Team Drive. |
--use-domain-admin-access <value> | Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. |
drive api drive-teamdrives-list
Deprecated: Use drives.list instead. — read (GET teamdrives)
drive api drive-teamdrives-list [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--q <value> | Query string for searching Team Drives. |
--page-size <value> | Maximum number of Team Drives to return. |
--use-domain-admin-access <value> | Issue 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. |
--page-token <value> | Page token for Team Drives. |
drive api drive-teamdrives-update
Deprecated: Use drives.update instead. — write (PATCH teamdrives/{teamDriveId})
This command can change Google data or send data to the configured model.
drive api drive-teamdrives-update [options]| Option | What it does |
|---|---|
--fields <value> | Selector specifying which fields to include in a partial response. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--$.xgafv <value> | V1 error format. |
--callback <value> | JSONP. |
--alt <value> | Data format for response. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--use-domain-admin-access <value> | Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. |
--team-drive-id <value> | The ID of the Team Drive. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive api driveactivity-activity-query
Query past activity in Google Drive. — read (POST v2/activity:query)
drive api driveactivity-activity-query [options]| Option | What it does |
|---|---|
--alt <value> | Data format for response. |
--callback <value> | JSONP. |
--$.xgafv <value> | V1 error format. |
--pretty-print <value> | Returns response with indentations and line breaks. |
--quota-user <value> | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
--fields <value> | Selector specifying which fields to include in a partial response. |
--body <json> | the request body as JSON; - reads it from stdin. |
--body-file <path> | the request body from a JSON file; - is stdin. |
drive files
Remote Google Drive files; results are not automatically imported
drive files list
drive files list [options]| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
--query <q> | Google Drive query syntax. Default: trashed = false. |
--parent <folder> | list immediate children of this folder. |
drive files get
drive files get <file>| Argument | Requirement | What it is |
|---|---|---|
file | required |
drive files copy
This command can change Google data or send data to the configured model.
drive files copy <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--name <name> | |
--parent <folder> |
drive files move
This command can change Google data or send data to the configured model.
drive files move <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--to <folder> | |
--from <folder> | remove this previous parent explicitly. |
drive files update
This command can change Google data or send data to the configured model.
drive files update <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--body <json> | Google File metadata patch. |
drive files trash
This command can change Google data or send data to the configured model.
drive files trash <file>| Argument | Requirement | What it is |
|---|---|---|
file | required |
drive files restore
This command can change Google data or send data to the configured model.
drive files restore <file>| Argument | Requirement | What it is |
|---|---|---|
file | required |
drive files mkdir
This command can change Google data or send data to the configured model.
drive files mkdir <name> [options]| Argument | Requirement | What it is |
|---|---|---|
name | required |
| Option | What it does |
|---|---|
--parent <folder> |
drive comments
Remote file comments; pagination tokens are returned
drive comments list
drive comments list <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
drive comments get
drive comments get <file> <id>| Argument | Requirement | What it is |
|---|---|---|
file | required | |
id | required |
drive permissions
Remote file permissions; pagination tokens are returned
drive permissions list
drive permissions list <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
drive permissions get
drive permissions get <file> <id>| Argument | Requirement | What it is |
|---|---|---|
file | required | |
id | required |
drive revisions
Remote file revisions; pagination tokens are returned
drive revisions list
drive revisions list <file> [options]| Argument | Requirement | What it is |
|---|---|---|
file | required |
| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
drive revisions get
drive revisions get <file> <id>| Argument | Requirement | What it is |
|---|---|---|
file | required | |
id | required |
drive shared-drives
List accessible Google Shared Drives
drive shared-drives [options]| Option | What it does |
|---|---|
--limit <n> | maximum items in this page. Default: 100. |
--page-token <token> | next page token returned by Google. |
drive config
Shared-style defaults/profile settings; credentials are separate
drive config show
drive config showdrive config set
This command changes local state.
drive config set <key> <json-value> [options]| Argument | Requirement | What it is |
|---|---|---|
key | required | |
json-value | required |
| Option | What it does |
|---|---|
--defaults | change defaults rather than the selected profile. |
drive complete
Shell completion from the shared command registry
drive complete [words]| Argument | Requirement | What it is |
|---|---|---|
words | optional |
drive schema
Generated request schema and operation contract without Google access
drive schema <method>| Argument | Requirement | What it is |
|---|---|---|
method | required |
drive models
Configure the shared model gateway; keys stay outside config
drive models configure
This command changes local state.
drive models configure [options]| Option | What it does |
|---|---|
--purpose <purpose> | shared model purpose. Default: memories. |
--provider <provider> | One of: openai, anthropic, off. |
--model <model> | model identifier for the selected provider. |
--base-url <url> | optional HTTP/S model endpoint without URL credentials. |
drive mcp
Expose guarded commands over MCP stdio
drive mcp [options]| Option | What it does |
|---|---|
--tools | list offered tools without starting a server. |
drive commands
Discover the command tree and options as shared registry data
drive commands [path]| Argument | Requirement | What it is |
|---|---|---|
path | optional |
Exit codes
Failures use the shared WireCat error contract.
| Code | When |
|---|---|
0 | it worked |
2 | validation_error |
3 | configuration_error |
4 | authentication_error |
5 | permission_error |
6 | not_found |
7 | confirmation_required |
8 | rate_limited |
9 | timeout |
10 | network_error |
11 | provider_error |
12 | provider_unavailable |
13 | invalid_response |
14 | outcome_unknown |
130 | cancelled |
1 | anything else |