mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
1719 lines
56 KiB
HTML
1719 lines
56 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Patch - drive v3.0.0+20220225</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> drive v3.0.0+20220225</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>About</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../about_get">Get</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Apps</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../apps_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../apps_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Changes</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../changes_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../changes_get-start-page-token">Get Start Page Token</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../changes_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../changes_watch">Watch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Channels</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../channels_stop">Stop</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Children</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../children_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../children_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../children_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../children_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Comments</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../comments_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Drives</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_hide">Hide</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_unhide">Unhide</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../drives_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Files</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_copy">Copy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_empty-trash">Empty Trash</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_export">Export</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_generate-ids">Generate Ids</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Patch</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_touch">Touch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_trash">Trash</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_untrash">Untrash</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_update">Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../files_watch">Watch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Parents</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../parents_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../parents_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../parents_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../parents_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Permissions</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_get-id-for-email">Get Id For Email</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../permissions_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Properties</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../properties_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Replies</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../replies_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Revisions</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../revisions_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../revisions_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../revisions_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../revisions_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../revisions_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Teamdrives</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../teamdrives_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../teamdrives_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../teamdrives_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../teamdrives_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../teamdrives_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive2-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/drive</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.appdata</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.apps.readonly</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.file</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.metadata</em></li>
|
|
<li><em>https://www.googleapis.com/auth/drive.scripts</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/drive</em>.
|
|
You can set the scope for this method like this: <code>drive2 --scope <scope> files patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><file-id></strong> <em>(string)</em><ul>
|
|
<li>The ID of the file to update.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>File:
|
|
alternate-link: string
|
|
app-data-contents: boolean
|
|
can-comment: boolean
|
|
can-read-revisions: boolean
|
|
capabilities:
|
|
can-accept-ownership: boolean
|
|
can-add-children: boolean
|
|
can-add-folder-from-another-drive: boolean
|
|
can-add-my-drive-parent: boolean
|
|
can-change-copy-requires-writer-permission: boolean
|
|
can-change-restricted-download: boolean
|
|
can-change-security-update-enabled: boolean
|
|
can-comment: boolean
|
|
can-copy: boolean
|
|
can-delete: boolean
|
|
can-delete-children: boolean
|
|
can-download: boolean
|
|
can-edit: boolean
|
|
can-list-children: boolean
|
|
can-modify-content: boolean
|
|
can-modify-content-restriction: boolean
|
|
can-move-children-out-of-drive: boolean
|
|
can-move-children-out-of-team-drive: boolean
|
|
can-move-children-within-drive: boolean
|
|
can-move-children-within-team-drive: boolean
|
|
can-move-item-into-team-drive: boolean
|
|
can-move-item-out-of-drive: boolean
|
|
can-move-item-out-of-team-drive: boolean
|
|
can-move-item-within-drive: boolean
|
|
can-move-item-within-team-drive: boolean
|
|
can-move-team-drive-item: boolean
|
|
can-read-drive: boolean
|
|
can-read-revisions: boolean
|
|
can-read-team-drive: boolean
|
|
can-remove-children: boolean
|
|
can-remove-my-drive-parent: boolean
|
|
can-rename: boolean
|
|
can-share: boolean
|
|
can-trash: boolean
|
|
can-trash-children: boolean
|
|
can-untrash: boolean
|
|
copy-requires-writer-permission: boolean
|
|
copyable: boolean
|
|
created-date: string
|
|
default-open-with-link: string
|
|
description: string
|
|
download-url: string
|
|
drive-id: string
|
|
editable: boolean
|
|
embed-link: string
|
|
etag: string
|
|
explicitly-trashed: boolean
|
|
export-links: { string: string }
|
|
file-extension: string
|
|
file-size: string
|
|
folder-color-rgb: string
|
|
full-file-extension: string
|
|
has-augmented-permissions: boolean
|
|
has-thumbnail: boolean
|
|
head-revision-id: string
|
|
icon-link: string
|
|
id: string
|
|
image-media-metadata:
|
|
aperture: number
|
|
camera-make: string
|
|
camera-model: string
|
|
color-space: string
|
|
date: string
|
|
exposure-bias: number
|
|
exposure-mode: string
|
|
exposure-time: number
|
|
flash-used: boolean
|
|
focal-length: number
|
|
height: integer
|
|
iso-speed: integer
|
|
lens: string
|
|
location:
|
|
altitude: number
|
|
latitude: number
|
|
longitude: number
|
|
max-aperture-value: number
|
|
metering-mode: string
|
|
rotation: integer
|
|
sensor: string
|
|
subject-distance: integer
|
|
white-balance: string
|
|
width: integer
|
|
indexable-text:
|
|
text: string
|
|
is-app-authorized: boolean
|
|
kind: string
|
|
labels:
|
|
hidden: boolean
|
|
modified: boolean
|
|
restricted: boolean
|
|
starred: boolean
|
|
trashed: boolean
|
|
viewed: boolean
|
|
last-modifying-user:
|
|
display-name: string
|
|
email-address: string
|
|
is-authenticated-user: boolean
|
|
kind: string
|
|
permission-id: string
|
|
picture:
|
|
url: string
|
|
last-modifying-user-name: string
|
|
last-viewed-by-me-date: string
|
|
link-share-metadata:
|
|
security-update-eligible: boolean
|
|
security-update-enabled: boolean
|
|
marked-viewed-by-me-date: string
|
|
md5-checksum: string
|
|
mime-type: string
|
|
modified-by-me-date: string
|
|
modified-date: string
|
|
open-with-links: { string: string }
|
|
original-filename: string
|
|
owned-by-me: boolean
|
|
owner-names: [string]
|
|
permission-ids: [string]
|
|
quota-bytes-used: string
|
|
resource-key: string
|
|
self-link: string
|
|
shareable: boolean
|
|
shared: boolean
|
|
shared-with-me-date: string
|
|
sharing-user:
|
|
display-name: string
|
|
email-address: string
|
|
is-authenticated-user: boolean
|
|
kind: string
|
|
permission-id: string
|
|
picture:
|
|
url: string
|
|
shortcut-details:
|
|
target-id: string
|
|
target-mime-type: string
|
|
target-resource-key: string
|
|
spaces: [string]
|
|
team-drive-id: string
|
|
thumbnail:
|
|
image: string
|
|
mime-type: string
|
|
thumbnail-link: string
|
|
thumbnail-version: string
|
|
title: string
|
|
trashed-date: string
|
|
trashing-user:
|
|
display-name: string
|
|
email-address: string
|
|
is-authenticated-user: boolean
|
|
kind: string
|
|
permission-id: string
|
|
picture:
|
|
url: string
|
|
user-permission:
|
|
additional-roles: [string]
|
|
auth-key: string
|
|
deleted: boolean
|
|
domain: string
|
|
email-address: string
|
|
etag: string
|
|
expiration-date: string
|
|
id: string
|
|
kind: string
|
|
name: string
|
|
pending-owner: boolean
|
|
photo-link: string
|
|
role: string
|
|
self-link: string
|
|
type: string
|
|
value: string
|
|
view: string
|
|
with-link: boolean
|
|
version: string
|
|
video-media-metadata:
|
|
duration-millis: string
|
|
height: integer
|
|
width: integer
|
|
web-content-link: string
|
|
web-view-link: string
|
|
writers-can-share: boolean
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . alternate-link=rebum.</code><ul>
|
|
<li>A link for opening the file in a relevant Google editor or viewer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>app-data-contents=true</code><ul>
|
|
<li>Whether this file is in the Application Data folder.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-comment=false</code><ul>
|
|
<li>Deprecated: use capabilities/canComment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-read-revisions=true</code><ul>
|
|
<li>Deprecated: use capabilities/canReadRevisions.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>capabilities can-accept-ownership=false</code><ul>
|
|
<li>Whether the current user is the pending owner of the file. Not populated for shared drive files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-add-children=true</code><ul>
|
|
<li>Whether the current user can add children to this folder. This is always false when the item is not a folder.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-add-folder-from-another-drive=true</code><ul>
|
|
<li>Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-add-my-drive-parent=true</code><ul>
|
|
<li>Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-change-copy-requires-writer-permission=false</code><ul>
|
|
<li>Whether the current user can change the copyRequiresWriterPermission restriction of this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-change-restricted-download=false</code><ul>
|
|
<li>Deprecated</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-change-security-update-enabled=false</code><ul>
|
|
<li>Whether the current user can change the securityUpdateEnabled field on link share metadata.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-comment=false</code><ul>
|
|
<li>Whether the current user can comment on this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-copy=false</code><ul>
|
|
<li>Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-delete=false</code><ul>
|
|
<li>Whether the current user can delete this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-delete-children=false</code><ul>
|
|
<li>Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-download=false</code><ul>
|
|
<li>Whether the current user can download this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-edit=false</code><ul>
|
|
<li>Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-list-children=false</code><ul>
|
|
<li>Whether the current user can list the children of this folder. This is always false when the item is not a folder.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-modify-content=false</code><ul>
|
|
<li>Whether the current user can modify the content of this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-modify-content-restriction=true</code><ul>
|
|
<li>Whether the current user can modify restrictions on content of this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-children-out-of-drive=false</code><ul>
|
|
<li>Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-children-out-of-team-drive=true</code><ul>
|
|
<li>Deprecated - use canMoveChildrenOutOfDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-children-within-drive=false</code><ul>
|
|
<li>Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-children-within-team-drive=true</code><ul>
|
|
<li>Deprecated - use canMoveChildrenWithinDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-item-into-team-drive=true</code><ul>
|
|
<li>Deprecated - use canMoveItemOutOfDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-item-out-of-drive=true</code><ul>
|
|
<li>Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-item-out-of-team-drive=true</code><ul>
|
|
<li>Deprecated - use canMoveItemOutOfDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-item-within-drive=true</code><ul>
|
|
<li>Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-item-within-team-drive=true</code><ul>
|
|
<li>Deprecated - use canMoveItemWithinDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-move-team-drive-item=false</code><ul>
|
|
<li>Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-read-drive=false</code><ul>
|
|
<li>Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-read-revisions=true</code><ul>
|
|
<li>Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-read-team-drive=false</code><ul>
|
|
<li>Deprecated - use canReadDrive instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-remove-children=true</code><ul>
|
|
<li>Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-remove-my-drive-parent=true</code><ul>
|
|
<li>Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-rename=true</code><ul>
|
|
<li>Whether the current user can rename this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-share=false</code><ul>
|
|
<li>Whether the current user can modify the sharing settings for this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-trash=true</code><ul>
|
|
<li>Whether the current user can move this file to trash.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>can-trash-children=false</code><ul>
|
|
<li>Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>can-untrash=false</code></p>
|
|
<ul>
|
|
<li>Whether the current user can restore this file from trash.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. copy-requires-writer-permission=false</code></p>
|
|
<ul>
|
|
<li>Whether the options to copy, print, or download this file, should be disabled for readers and commenters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>copyable=false</code><ul>
|
|
<li>Deprecated: use capabilities/canCopy.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>created-date=ipsum</code><ul>
|
|
<li>Create time for this file (formatted RFC 3339 timestamp).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>default-open-with-link=ea</code><ul>
|
|
<li>A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=ipsum</code><ul>
|
|
<li>A short description of the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>download-url=eos</code><ul>
|
|
<li>Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>drive-id=vero</code><ul>
|
|
<li>ID of the shared drive the file resides in. Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>editable=true</code><ul>
|
|
<li>Deprecated: use capabilities/canEdit.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>embed-link=dolores</code><ul>
|
|
<li>A link for embedding the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>etag=elitr</code><ul>
|
|
<li>ETag of the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>explicitly-trashed=false</code><ul>
|
|
<li>Whether this file has been explicitly trashed, as opposed to recursively trashed.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>export-links=key=sed</code><ul>
|
|
<li>Links for exporting Docs Editors files to specific formats.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-extension=lorem</code><ul>
|
|
<li>The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-size=magna</code><ul>
|
|
<li>The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>folder-color-rgb=duo</code><ul>
|
|
<li>Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>full-file-extension=et</code><ul>
|
|
<li>The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>has-augmented-permissions=true</code><ul>
|
|
<li>Whether there are permissions directly on this file. This field is only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>has-thumbnail=true</code><ul>
|
|
<li>Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>head-revision-id=sit</code><ul>
|
|
<li>The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>icon-link=duo</code><ul>
|
|
<li>A link to the file's icon.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=stet</code><ul>
|
|
<li>The ID of the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>image-media-metadata aperture=0.5681716890822454</code><ul>
|
|
<li>The aperture used to create the photo (f-number).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>camera-make=dolore</code><ul>
|
|
<li>The make of the camera used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>camera-model=eirmod</code><ul>
|
|
<li>The model of the camera used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>color-space=lorem</code><ul>
|
|
<li>The color space of the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>date=ut</code><ul>
|
|
<li>The date and time the photo was taken (EXIF format timestamp).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>exposure-bias=0.3498730588658667</code><ul>
|
|
<li>The exposure bias of the photo (APEX value).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>exposure-mode=sit</code><ul>
|
|
<li>The exposure mode used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>exposure-time=0.013416310990004843</code><ul>
|
|
<li>The length of the exposure, in seconds.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>flash-used=false</code><ul>
|
|
<li>Whether a flash was used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>focal-length=0.5056955785906947</code><ul>
|
|
<li>The focal length used to create the photo, in millimeters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height=33</code><ul>
|
|
<li>The height of the image in pixels.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>iso-speed=74</code><ul>
|
|
<li>The ISO speed used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>lens=sed</code><ul>
|
|
<li>The lens used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>location altitude=0.28232044606958073</code><ul>
|
|
<li>The altitude stored in the image.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>latitude=0.4384702234299269</code><ul>
|
|
<li>The latitude stored in the image.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>longitude=0.5213406658219825</code></p>
|
|
<ul>
|
|
<li>The longitude stored in the image.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. max-aperture-value=0.026465139860502473</code></p>
|
|
<ul>
|
|
<li>The smallest f-number of the lens at the focal length used to create the photo (APEX value).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>metering-mode=rebum.</code><ul>
|
|
<li>The metering mode used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>rotation=93</code><ul>
|
|
<li>The number of clockwise 90 degree rotations applied from the image's original orientation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sensor=no</code><ul>
|
|
<li>The type of sensor used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subject-distance=86</code><ul>
|
|
<li>The distance to the subject of the photo, in meters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>white-balance=diam</code><ul>
|
|
<li>The white balance mode used to create the photo.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>width=51</code></p>
|
|
<ul>
|
|
<li>The width of the image in pixels.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..indexable-text text=eos</code></p>
|
|
<ul>
|
|
<li>The text to be indexed for this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. is-app-authorized=false</code></p>
|
|
<ul>
|
|
<li>Whether the file was created or opened by the requesting app.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=justo</code><ul>
|
|
<li>The type of file. This is always drive#file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels hidden=true</code><ul>
|
|
<li>Deprecated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>modified=false</code><ul>
|
|
<li>Whether the file has been modified by this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>restricted=true</code><ul>
|
|
<li>Deprecated - use copyRequiresWriterPermission instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>starred=true</code><ul>
|
|
<li>Whether this file is starred by the user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>trashed=true</code><ul>
|
|
<li>Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>viewed=false</code></p>
|
|
<ul>
|
|
<li>Whether this file has been viewed by this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..last-modifying-user display-name=nonumy</code></p>
|
|
<ul>
|
|
<li>A plain text displayable name for this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-address=magna</code><ul>
|
|
<li>The email address of the user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-authenticated-user=true</code><ul>
|
|
<li>Whether this user is the same as the authenticated user for whom the request was made.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=lorem</code><ul>
|
|
<li>This is always drive#user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>permission-id=aliquyam</code><ul>
|
|
<li>The user's ID as visible in the permissions collection.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>picture url=diam</code></p>
|
|
<ul>
|
|
<li>A URL that points to a profile picture of this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... last-modifying-user-name=vero</code></p>
|
|
<ul>
|
|
<li>Name of the last user to modify this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-viewed-by-me-date=erat</code><ul>
|
|
<li>Last time this file was viewed by the user (formatted RFC 3339 timestamp).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>link-share-metadata security-update-eligible=true</code><ul>
|
|
<li>Whether the file is eligible for security update.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>security-update-enabled=true</code></p>
|
|
<ul>
|
|
<li>Whether the security update is enabled for this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. marked-viewed-by-me-date=amet</code></p>
|
|
<ul>
|
|
<li>Deprecated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>md5-checksum=magna</code><ul>
|
|
<li>An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mime-type=sanctus</code><ul>
|
|
<li>The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>modified-by-me-date=clita</code><ul>
|
|
<li>Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>modified-date=invidunt</code><ul>
|
|
<li>Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>open-with-links=key=accusam</code><ul>
|
|
<li>A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>original-filename=amet.</code><ul>
|
|
<li>The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>owned-by-me=true</code><ul>
|
|
<li>Whether the file is owned by the current user. Not populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>owner-names=invidunt</code><ul>
|
|
<li>Name(s) of the owner(s) of this file. Not populated for items in shared drives.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>permission-ids=sit</code><ul>
|
|
<li>List of permission IDs for users with access to this file.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>quota-bytes-used=sed</code><ul>
|
|
<li>The number of quota bytes used by this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>resource-key=duo</code><ul>
|
|
<li>A key needed to access the item via a shared link.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=et</code><ul>
|
|
<li>A link back to this file.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>shareable=true</code><ul>
|
|
<li>Deprecated: use capabilities/canShare.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>shared=true</code><ul>
|
|
<li>Whether the file has been shared. Not populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>shared-with-me-date=sed</code><ul>
|
|
<li>Time at which this file was shared with the user (formatted RFC 3339 timestamp).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sharing-user display-name=justo</code><ul>
|
|
<li>A plain text displayable name for this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-address=sadipscing</code><ul>
|
|
<li>The email address of the user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-authenticated-user=false</code><ul>
|
|
<li>Whether this user is the same as the authenticated user for whom the request was made.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=takimata</code><ul>
|
|
<li>This is always drive#user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>permission-id=invidunt</code><ul>
|
|
<li>The user's ID as visible in the permissions collection.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>picture url=invidunt</code></p>
|
|
<ul>
|
|
<li>A URL that points to a profile picture of this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...shortcut-details target-id=gubergren</code></p>
|
|
<ul>
|
|
<li>The ID of the file that this shortcut points to.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>target-mime-type=sed</code><ul>
|
|
<li>The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>target-resource-key=justo</code></p>
|
|
<ul>
|
|
<li>The ResourceKey for the target file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. spaces=amet</code></p>
|
|
<ul>
|
|
<li>The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>team-drive-id=sed</code><ul>
|
|
<li>Deprecated - use driveId instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>thumbnail image=ut</code><ul>
|
|
<li>The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>mime-type=et</code></p>
|
|
<ul>
|
|
<li>The MIME type of the thumbnail.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. thumbnail-link=kasd</code></p>
|
|
<ul>
|
|
<li>A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>thumbnail-version=gubergren</code><ul>
|
|
<li>The thumbnail version for use in thumbnail cache invalidation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>title=et</code><ul>
|
|
<li>The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>trashed-date=at</code><ul>
|
|
<li>The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>trashing-user display-name=ut</code><ul>
|
|
<li>A plain text displayable name for this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-address=consetetur</code><ul>
|
|
<li>The email address of the user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-authenticated-user=true</code><ul>
|
|
<li>Whether this user is the same as the authenticated user for whom the request was made.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=clita</code><ul>
|
|
<li>This is always drive#user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>permission-id=tempor</code><ul>
|
|
<li>The user's ID as visible in the permissions collection.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>picture url=amet</code></p>
|
|
<ul>
|
|
<li>A URL that points to a profile picture of this user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...user-permission additional-roles=dolor</code></p>
|
|
<ul>
|
|
<li>Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>auth-key=dolore</code><ul>
|
|
<li>Deprecated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>deleted=false</code><ul>
|
|
<li>Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>domain=diam</code><ul>
|
|
<li>The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-address=sanctus</code><ul>
|
|
<li>The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>etag=ipsum</code><ul>
|
|
<li>The ETag of the permission.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>expiration-date=lorem</code><ul>
|
|
<li>The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: <ul>
|
|
<li>They cannot be set on shared drive items </li>
|
|
<li>They can only be set on user and group permissions </li>
|
|
<li>The date must be in the future </li>
|
|
<li>The date cannot be more than a year in the future </li>
|
|
<li>The date can only be set on drive.permissions.update or drive.permissions.patch requests</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=sed</code><ul>
|
|
<li>The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=tempor</code><ul>
|
|
<li>This is always drive#permission.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=et</code><ul>
|
|
<li>The name for this permission.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pending-owner=false</code><ul>
|
|
<li>Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>photo-link=vero</code><ul>
|
|
<li>A link to the profile photo, if available.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>role=sed</code><ul>
|
|
<li>The primary role for this user. While new values may be supported in the future, the following are currently allowed: <ul>
|
|
<li>owner </li>
|
|
<li>organizer </li>
|
|
<li>fileOrganizer </li>
|
|
<li>writer </li>
|
|
<li>reader</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=et</code><ul>
|
|
<li>A link back to this permission.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=sea</code><ul>
|
|
<li>The account type. Allowed values are: <ul>
|
|
<li>user </li>
|
|
<li>group </li>
|
|
<li>domain </li>
|
|
<li>anyone</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>value=ut</code><ul>
|
|
<li>The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>view=et</code><ul>
|
|
<li>Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>with-link=true</code></p>
|
|
<ul>
|
|
<li>Whether the link is required for this permission.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. version=magna</code></p>
|
|
<ul>
|
|
<li>A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>video-media-metadata duration-millis=magna</code><ul>
|
|
<li>The duration of the video in milliseconds.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height=34</code><ul>
|
|
<li>The height of the video in pixels.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>width=40</code></p>
|
|
<ul>
|
|
<li>The width of the video in pixels.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. web-content-link=aliquyam</code></p>
|
|
<ul>
|
|
<li>A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>web-view-link=sed</code><ul>
|
|
<li>A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>writers-can-share=true</code><ul>
|
|
<li>Whether writers can share the document with other users. Not populated for items in shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p add-parents=string</strong></p>
|
|
<ul>
|
|
<li>Comma-separated list of parent IDs to add.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p convert=boolean</strong></p>
|
|
<ul>
|
|
<li>This parameter is deprecated and has no function.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p enforce-single-parent=boolean</strong></p>
|
|
<ul>
|
|
<li>Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p include-permissions-for-view=string</strong></p>
|
|
<ul>
|
|
<li>Specifies which additional view's permissions to include in the response. Only 'published' is supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p modified-date-behavior=string</strong></p>
|
|
<ul>
|
|
<li>Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p new-revision=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p ocr=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p ocr-language=string</strong></p>
|
|
<ul>
|
|
<li>If ocr is true, hints at the language to use. Valid values are BCP 47 codes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pinned=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p remove-parents=string</strong></p>
|
|
<ul>
|
|
<li>Comma-separated list of parent IDs to remove.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p set-modified-date=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p supports-all-drives=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether the requesting application supports both My Drives and shared drives.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p supports-team-drives=boolean</strong></p>
|
|
<ul>
|
|
<li>Deprecated use supportsAllDrives instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p timed-text-language=string</strong></p>
|
|
<ul>
|
|
<li>The language of the timed text.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p timed-text-track-name=string</strong></p>
|
|
<ul>
|
|
<li>The timed text track name.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p update-viewed-date=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether to update the view date after successfully updating the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p use-content-as-indexable-text=boolean</strong></p>
|
|
<ul>
|
|
<li>Whether to use the content as indexable text.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for the response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-ip=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated. Please use quotaUser instead.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../files_touch" class="btn btn-neutral float-right" title="Touch"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../files_list" class="btn btn-neutral" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../files_list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../files_touch" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |