Blame - docs/dyn/drive_v2.files.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame^]

79

<p class="firstline">Creates a copy of the specified file. Folders cannot be copied.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#delete">delete(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

83

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

84

<code><a href="#emptyTrash">emptyTrash()</a></code></p>

85

<p class="firstline">Permanently deletes all of the user's trashed files.</p>

86

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

87

<code><a href="#export">export(fileId, mimeType)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

90

<code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#generateIds">generateIds(maxResults=None, space=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

<p class="firstline">Generates a set of file IDs which can be provided in insert or copy requests.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

95

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

96

<code><a href="#get">get(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

97

<p class="firstline">Gets a file's metadata by ID.</p>

98

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

99

<code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

100

<p class="firstline">Gets a file's metadata by ID.</p>

101

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

102

<code><a href="#insert">insert(body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, media_body=None, media_mime_type=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

103

<p class="firstline">Insert a new file.</p>

104

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

<code><a href="#list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

106

<p class="firstline">Lists the user's files.</p>

107

108

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

109

<p class="firstline">Retrieves the next page of results.</p>

110

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

111

<code><a href="#patch">patch(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

112

<p class="firstline">Updates file metadata and/or content. This method supports patch semantics.</p>

113

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

<code><a href="#touch">touch(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

115

<p class="firstline">Set the file's updated time to the current server time.</p>

116

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

<code><a href="#trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

118

<p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. 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.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

<code><a href="#untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

121

<p class="firstline">Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

122

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

<code><a href="#update">update(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

124

<p class="firstline">Updates file metadata and/or content.</p>

125

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

<code><a href="#watch">watch(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

127

<p class="firstline">Subscribe to changes on a file</p>

128

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

<code><a href="#watch_media">watch_media(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

130

<p class="firstline">Subscribe to changes on a file</p>

131

<h3>Method Details</h3>

132

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

133

<code class="details" id="copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

134

<pre>Creates a copy of the specified file. Folders cannot be copied.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

135

136

Args:

137

fileId: string, The ID of the file to copy. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

138

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

139

The object takes the form of:

140

141

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

143

"appDataContents": True or False, # Whether this file is in the Application Data folder.

144

"canComment": True or False, # Deprecated: use capabilities/canComment.

145

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

146

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

147

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

148

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

149

"canAddMyDriveParent": True or False, # 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.

150

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

151

"canChangeRestrictedDownload": True or False, # Deprecated

152

"canComment": True or False, # Whether the current user can comment on this file.

153

"canCopy": True or False, # 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.

154

"canDelete": True or False, # Whether the current user can delete this file.

155

"canDeleteChildren": True or False, # 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.

156

"canDownload": True or False, # Whether the current user can download this file.

157

"canEdit": True or False, # 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.

158

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

159

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

160

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

"canMoveChildrenOutOfDrive": True or False, # 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.

162

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

163

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

164

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

165

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

166

"canMoveItemOutOfDrive": True or False, # 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.

167

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

168

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

169

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

170

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

171

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

172

"canReadRevisions": True or False, # 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.

173

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

174

"canRemoveChildren": True or False, # 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.

175

"canRemoveMyDriveParent": True or False, # 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.

176

"canRename": True or False, # Whether the current user can rename this file.

177

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

178

"canTrash": True or False, # Whether the current user can move this file to trash.

179

"canTrashChildren": True or False, # 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.

180

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

181

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

182

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

183

{ # A restriction for accessing the content of the file.

184

"readOnly": True or False, # Whether the content of the file is read-only.

185

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

186

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

187

"displayName": "A String", # A plain text displayable name for this user.

188

"emailAddress": "A String", # The email address of the user.

189

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

190

"kind": "drive#user", # This is always drive#user.

191

"permissionId": "A String", # The user's ID as visible in the permissions collection.

192

"picture": { # The user's profile picture.

193

"url": "A String", # A URL that points to a profile picture of this user.

194

},

195

},

196

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

197

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

198

},

199

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

201

"copyable": True or False, # Deprecated: use capabilities/canCopy.

202

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

203

"defaultOpenWithLink": "A String", # 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.

204

"description": "A String", # A short description of the file.

205

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

206

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

207

"editable": True or False, # Deprecated: use capabilities/canEdit.

208

"embedLink": "A String", # A link for embedding the file.

209

"etag": "A String", # ETag of the file.

210

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

211

"exportLinks": { # Links for exporting Google Docs to specific formats.

212

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

213

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

214

"fileExtension": "A String", # 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 Google Docs or shortcut files.

215

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

216

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

217

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

218

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

219

"hasThumbnail": True or False, # 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.

220

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

221

"iconLink": "A String", # A link to the file's icon.

222

"id": "A String", # The ID of the file.

223

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

224

"aperture": 3.14, # The aperture used to create the photo (f-number).

225

"cameraMake": "A String", # The make of the camera used to create the photo.

226

"cameraModel": "A String", # The model of the camera used to create the photo.

227

"colorSpace": "A String", # The color space of the photo.

228

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

229

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

230

"exposureMode": "A String", # The exposure mode used to create the photo.

231

"exposureTime": 3.14, # The length of the exposure, in seconds.

232

"flashUsed": True or False, # Whether a flash was used to create the photo.

233

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

234

"height": 42, # The height of the image in pixels.

235

"isoSpeed": 42, # The ISO speed used to create the photo.

236

"lens": "A String", # The lens used to create the photo.

237

"location": { # Geographic location information stored in the image.

238

"altitude": 3.14, # The altitude stored in the image.

239

"latitude": 3.14, # The latitude stored in the image.

240

"longitude": 3.14, # The longitude stored in the image.

241

},

242

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

243

"meteringMode": "A String", # The metering mode used to create the photo.

244

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

245

"sensor": "A String", # The type of sensor used to create the photo.

246

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

247

"whiteBalance": "A String", # The white balance mode used to create the photo.

248

"width": 42, # The width of the image in pixels.

249

},

250

"indexableText": { # Indexable text attributes for the file (can only be written)

251

"text": "A String", # The text to be indexed for this file.

252

},

253

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

254

"kind": "drive#file", # The type of file. This is always drive#file.

255

"labels": { # A group of labels for the file.

256

"hidden": True or False, # Deprecated.

257

"modified": True or False, # Whether the file has been modified by this user.

258

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

259

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

260

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

261

"viewed": True or False, # Whether this file has been viewed by this user.

262

},

263

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

264

"displayName": "A String", # A plain text displayable name for this user.

265

"emailAddress": "A String", # The email address of the user.

266

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

267

"kind": "drive#user", # This is always drive#user.

268

"permissionId": "A String", # The user's ID as visible in the permissions collection.

269

"picture": { # The user's profile picture.

270

"url": "A String", # A URL that points to a profile picture of this user.

271

},

272

},

273

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

274

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

275

"markedViewedByMeDate": "A String", # Deprecated.

276

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

277

"mimeType": "A String", # 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.

278

"modifiedByMeDate": "A String", # 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.

279

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

280

"openWithLinks": { # 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.

281

"a_key": "A String",

282

},

283

"originalFilename": "A String", # 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.

284

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

285

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

286

"A String",

287

],

288

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

289

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

"displayName": "A String", # A plain text displayable name for this user.

291

"emailAddress": "A String", # The email address of the user.

292

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

293

"kind": "drive#user", # This is always drive#user.

294

"permissionId": "A String", # The user's ID as visible in the permissions collection.

295

"picture": { # The user's profile picture.

296

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

297

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

298

},

299

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

"parents": [ # Collection of parent folders which contain this file.

301

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

302

{ # A reference to a file's parent.

303

"id": "A String", # The ID of the parent.

304

"isRoot": True or False, # Whether or not the parent is the root folder.

305

"kind": "drive#parentReference", # This is always drive#parentReference.

306

"parentLink": "A String", # A link to the parent.

307

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

308

},

309

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

310

"permissionIds": [ # List of permission IDs for users with access to this file.

311

"A String",

312

],

313

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

314

{ # A permission for a file.

315

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

316

"A String",

317

],

318

"authKey": "A String", # Deprecated.

319

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

320

"domain": "A String", # 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.

321

"emailAddress": "A String", # 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.

322

"etag": "A String", # The ETag of the permission.

323

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

324

# - They cannot be set on shared drive items

325

# - They can only be set on user and group permissions

326

# - The date must be in the future

327

# - The date cannot be more than a year in the future

328

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

329

"id": "A String", # 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.

330

"kind": "drive#permission", # This is always drive#permission.

331

"name": "A String", # The name for this permission.

332

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

333

{

334

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

335

"A String",

336

],

337

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

338

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

339

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

340

# - file

341

# - member

342

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

350

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

357

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

358

{

359

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

360

"A String",

361

],

362

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

363

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

364

"role": "A String", # Deprecated - use permissionDetails/role instead.

365

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

366

},

367

],

368

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

374

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

375

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

376

],

377

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

378

{ # A key-value pair attached to a file that is either public or private to an application.

379

# The following limits apply to file properties:

380

# - Maximum of 100 properties total per file

381

# - Maximum of 30 private properties per app

382

# - Maximum of 30 public properties

383

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

384

"etag": "A String", # ETag of the property.

385

"key": "A String", # The key of this property.

386

"kind": "drive#property", # This is always drive#property.

387

"selfLink": "A String", # The link back to this property.

388

"value": "A String", # The value of this property.

389

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

390

},

391

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

392

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

393

"selfLink": "A String", # A link back to this file.

394

"shareable": True or False, # Deprecated: use capabilities/canShare.

395

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

396

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

397

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

398

"displayName": "A String", # A plain text displayable name for this user.

399

"emailAddress": "A String", # The email address of the user.

400

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

401

"kind": "drive#user", # This is always drive#user.

402

"permissionId": "A String", # The user's ID as visible in the permissions collection.

403

"picture": { # The user's profile picture.

404

"url": "A String", # A URL that points to a profile picture of this user.

405

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

406

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

407

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

408

"targetId": "A String", # The ID of the file that this shortcut points to.

409

"targetMimeType": "A String", # 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.

410

},

411

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

412

"A String",

413

],

414

"teamDriveId": "A String", # Deprecated - use driveId instead.

415

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

416

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

417

"mimeType": "A String", # The MIME type of the thumbnail.

418

},

419

"thumbnailLink": "A String", # 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.

420

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

421

"title": "A String", # 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.

422

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

423

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

424

"displayName": "A String", # A plain text displayable name for this user.

425

"emailAddress": "A String", # The email address of the user.

426

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

427

"kind": "drive#user", # This is always drive#user.

428

"permissionId": "A String", # The user's ID as visible in the permissions collection.

429

"picture": { # The user's profile picture.

430

"url": "A String", # A URL that points to a profile picture of this user.

431

},

432

},

433

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

434

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

435

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

436

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

437

"authKey": "A String", # Deprecated.

438

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

439

"domain": "A String", # 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.

440

"emailAddress": "A String", # 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.

441

"etag": "A String", # The ETag of the permission.

442

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

443

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

444

# - They can only be set on user and group permissions

445

# - The date must be in the future

446

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

447

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

448

"id": "A String", # 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.

449

"kind": "drive#permission", # This is always drive#permission.

450

"name": "A String", # The name for this permission.

451

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

452

{

453

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

454

"A String",

455

],

456

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

457

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

458

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

459

# - file

460

# - member

461

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

469

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

470

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

471

# - organizer

472

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

473

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

474

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

"selfLink": "A String", # A link back to this permission.

476

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

477

{

478

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

479

"A String",

480

],

481

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

482

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

483

"role": "A String", # Deprecated - use permissionDetails/role instead.

484

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

485

},

486

],

487

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

492

"value": "A String", # 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.

493

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

494

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

495

"version": "A String", # 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.

496

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

497

"durationMillis": "A String", # The duration of the video in milliseconds.

498

"height": 42, # The height of the video in pixels.

499

"width": 42, # The width of the video in pixels.

500

},

501

"webContentLink": "A String", # 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.

502

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

503

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

504

}

505

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

506

convert: boolean, Whether to convert this file to the corresponding Google Docs format.

507

enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

508

ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

509

ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

510

pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

511

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

512

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

513

timedTextLanguage: string, The language of the timed text.

514

timedTextTrackName: string, The timed text track name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

515

visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.

516

Allowed values

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

517

DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

518

PRIVATE - The new file will be visible to only the owner.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

519

520

Returns:

521

An object of the form:

522

523

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

524

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

525

"appDataContents": True or False, # Whether this file is in the Application Data folder.

526

"canComment": True or False, # Deprecated: use capabilities/canComment.

527

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

528

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

529

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

530

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

531

"canAddMyDriveParent": True or False, # 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.

532

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

533

"canChangeRestrictedDownload": True or False, # Deprecated

534

"canComment": True or False, # Whether the current user can comment on this file.

535

"canCopy": True or False, # 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.

536

"canDelete": True or False, # Whether the current user can delete this file.

537

"canDeleteChildren": True or False, # 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.

538

"canDownload": True or False, # Whether the current user can download this file.

539

"canEdit": True or False, # 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.

540

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

541

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

542

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

543

"canMoveChildrenOutOfDrive": True or False, # 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.

544

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

545

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

546

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

547

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

548

"canMoveItemOutOfDrive": True or False, # 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.

549

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

550

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

551

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

552

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

553

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

554

"canReadRevisions": True or False, # 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.

555

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

556

"canRemoveChildren": True or False, # 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.

557

"canRemoveMyDriveParent": True or False, # 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.

558

"canRename": True or False, # Whether the current user can rename this file.

559

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

560

"canTrash": True or False, # Whether the current user can move this file to trash.

561

"canTrashChildren": True or False, # 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.

562

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

563

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

564

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

565

{ # A restriction for accessing the content of the file.

566

"readOnly": True or False, # Whether the content of the file is read-only.

567

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

568

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

569

"displayName": "A String", # A plain text displayable name for this user.

570

"emailAddress": "A String", # The email address of the user.

571

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

572

"kind": "drive#user", # This is always drive#user.

573

"permissionId": "A String", # The user's ID as visible in the permissions collection.

574

"picture": { # The user's profile picture.

575

"url": "A String", # A URL that points to a profile picture of this user.

576

},

577

},

578

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

579

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

580

},

581

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

582

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

583

"copyable": True or False, # Deprecated: use capabilities/canCopy.

584

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

585

"defaultOpenWithLink": "A String", # 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.

586

"description": "A String", # A short description of the file.

587

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

588

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

589

"editable": True or False, # Deprecated: use capabilities/canEdit.

590

"embedLink": "A String", # A link for embedding the file.

591

"etag": "A String", # ETag of the file.

592

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

593

"exportLinks": { # Links for exporting Google Docs to specific formats.

594

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

595

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

596

"fileExtension": "A String", # 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 Google Docs or shortcut files.

597

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

598

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

599

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

600

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

601

"hasThumbnail": True or False, # 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.

602

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

603

"iconLink": "A String", # A link to the file's icon.

604

"id": "A String", # The ID of the file.

605

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

606

"aperture": 3.14, # The aperture used to create the photo (f-number).

607

"cameraMake": "A String", # The make of the camera used to create the photo.

608

"cameraModel": "A String", # The model of the camera used to create the photo.

609

"colorSpace": "A String", # The color space of the photo.

610

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

611

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

612

"exposureMode": "A String", # The exposure mode used to create the photo.

613

"exposureTime": 3.14, # The length of the exposure, in seconds.

614

"flashUsed": True or False, # Whether a flash was used to create the photo.

615

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

616

"height": 42, # The height of the image in pixels.

617

"isoSpeed": 42, # The ISO speed used to create the photo.

618

"lens": "A String", # The lens used to create the photo.

619

"location": { # Geographic location information stored in the image.

620

"altitude": 3.14, # The altitude stored in the image.

621

"latitude": 3.14, # The latitude stored in the image.

622

"longitude": 3.14, # The longitude stored in the image.

623

},

624

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

625

"meteringMode": "A String", # The metering mode used to create the photo.

626

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

627

"sensor": "A String", # The type of sensor used to create the photo.

628

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

629

"whiteBalance": "A String", # The white balance mode used to create the photo.

630

"width": 42, # The width of the image in pixels.

631

},

632

"indexableText": { # Indexable text attributes for the file (can only be written)

633

"text": "A String", # The text to be indexed for this file.

634

},

635

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

636

"kind": "drive#file", # The type of file. This is always drive#file.

637

"labels": { # A group of labels for the file.

638

"hidden": True or False, # Deprecated.

639

"modified": True or False, # Whether the file has been modified by this user.

640

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

641

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

642

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

643

"viewed": True or False, # Whether this file has been viewed by this user.

644

},

645

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

646

"displayName": "A String", # A plain text displayable name for this user.

647

"emailAddress": "A String", # The email address of the user.

648

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

649

"kind": "drive#user", # This is always drive#user.

650

"permissionId": "A String", # The user's ID as visible in the permissions collection.

651

"picture": { # The user's profile picture.

652

"url": "A String", # A URL that points to a profile picture of this user.

653

},

654

},

655

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

656

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

657

"markedViewedByMeDate": "A String", # Deprecated.

658

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

659

"mimeType": "A String", # 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.

660

"modifiedByMeDate": "A String", # 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.

661

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

662

"openWithLinks": { # 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.

663

"a_key": "A String",

664

},

665

"originalFilename": "A String", # 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.

666

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

667

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

668

"A String",

669

],

670

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

671

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

672

"displayName": "A String", # A plain text displayable name for this user.

673

"emailAddress": "A String", # The email address of the user.

674

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

675

"kind": "drive#user", # This is always drive#user.

676

"permissionId": "A String", # The user's ID as visible in the permissions collection.

677

"picture": { # The user's profile picture.

678

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

679

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

680

},

681

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

682

"parents": [ # Collection of parent folders which contain this file.

683

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

684

{ # A reference to a file's parent.

685

"id": "A String", # The ID of the parent.

686

"isRoot": True or False, # Whether or not the parent is the root folder.

687

"kind": "drive#parentReference", # This is always drive#parentReference.

688

"parentLink": "A String", # A link to the parent.

689

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

690

},

691

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

692

"permissionIds": [ # List of permission IDs for users with access to this file.

693

"A String",

694

],

695

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

696

{ # A permission for a file.

697

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

698

"A String",

699

],

700

"authKey": "A String", # Deprecated.

701

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

702

"domain": "A String", # 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.

703

"emailAddress": "A String", # 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.

704

"etag": "A String", # The ETag of the permission.

705

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

706

# - They cannot be set on shared drive items

707

# - They can only be set on user and group permissions

708

# - The date must be in the future

709

# - The date cannot be more than a year in the future

710

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

711

"id": "A String", # 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.

712

"kind": "drive#permission", # This is always drive#permission.

713

"name": "A String", # The name for this permission.

714

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

715

{

716

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

717

"A String",

718

],

719

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

720

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

721

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

722

# - file

723

# - member

724

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

732

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

739

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

740

{

741

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

742

"A String",

743

],

744

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

745

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

746

"role": "A String", # Deprecated - use permissionDetails/role instead.

747

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

748

},

749

],

750

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

756

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

757

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

758

],

759

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

760

{ # A key-value pair attached to a file that is either public or private to an application.

761

# The following limits apply to file properties:

762

# - Maximum of 100 properties total per file

763

# - Maximum of 30 private properties per app

764

# - Maximum of 30 public properties

765

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

766

"etag": "A String", # ETag of the property.

767

"key": "A String", # The key of this property.

768

"kind": "drive#property", # This is always drive#property.

769

"selfLink": "A String", # The link back to this property.

770

"value": "A String", # The value of this property.

771

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

772

},

773

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

774

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

775

"selfLink": "A String", # A link back to this file.

776

"shareable": True or False, # Deprecated: use capabilities/canShare.

777

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

778

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

779

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

780

"displayName": "A String", # A plain text displayable name for this user.

781

"emailAddress": "A String", # The email address of the user.

782

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

783

"kind": "drive#user", # This is always drive#user.

784

"permissionId": "A String", # The user's ID as visible in the permissions collection.

785

"picture": { # The user's profile picture.

786

"url": "A String", # A URL that points to a profile picture of this user.

787

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

788

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

789

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

790

"targetId": "A String", # The ID of the file that this shortcut points to.

791

"targetMimeType": "A String", # 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.

792

},

793

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

794

"A String",

795

],

796

"teamDriveId": "A String", # Deprecated - use driveId instead.

797

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

798

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

799

"mimeType": "A String", # The MIME type of the thumbnail.

800

},

801

"thumbnailLink": "A String", # 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.

802

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

803

"title": "A String", # 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.

804

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

805

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

806

"displayName": "A String", # A plain text displayable name for this user.

807

"emailAddress": "A String", # The email address of the user.

808

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

809

"kind": "drive#user", # This is always drive#user.

810

"permissionId": "A String", # The user's ID as visible in the permissions collection.

811

"picture": { # The user's profile picture.

812

"url": "A String", # A URL that points to a profile picture of this user.

813

},

814

},

815

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

816

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

817

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

818

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

819

"authKey": "A String", # Deprecated.

820

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

821

"domain": "A String", # 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.

822

"emailAddress": "A String", # 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.

823

"etag": "A String", # The ETag of the permission.

824

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

825

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

826

# - They can only be set on user and group permissions

827

# - The date must be in the future

828

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

829

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

830

"id": "A String", # 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.

831

"kind": "drive#permission", # This is always drive#permission.

832

"name": "A String", # The name for this permission.

833

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

834

{

835

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

836

"A String",

837

],

838

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

839

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

840

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

841

# - file

842

# - member

843

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

851

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

852

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

853

# - organizer

854

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

855

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

856

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

857

"selfLink": "A String", # A link back to this permission.

858

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

859

{

860

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

861

"A String",

862

],

863

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

864

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

865

"role": "A String", # Deprecated - use permissionDetails/role instead.

866

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

867

},

868

],

869

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

874

"value": "A String", # 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.

875

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

876

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

877

"version": "A String", # 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.

878

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

879

"durationMillis": "A String", # The duration of the video in milliseconds.

880

"height": 42, # The height of the video in pixels.

881

"width": 42, # The width of the video in pixels.

882

},

883

"webContentLink": "A String", # 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.

884

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

885

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

890

<code class="details" id="delete">delete(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

891

<pre>Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

892

893

Args:

894

fileId: string, The ID of the file to delete. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

895

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

896

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</pre>

</div>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

901

<code class="details" id="emptyTrash">emptyTrash()</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

902

<pre>Permanently deletes all of the user's trashed files.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

Args:

</pre>

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

909

<code class="details" id="export">export(fileId, mimeType)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

910

<pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

911

912

Args:

913

fileId: string, The ID of the file. (required)

914

mimeType: string, The MIME type of the format requested for this export. (required)

</pre>

</div>

<code class="details" id="export_media">export_media(fileId, mimeType)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

920

<pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

921

922

Args:

923

fileId: string, The ID of the file. (required)

924

mimeType: string, The MIME type of the format requested for this export. (required)

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

929

<code class="details" id="generateIds">generateIds(maxResults=None, space=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

930

<pre>Generates a set of file IDs which can be provided in insert or copy requests.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

931

932

Args:

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

933

maxResults: integer, Maximum number of IDs to return.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

934

space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

935

936

Returns:

937

An object of the form:

938

939

{ # A list of generated IDs which can be provided in insert requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

940

"ids": [ # The IDs generated for the requesting user in the specified space.

941

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

942

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

943

"kind": "drive#generatedIds", # This is always drive#generatedIds

944

"space": "A String", # The type of file that can be created with these IDs.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

949

<code class="details" id="get">get(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>

950

<pre>Gets a file's metadata by ID.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

951

952

Args:

953

fileId: string, The ID for the file in question. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

954

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

955

projection: string, This parameter is deprecated and has no function.

956

Allowed values

957

BASIC - Deprecated

958

FULL - Deprecated

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

959

revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

960

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

961

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

962

updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

963

964

Returns:

965

An object of the form:

966

967

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

968

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

969

"appDataContents": True or False, # Whether this file is in the Application Data folder.

970

"canComment": True or False, # Deprecated: use capabilities/canComment.

971

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

972

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

973

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

974

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

975

"canAddMyDriveParent": True or False, # 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.

976

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

977

"canChangeRestrictedDownload": True or False, # Deprecated

978

"canComment": True or False, # Whether the current user can comment on this file.

979

"canCopy": True or False, # 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.

980

"canDelete": True or False, # Whether the current user can delete this file.

981

"canDeleteChildren": True or False, # 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.

982

"canDownload": True or False, # Whether the current user can download this file.

983

"canEdit": True or False, # 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.

984

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

985

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

986

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

987

"canMoveChildrenOutOfDrive": True or False, # 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.

988

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

989

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

990

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

991

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

992

"canMoveItemOutOfDrive": True or False, # 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.

993

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

994

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

995

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

996

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

997

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

998

"canReadRevisions": True or False, # 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.

999

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

1000

"canRemoveChildren": True or False, # 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.

1001

"canRemoveMyDriveParent": True or False, # 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.

1002

"canRename": True or False, # Whether the current user can rename this file.

1003

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

1004

"canTrash": True or False, # Whether the current user can move this file to trash.

1005

"canTrashChildren": True or False, # 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.

1006

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1007

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1008

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

1009

{ # A restriction for accessing the content of the file.

1010

"readOnly": True or False, # Whether the content of the file is read-only.

1011

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

1012

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

1013

"displayName": "A String", # A plain text displayable name for this user.

1014

"emailAddress": "A String", # The email address of the user.

1015

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1016

"kind": "drive#user", # This is always drive#user.

1017

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1018

"picture": { # The user's profile picture.

1019

"url": "A String", # A URL that points to a profile picture of this user.

1020

},

1021

},

1022

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

1023

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

1024

},

1025

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1026

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

1027

"copyable": True or False, # Deprecated: use capabilities/canCopy.

1028

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

1029

"defaultOpenWithLink": "A String", # 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.

1030

"description": "A String", # A short description of the file.

1031

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

1032

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

1033

"editable": True or False, # Deprecated: use capabilities/canEdit.

1034

"embedLink": "A String", # A link for embedding the file.

1035

"etag": "A String", # ETag of the file.

1036

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

1037

"exportLinks": { # Links for exporting Google Docs to specific formats.

1038

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1039

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1040

"fileExtension": "A String", # 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 Google Docs or shortcut files.

1041

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

1042

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

1043

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

1044

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

1045

"hasThumbnail": True or False, # 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.

1046

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

1047

"iconLink": "A String", # A link to the file's icon.

1048

"id": "A String", # The ID of the file.

1049

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

1050

"aperture": 3.14, # The aperture used to create the photo (f-number).

1051

"cameraMake": "A String", # The make of the camera used to create the photo.

1052

"cameraModel": "A String", # The model of the camera used to create the photo.

1053

"colorSpace": "A String", # The color space of the photo.

1054

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

1055

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

1056

"exposureMode": "A String", # The exposure mode used to create the photo.

1057

"exposureTime": 3.14, # The length of the exposure, in seconds.

1058

"flashUsed": True or False, # Whether a flash was used to create the photo.

1059

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

1060

"height": 42, # The height of the image in pixels.

1061

"isoSpeed": 42, # The ISO speed used to create the photo.

1062

"lens": "A String", # The lens used to create the photo.

1063

"location": { # Geographic location information stored in the image.

1064

"altitude": 3.14, # The altitude stored in the image.

1065

"latitude": 3.14, # The latitude stored in the image.

1066

"longitude": 3.14, # The longitude stored in the image.

1067

},

1068

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

1069

"meteringMode": "A String", # The metering mode used to create the photo.

1070

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

1071

"sensor": "A String", # The type of sensor used to create the photo.

1072

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

1073

"whiteBalance": "A String", # The white balance mode used to create the photo.

1074

"width": 42, # The width of the image in pixels.

1075

},

1076

"indexableText": { # Indexable text attributes for the file (can only be written)

1077

"text": "A String", # The text to be indexed for this file.

1078

},

1079

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

1080

"kind": "drive#file", # The type of file. This is always drive#file.

1081

"labels": { # A group of labels for the file.

1082

"hidden": True or False, # Deprecated.

1083

"modified": True or False, # Whether the file has been modified by this user.

1084

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

1085

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1086

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1087

"viewed": True or False, # Whether this file has been viewed by this user.

1088

},

1089

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

1090

"displayName": "A String", # A plain text displayable name for this user.

1091

"emailAddress": "A String", # The email address of the user.

1092

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1093

"kind": "drive#user", # This is always drive#user.

1094

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1095

"picture": { # The user's profile picture.

1096

"url": "A String", # A URL that points to a profile picture of this user.

1097

},

1098

},

1099

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

1100

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

1101

"markedViewedByMeDate": "A String", # Deprecated.

1102

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

1103

"mimeType": "A String", # 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.

1104

"modifiedByMeDate": "A String", # 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.

1105

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

1106

"openWithLinks": { # 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.

1107

"a_key": "A String",

1108

},

1109

"originalFilename": "A String", # 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.

1110

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

1111

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

1112

"A String",

1113

],

1114

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1115

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1116

"displayName": "A String", # A plain text displayable name for this user.

1117

"emailAddress": "A String", # The email address of the user.

1118

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1119

"kind": "drive#user", # This is always drive#user.

1120

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1121

"picture": { # The user's profile picture.

1122

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1123

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1124

},

1125

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1126

"parents": [ # Collection of parent folders which contain this file.

1127

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

1128

{ # A reference to a file's parent.

1129

"id": "A String", # The ID of the parent.

1130

"isRoot": True or False, # Whether or not the parent is the root folder.

1131

"kind": "drive#parentReference", # This is always drive#parentReference.

1132

"parentLink": "A String", # A link to the parent.

1133

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1134

},

1135

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1136

"permissionIds": [ # List of permission IDs for users with access to this file.

1137

"A String",

1138

],

1139

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

1140

{ # A permission for a file.

1141

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

1142

"A String",

1143

],

1144

"authKey": "A String", # Deprecated.

1145

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1146

"domain": "A String", # 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.

1147

"emailAddress": "A String", # 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.

1148

"etag": "A String", # The ETag of the permission.

1149

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

1150

# - They cannot be set on shared drive items

1151

# - They can only be set on user and group permissions

1152

# - The date must be in the future

1153

# - The date cannot be more than a year in the future

1154

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

1155

"id": "A String", # 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.

1156

"kind": "drive#permission", # This is always drive#permission.

1157

"name": "A String", # The name for this permission.

1158

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

1159

{

1160

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

1161

"A String",

1162

],

1163

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1164

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1165

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1166

# - file

1167

# - member

1168

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

1176

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

1183

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1184

{

1185

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

1186

"A String",

1187

],

1188

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1189

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1190

"role": "A String", # Deprecated - use permissionDetails/role instead.

1191

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1192

},

1193

],

1194

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

1200

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1201

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1202

],

1203

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1204

{ # A key-value pair attached to a file that is either public or private to an application.

1205

# The following limits apply to file properties:

1206

# - Maximum of 100 properties total per file

1207

# - Maximum of 30 private properties per app

1208

# - Maximum of 30 public properties

1209

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

"etag": "A String", # ETag of the property.

1211

"key": "A String", # The key of this property.

1212

"kind": "drive#property", # This is always drive#property.

1213

"selfLink": "A String", # The link back to this property.

1214

"value": "A String", # The value of this property.

1215

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1216

},

1217

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1218

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

1219

"selfLink": "A String", # A link back to this file.

1220

"shareable": True or False, # Deprecated: use capabilities/canShare.

1221

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

1222

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

1223

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

1224

"displayName": "A String", # A plain text displayable name for this user.

1225

"emailAddress": "A String", # The email address of the user.

1226

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1227

"kind": "drive#user", # This is always drive#user.

1228

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1229

"picture": { # The user's profile picture.

1230

"url": "A String", # A URL that points to a profile picture of this user.

1231

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1232

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1233

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

1234

"targetId": "A String", # The ID of the file that this shortcut points to.

1235

"targetMimeType": "A String", # 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.

1236

},

1237

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

1238

"A String",

1239

],

1240

"teamDriveId": "A String", # Deprecated - use driveId instead.

1241

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

1242

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

1243

"mimeType": "A String", # The MIME type of the thumbnail.

1244

},

1245

"thumbnailLink": "A String", # 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.

1246

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

1247

"title": "A String", # 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.

1248

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

1249

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

1250

"displayName": "A String", # A plain text displayable name for this user.

1251

"emailAddress": "A String", # The email address of the user.

1252

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1253

"kind": "drive#user", # This is always drive#user.

1254

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1255

"picture": { # The user's profile picture.

1256

"url": "A String", # A URL that points to a profile picture of this user.

1257

},

1258

},

1259

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

1260

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

1261

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1262

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1263

"authKey": "A String", # Deprecated.

1264

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1265

"domain": "A String", # 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.

1266

"emailAddress": "A String", # 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.

1267

"etag": "A String", # The ETag of the permission.

1268

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1269

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1270

# - They can only be set on user and group permissions

1271

# - The date must be in the future

1272

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1273

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

"id": "A String", # 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.

1275

"kind": "drive#permission", # This is always drive#permission.

1276

"name": "A String", # The name for this permission.

1277

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

1278

{

1279

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

1280

"A String",

1281

],

1282

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1283

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1284

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1285

# - file

1286

# - member

1287

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

1295

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1296

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1297

# - organizer

1298

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1299

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1300

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"selfLink": "A String", # A link back to this permission.

1302

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1303

{

1304

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

1305

"A String",

1306

],

1307

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1308

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1309

"role": "A String", # Deprecated - use permissionDetails/role instead.

1310

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1311

},

1312

],

1313

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

"value": "A String", # 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.

1319

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1320

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1321

"version": "A String", # 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.

1322

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

1323

"durationMillis": "A String", # The duration of the video in milliseconds.

1324

"height": 42, # The height of the video in pixels.

1325

"width": 42, # The width of the video in pixels.

1326

},

1327

"webContentLink": "A String", # 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.

1328

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

1329

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1334

<code class="details" id="get_media">get_media(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>

1335

<pre>Gets a file's metadata by ID.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1336

1337

Args:

1338

fileId: string, The ID for the file in question. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1339

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1340

projection: string, This parameter is deprecated and has no function.

1341

Allowed values

1342

BASIC - Deprecated

1343

FULL - Deprecated

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1344

revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1345

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1346

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1347

updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

1348

1349

Returns:

1350

The media object as a string.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

<code class="details" id="insert">insert(body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, media_body=None, media_mime_type=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1357

<pre>Insert a new file.

1358

1359

Args:

1360

body: object, The request body.

1361

The object takes the form of:

1362

1363

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1364

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

1365

"appDataContents": True or False, # Whether this file is in the Application Data folder.

1366

"canComment": True or False, # Deprecated: use capabilities/canComment.

1367

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

1368

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

1369

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1370

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1371

"canAddMyDriveParent": True or False, # 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.

1372

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

1373

"canChangeRestrictedDownload": True or False, # Deprecated

1374

"canComment": True or False, # Whether the current user can comment on this file.

1375

"canCopy": True or False, # 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.

1376

"canDelete": True or False, # Whether the current user can delete this file.

1377

"canDeleteChildren": True or False, # 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.

1378

"canDownload": True or False, # Whether the current user can download this file.

1379

"canEdit": True or False, # 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.

1380

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

1381

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1382

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1383

"canMoveChildrenOutOfDrive": True or False, # 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.

1384

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

1385

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

1386

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

1387

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1388

"canMoveItemOutOfDrive": True or False, # 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.

1389

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1390

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

1391

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

1392

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

1393

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

1394

"canReadRevisions": True or False, # 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.

1395

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

1396

"canRemoveChildren": True or False, # 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.

1397

"canRemoveMyDriveParent": True or False, # 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.

1398

"canRename": True or False, # Whether the current user can rename this file.

1399

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

1400

"canTrash": True or False, # Whether the current user can move this file to trash.

1401

"canTrashChildren": True or False, # 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.

1402

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1403

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1404

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

1405

{ # A restriction for accessing the content of the file.

1406

"readOnly": True or False, # Whether the content of the file is read-only.

1407

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

1408

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

1409

"displayName": "A String", # A plain text displayable name for this user.

1410

"emailAddress": "A String", # The email address of the user.

1411

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1412

"kind": "drive#user", # This is always drive#user.

1413

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1414

"picture": { # The user's profile picture.

1415

"url": "A String", # A URL that points to a profile picture of this user.

1416

},

1417

},

1418

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

1419

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

1420

},

1421

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1422

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

1423

"copyable": True or False, # Deprecated: use capabilities/canCopy.

1424

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

1425

"defaultOpenWithLink": "A String", # 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.

1426

"description": "A String", # A short description of the file.

1427

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

1428

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

1429

"editable": True or False, # Deprecated: use capabilities/canEdit.

1430

"embedLink": "A String", # A link for embedding the file.

1431

"etag": "A String", # ETag of the file.

1432

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

1433

"exportLinks": { # Links for exporting Google Docs to specific formats.

1434

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1435

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1436

"fileExtension": "A String", # 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 Google Docs or shortcut files.

1437

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

1438

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

1439

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

1440

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

1441

"hasThumbnail": True or False, # 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.

1442

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

1443

"iconLink": "A String", # A link to the file's icon.

1444

"id": "A String", # The ID of the file.

1445

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

1446

"aperture": 3.14, # The aperture used to create the photo (f-number).

1447

"cameraMake": "A String", # The make of the camera used to create the photo.

1448

"cameraModel": "A String", # The model of the camera used to create the photo.

1449

"colorSpace": "A String", # The color space of the photo.

1450

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

1451

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

1452

"exposureMode": "A String", # The exposure mode used to create the photo.

1453

"exposureTime": 3.14, # The length of the exposure, in seconds.

1454

"flashUsed": True or False, # Whether a flash was used to create the photo.

1455

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

1456

"height": 42, # The height of the image in pixels.

1457

"isoSpeed": 42, # The ISO speed used to create the photo.

1458

"lens": "A String", # The lens used to create the photo.

1459

"location": { # Geographic location information stored in the image.

1460

"altitude": 3.14, # The altitude stored in the image.

1461

"latitude": 3.14, # The latitude stored in the image.

1462

"longitude": 3.14, # The longitude stored in the image.

1463

},

1464

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

1465

"meteringMode": "A String", # The metering mode used to create the photo.

1466

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

1467

"sensor": "A String", # The type of sensor used to create the photo.

1468

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

1469

"whiteBalance": "A String", # The white balance mode used to create the photo.

1470

"width": 42, # The width of the image in pixels.

1471

},

1472

"indexableText": { # Indexable text attributes for the file (can only be written)

1473

"text": "A String", # The text to be indexed for this file.

1474

},

1475

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

1476

"kind": "drive#file", # The type of file. This is always drive#file.

1477

"labels": { # A group of labels for the file.

1478

"hidden": True or False, # Deprecated.

1479

"modified": True or False, # Whether the file has been modified by this user.

1480

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

1481

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1482

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1483

"viewed": True or False, # Whether this file has been viewed by this user.

1484

},

1485

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

1486

"displayName": "A String", # A plain text displayable name for this user.

1487

"emailAddress": "A String", # The email address of the user.

1488

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1489

"kind": "drive#user", # This is always drive#user.

1490

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1491

"picture": { # The user's profile picture.

1492

"url": "A String", # A URL that points to a profile picture of this user.

1493

},

1494

},

1495

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

1496

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

1497

"markedViewedByMeDate": "A String", # Deprecated.

1498

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

1499

"mimeType": "A String", # 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.

1500

"modifiedByMeDate": "A String", # 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.

1501

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

1502

"openWithLinks": { # 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.

1503

"a_key": "A String",

1504

},

1505

"originalFilename": "A String", # 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.

1506

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

1507

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

1508

"A String",

1509

],

1510

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1511

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"displayName": "A String", # A plain text displayable name for this user.

1513

"emailAddress": "A String", # The email address of the user.

1514

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1515

"kind": "drive#user", # This is always drive#user.

1516

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1517

"picture": { # The user's profile picture.

1518

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1519

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1520

},

1521

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1522

"parents": [ # Collection of parent folders which contain this file.

1523

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

1524

{ # A reference to a file's parent.

1525

"id": "A String", # The ID of the parent.

1526

"isRoot": True or False, # Whether or not the parent is the root folder.

1527

"kind": "drive#parentReference", # This is always drive#parentReference.

1528

"parentLink": "A String", # A link to the parent.

1529

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1530

},

1531

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1532

"permissionIds": [ # List of permission IDs for users with access to this file.

1533

"A String",

1534

],

1535

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

1536

{ # A permission for a file.

1537

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

1538

"A String",

1539

],

1540

"authKey": "A String", # Deprecated.

1541

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1542

"domain": "A String", # 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.

1543

"emailAddress": "A String", # 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.

1544

"etag": "A String", # The ETag of the permission.

1545

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

1546

# - They cannot be set on shared drive items

1547

# - They can only be set on user and group permissions

1548

# - The date must be in the future

1549

# - The date cannot be more than a year in the future

1550

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

1551

"id": "A String", # 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.

1552

"kind": "drive#permission", # This is always drive#permission.

1553

"name": "A String", # The name for this permission.

1554

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

1555

{

1556

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

1557

"A String",

1558

],

1559

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1560

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1561

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1562

# - file

1563

# - member

1564

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

1572

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

1579

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1580

{

1581

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

1582

"A String",

1583

],

1584

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1585

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1586

"role": "A String", # Deprecated - use permissionDetails/role instead.

1587

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1588

},

1589

],

1590

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

1596

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1597

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1598

],

1599

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1600

{ # A key-value pair attached to a file that is either public or private to an application.

1601

# The following limits apply to file properties:

1602

# - Maximum of 100 properties total per file

1603

# - Maximum of 30 private properties per app

1604

# - Maximum of 30 public properties

1605

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1606

"etag": "A String", # ETag of the property.

1607

"key": "A String", # The key of this property.

1608

"kind": "drive#property", # This is always drive#property.

1609

"selfLink": "A String", # The link back to this property.

1610

"value": "A String", # The value of this property.

1611

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1612

},

1613

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1614

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

1615

"selfLink": "A String", # A link back to this file.

1616

"shareable": True or False, # Deprecated: use capabilities/canShare.

1617

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

1618

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

1619

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

1620

"displayName": "A String", # A plain text displayable name for this user.

1621

"emailAddress": "A String", # The email address of the user.

1622

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1623

"kind": "drive#user", # This is always drive#user.

1624

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1625

"picture": { # The user's profile picture.

1626

"url": "A String", # A URL that points to a profile picture of this user.

1627

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1628

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

1630

"targetId": "A String", # The ID of the file that this shortcut points to.

1631

"targetMimeType": "A String", # 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.

1632

},

1633

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

1634

"A String",

1635

],

1636

"teamDriveId": "A String", # Deprecated - use driveId instead.

1637

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

1638

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

1639

"mimeType": "A String", # The MIME type of the thumbnail.

1640

},

1641

"thumbnailLink": "A String", # 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.

1642

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

1643

"title": "A String", # 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.

1644

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

1645

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

1646

"displayName": "A String", # A plain text displayable name for this user.

1647

"emailAddress": "A String", # The email address of the user.

1648

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1649

"kind": "drive#user", # This is always drive#user.

1650

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1651

"picture": { # The user's profile picture.

1652

"url": "A String", # A URL that points to a profile picture of this user.

1653

},

1654

},

1655

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

1656

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

1657

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1658

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1659

"authKey": "A String", # Deprecated.

1660

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1661

"domain": "A String", # 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.

1662

"emailAddress": "A String", # 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.

1663

"etag": "A String", # The ETag of the permission.

1664

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1665

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1666

# - They can only be set on user and group permissions

1667

# - The date must be in the future

1668

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1669

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1670

"id": "A String", # 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.

1671

"kind": "drive#permission", # This is always drive#permission.

1672

"name": "A String", # The name for this permission.

1673

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

1674

{

1675

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

1676

"A String",

1677

],

1678

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1679

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1680

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1681

# - file

1682

# - member

1683

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

1691

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1692

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1693

# - organizer

1694

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1695

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1696

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1697

"selfLink": "A String", # A link back to this permission.

1698

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1699

{

1700

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

1701

"A String",

1702

],

1703

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1704

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1705

"role": "A String", # Deprecated - use permissionDetails/role instead.

1706

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1707

},

1708

],

1709

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1714

"value": "A String", # 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.

1715

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1716

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1717

"version": "A String", # 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.

1718

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

1719

"durationMillis": "A String", # The duration of the video in milliseconds.

1720

"height": 42, # The height of the video in pixels.

1721

"width": 42, # The width of the video in pixels.

1722

},

1723

"webContentLink": "A String", # 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.

1724

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

1725

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1726

}

1727

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1728

convert: boolean, Whether to convert this file to the corresponding Google Docs format.

1729

enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1730

ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1731

ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1732

pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1733

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1734

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

1735

timedTextLanguage: string, The language of the timed text.

1736

timedTextTrackName: string, The timed text track name.

1737

useContentAsIndexableText: boolean, Whether to use the content as indexable text.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1738

visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.

1739

Allowed values

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1740

DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1741

PRIVATE - The new file will be visible to only the owner.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1742

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1743

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1744

1745

Returns:

1746

An object of the form:

1747

1748

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

1750

"appDataContents": True or False, # Whether this file is in the Application Data folder.

1751

"canComment": True or False, # Deprecated: use capabilities/canComment.

1752

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

1753

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

1754

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1755

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1756

"canAddMyDriveParent": True or False, # 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.

1757

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

1758

"canChangeRestrictedDownload": True or False, # Deprecated

1759

"canComment": True or False, # Whether the current user can comment on this file.

1760

"canCopy": True or False, # 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.

1761

"canDelete": True or False, # Whether the current user can delete this file.

1762

"canDeleteChildren": True or False, # 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.

1763

"canDownload": True or False, # Whether the current user can download this file.

1764

"canEdit": True or False, # 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.

1765

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

1766

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1767

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

"canMoveChildrenOutOfDrive": True or False, # 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.

1769

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

1770

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

1771

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

1772

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1773

"canMoveItemOutOfDrive": True or False, # 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.

1774

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1775

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

1776

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

1777

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

1778

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

1779

"canReadRevisions": True or False, # 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.

1780

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

1781

"canRemoveChildren": True or False, # 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.

1782

"canRemoveMyDriveParent": True or False, # 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.

1783

"canRename": True or False, # Whether the current user can rename this file.

1784

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

1785

"canTrash": True or False, # Whether the current user can move this file to trash.

1786

"canTrashChildren": True or False, # 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.

1787

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1788

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1789

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

1790

{ # A restriction for accessing the content of the file.

1791

"readOnly": True or False, # Whether the content of the file is read-only.

1792

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

1793

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

1794

"displayName": "A String", # A plain text displayable name for this user.

1795

"emailAddress": "A String", # The email address of the user.

1796

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1797

"kind": "drive#user", # This is always drive#user.

1798

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1799

"picture": { # The user's profile picture.

1800

"url": "A String", # A URL that points to a profile picture of this user.

1801

},

1802

},

1803

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

1804

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

1805

},

1806

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1807

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

1808

"copyable": True or False, # Deprecated: use capabilities/canCopy.

1809

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

1810

"defaultOpenWithLink": "A String", # 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.

1811

"description": "A String", # A short description of the file.

1812

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

1813

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

1814

"editable": True or False, # Deprecated: use capabilities/canEdit.

1815

"embedLink": "A String", # A link for embedding the file.

1816

"etag": "A String", # ETag of the file.

1817

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

1818

"exportLinks": { # Links for exporting Google Docs to specific formats.

1819

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1820

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1821

"fileExtension": "A String", # 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 Google Docs or shortcut files.

1822

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

1823

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

1824

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

1825

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

1826

"hasThumbnail": True or False, # 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.

1827

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

1828

"iconLink": "A String", # A link to the file's icon.

1829

"id": "A String", # The ID of the file.

1830

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

1831

"aperture": 3.14, # The aperture used to create the photo (f-number).

1832

"cameraMake": "A String", # The make of the camera used to create the photo.

1833

"cameraModel": "A String", # The model of the camera used to create the photo.

1834

"colorSpace": "A String", # The color space of the photo.

1835

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

1836

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

1837

"exposureMode": "A String", # The exposure mode used to create the photo.

1838

"exposureTime": 3.14, # The length of the exposure, in seconds.

1839

"flashUsed": True or False, # Whether a flash was used to create the photo.

1840

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

1841

"height": 42, # The height of the image in pixels.

1842

"isoSpeed": 42, # The ISO speed used to create the photo.

1843

"lens": "A String", # The lens used to create the photo.

1844

"location": { # Geographic location information stored in the image.

1845

"altitude": 3.14, # The altitude stored in the image.

1846

"latitude": 3.14, # The latitude stored in the image.

1847

"longitude": 3.14, # The longitude stored in the image.

1848

},

1849

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

1850

"meteringMode": "A String", # The metering mode used to create the photo.

1851

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

1852

"sensor": "A String", # The type of sensor used to create the photo.

1853

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

1854

"whiteBalance": "A String", # The white balance mode used to create the photo.

1855

"width": 42, # The width of the image in pixels.

1856

},

1857

"indexableText": { # Indexable text attributes for the file (can only be written)

1858

"text": "A String", # The text to be indexed for this file.

1859

},

1860

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

1861

"kind": "drive#file", # The type of file. This is always drive#file.

1862

"labels": { # A group of labels for the file.

1863

"hidden": True or False, # Deprecated.

1864

"modified": True or False, # Whether the file has been modified by this user.

1865

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

1866

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1867

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1868

"viewed": True or False, # Whether this file has been viewed by this user.

1869

},

1870

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

1871

"displayName": "A String", # A plain text displayable name for this user.

1872

"emailAddress": "A String", # The email address of the user.

1873

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1874

"kind": "drive#user", # This is always drive#user.

1875

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1876

"picture": { # The user's profile picture.

1877

"url": "A String", # A URL that points to a profile picture of this user.

1878

},

1879

},

1880

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

1881

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

1882

"markedViewedByMeDate": "A String", # Deprecated.

1883

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

1884

"mimeType": "A String", # 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.

1885

"modifiedByMeDate": "A String", # 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.

1886

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

1887

"openWithLinks": { # 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.

1888

"a_key": "A String",

1889

},

1890

"originalFilename": "A String", # 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.

1891

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

1892

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

1893

"A String",

1894

],

1895

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1896

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1897

"displayName": "A String", # A plain text displayable name for this user.

1898

"emailAddress": "A String", # The email address of the user.

1899

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

1900

"kind": "drive#user", # This is always drive#user.

1901

"permissionId": "A String", # The user's ID as visible in the permissions collection.

1902

"picture": { # The user's profile picture.

1903

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1904

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1905

},

1906

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1907

"parents": [ # Collection of parent folders which contain this file.

1908

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

1909

{ # A reference to a file's parent.

1910

"id": "A String", # The ID of the parent.

1911

"isRoot": True or False, # Whether or not the parent is the root folder.

1912

"kind": "drive#parentReference", # This is always drive#parentReference.

1913

"parentLink": "A String", # A link to the parent.

1914

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1915

},

1916

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1917

"permissionIds": [ # List of permission IDs for users with access to this file.

1918

"A String",

1919

],

1920

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

1921

{ # A permission for a file.

1922

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

1923

"A String",

1924

],

1925

"authKey": "A String", # Deprecated.

1926

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1927

"domain": "A String", # 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.

1928

"emailAddress": "A String", # 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.

1929

"etag": "A String", # The ETag of the permission.

1930

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

1931

# - They cannot be set on shared drive items

1932

# - They can only be set on user and group permissions

1933

# - The date must be in the future

1934

# - The date cannot be more than a year in the future

1935

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

1936

"id": "A String", # 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.

1937

"kind": "drive#permission", # This is always drive#permission.

1938

"name": "A String", # The name for this permission.

1939

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

1940

{

1941

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

1942

"A String",

1943

],

1944

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1945

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1946

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1947

# - file

1948

# - member

1949

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

1957

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

1964

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1965

{

1966

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

1967

"A String",

1968

],

1969

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1970

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1971

"role": "A String", # Deprecated - use permissionDetails/role instead.

1972

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1973

},

1974

],

1975

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

1981

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1982

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1983

],

1984

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1985

{ # A key-value pair attached to a file that is either public or private to an application.

1986

# The following limits apply to file properties:

1987

# - Maximum of 100 properties total per file

1988

# - Maximum of 30 private properties per app

1989

# - Maximum of 30 public properties

1990

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1991

"etag": "A String", # ETag of the property.

1992

"key": "A String", # The key of this property.

1993

"kind": "drive#property", # This is always drive#property.

1994

"selfLink": "A String", # The link back to this property.

1995

"value": "A String", # The value of this property.

1996

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1997

},

1998

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1999

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

2000

"selfLink": "A String", # A link back to this file.

2001

"shareable": True or False, # Deprecated: use capabilities/canShare.

2002

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

2003

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

2004

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

2005

"displayName": "A String", # A plain text displayable name for this user.

2006

"emailAddress": "A String", # The email address of the user.

2007

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2008

"kind": "drive#user", # This is always drive#user.

2009

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2010

"picture": { # The user's profile picture.

2011

"url": "A String", # A URL that points to a profile picture of this user.

2012

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2013

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2014

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

2015

"targetId": "A String", # The ID of the file that this shortcut points to.

2016

"targetMimeType": "A String", # 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.

2017

},

2018

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

2019

"A String",

2020

],

2021

"teamDriveId": "A String", # Deprecated - use driveId instead.

2022

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

2023

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

2024

"mimeType": "A String", # The MIME type of the thumbnail.

2025

},

2026

"thumbnailLink": "A String", # 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.

2027

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

2028

"title": "A String", # 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.

2029

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

2030

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

2031

"displayName": "A String", # A plain text displayable name for this user.

2032

"emailAddress": "A String", # The email address of the user.

2033

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2034

"kind": "drive#user", # This is always drive#user.

2035

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2036

"picture": { # The user's profile picture.

2037

"url": "A String", # A URL that points to a profile picture of this user.

2038

},

2039

},

2040

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

2041

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

2042

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2043

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2044

"authKey": "A String", # Deprecated.

2045

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2046

"domain": "A String", # 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.

2047

"emailAddress": "A String", # 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.

2048

"etag": "A String", # The ETag of the permission.

2049

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2050

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2051

# - They can only be set on user and group permissions

2052

# - The date must be in the future

2053

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2054

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2055

"id": "A String", # 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.

2056

"kind": "drive#permission", # This is always drive#permission.

2057

"name": "A String", # The name for this permission.

2058

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

2059

{

2060

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

2061

"A String",

2062

],

2063

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2064

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2065

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2066

# - file

2067

# - member

2068

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

2076

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2077

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2078

# - organizer

2079

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2080

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2081

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2082

"selfLink": "A String", # A link back to this permission.

2083

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2084

{

2085

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

2086

"A String",

2087

],

2088

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2089

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2090

"role": "A String", # Deprecated - use permissionDetails/role instead.

2091

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2092

},

2093

],

2094

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2099

"value": "A String", # 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.

2100

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2101

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2102

"version": "A String", # 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.

2103

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

2104

"durationMillis": "A String", # The duration of the video in milliseconds.

2105

"height": 42, # The height of the video in pixels.

2106

"width": 42, # The width of the video in pixels.

2107

},

2108

"webContentLink": "A String", # 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.

2109

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

2110

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2115

<code class="details" id="list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>

2116

<pre>Lists the user's files.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2117

2118

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2119

corpora: string, Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.

2121

Allowed values

2122

DEFAULT - The items that the user has accessed.

2123

DOMAIN - Items shared to the user's domain.

2124

driveId: string, ID of the shared drive to search.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2125

includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2126

includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.

2127

maxResults: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.

2128

orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

2129

pageToken: string, Page token for files.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2130

projection: string, This parameter is deprecated and has no function.

2131

Allowed values

2132

BASIC - Deprecated

2133

FULL - Deprecated

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2134

q: string, Query string for searching files.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2136

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2137

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

2138

teamDriveId: string, Deprecated use driveId instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2139

2140

Returns:

2141

An object of the form:

2142

2143

{ # A list of files.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

"etag": "A String", # The ETag of the list.

2145

"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive".

2146

"items": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2147

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2148

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

2149

"appDataContents": True or False, # Whether this file is in the Application Data folder.

2150

"canComment": True or False, # Deprecated: use capabilities/canComment.

2151

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

2152

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

2153

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2154

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2155

"canAddMyDriveParent": True or False, # 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.

2156

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

2157

"canChangeRestrictedDownload": True or False, # Deprecated

2158

"canComment": True or False, # Whether the current user can comment on this file.

2159

"canCopy": True or False, # 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.

2160

"canDelete": True or False, # Whether the current user can delete this file.

2161

"canDeleteChildren": True or False, # 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.

2162

"canDownload": True or False, # Whether the current user can download this file.

2163

"canEdit": True or False, # 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.

2164

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

2165

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2166

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2167

"canMoveChildrenOutOfDrive": True or False, # 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.

2168

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

2169

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

2170

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

2171

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2172

"canMoveItemOutOfDrive": True or False, # 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.

2173

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2174

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

2175

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

2176

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

2177

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

2178

"canReadRevisions": True or False, # 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.

2179

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

2180

"canRemoveChildren": True or False, # 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.

2181

"canRemoveMyDriveParent": True or False, # 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.

2182

"canRename": True or False, # Whether the current user can rename this file.

2183

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

2184

"canTrash": True or False, # Whether the current user can move this file to trash.

2185

"canTrashChildren": True or False, # 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.

2186

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2187

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2188

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

2189

{ # A restriction for accessing the content of the file.

2190

"readOnly": True or False, # Whether the content of the file is read-only.

2191

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

2192

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

2193

"displayName": "A String", # A plain text displayable name for this user.

2194

"emailAddress": "A String", # The email address of the user.

2195

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2196

"kind": "drive#user", # This is always drive#user.

2197

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2198

"picture": { # The user's profile picture.

2199

"url": "A String", # A URL that points to a profile picture of this user.

2200

},

2201

},

2202

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

2203

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

2204

},

2205

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2206

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

2207

"copyable": True or False, # Deprecated: use capabilities/canCopy.

2208

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

2209

"defaultOpenWithLink": "A String", # 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.

2210

"description": "A String", # A short description of the file.

2211

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

2212

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

2213

"editable": True or False, # Deprecated: use capabilities/canEdit.

2214

"embedLink": "A String", # A link for embedding the file.

2215

"etag": "A String", # ETag of the file.

2216

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

2217

"exportLinks": { # Links for exporting Google Docs to specific formats.

2218

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2219

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2220

"fileExtension": "A String", # 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 Google Docs or shortcut files.

2221

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

2222

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

2223

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

2224

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

2225

"hasThumbnail": True or False, # 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.

2226

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

2227

"iconLink": "A String", # A link to the file's icon.

2228

"id": "A String", # The ID of the file.

2229

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

2230

"aperture": 3.14, # The aperture used to create the photo (f-number).

2231

"cameraMake": "A String", # The make of the camera used to create the photo.

2232

"cameraModel": "A String", # The model of the camera used to create the photo.

2233

"colorSpace": "A String", # The color space of the photo.

2234

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

2235

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

2236

"exposureMode": "A String", # The exposure mode used to create the photo.

2237

"exposureTime": 3.14, # The length of the exposure, in seconds.

2238

"flashUsed": True or False, # Whether a flash was used to create the photo.

2239

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

2240

"height": 42, # The height of the image in pixels.

2241

"isoSpeed": 42, # The ISO speed used to create the photo.

2242

"lens": "A String", # The lens used to create the photo.

2243

"location": { # Geographic location information stored in the image.

2244

"altitude": 3.14, # The altitude stored in the image.

2245

"latitude": 3.14, # The latitude stored in the image.

2246

"longitude": 3.14, # The longitude stored in the image.

2247

},

2248

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

2249

"meteringMode": "A String", # The metering mode used to create the photo.

2250

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

2251

"sensor": "A String", # The type of sensor used to create the photo.

2252

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

2253

"whiteBalance": "A String", # The white balance mode used to create the photo.

2254

"width": 42, # The width of the image in pixels.

2255

},

2256

"indexableText": { # Indexable text attributes for the file (can only be written)

2257

"text": "A String", # The text to be indexed for this file.

2258

},

2259

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

2260

"kind": "drive#file", # The type of file. This is always drive#file.

2261

"labels": { # A group of labels for the file.

2262

"hidden": True or False, # Deprecated.

2263

"modified": True or False, # Whether the file has been modified by this user.

2264

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

2265

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2266

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2267

"viewed": True or False, # Whether this file has been viewed by this user.

2268

},

2269

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

2270

"displayName": "A String", # A plain text displayable name for this user.

2271

"emailAddress": "A String", # The email address of the user.

2272

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2273

"kind": "drive#user", # This is always drive#user.

2274

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2275

"picture": { # The user's profile picture.

2276

"url": "A String", # A URL that points to a profile picture of this user.

2277

},

2278

},

2279

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

2280

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

2281

"markedViewedByMeDate": "A String", # Deprecated.

2282

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

2283

"mimeType": "A String", # 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.

2284

"modifiedByMeDate": "A String", # 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.

2285

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

2286

"openWithLinks": { # 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.

2287

"a_key": "A String",

2288

},

2289

"originalFilename": "A String", # 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.

2290

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

2291

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

2292

"A String",

2293

],

2294

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2295

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2296

"displayName": "A String", # A plain text displayable name for this user.

2297

"emailAddress": "A String", # The email address of the user.

2298

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2299

"kind": "drive#user", # This is always drive#user.

2300

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2301

"picture": { # The user's profile picture.

2302

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2303

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2304

},

2305

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2306

"parents": [ # Collection of parent folders which contain this file.

2307

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

2308

{ # A reference to a file's parent.

2309

"id": "A String", # The ID of the parent.

2310

"isRoot": True or False, # Whether or not the parent is the root folder.

2311

"kind": "drive#parentReference", # This is always drive#parentReference.

2312

"parentLink": "A String", # A link to the parent.

2313

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2314

},

2315

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2316

"permissionIds": [ # List of permission IDs for users with access to this file.

2317

"A String",

2318

],

2319

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

2320

{ # A permission for a file.

2321

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

2322

"A String",

2323

],

2324

"authKey": "A String", # Deprecated.

2325

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2326

"domain": "A String", # 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.

2327

"emailAddress": "A String", # 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.

2328

"etag": "A String", # The ETag of the permission.

2329

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

2330

# - They cannot be set on shared drive items

2331

# - They can only be set on user and group permissions

2332

# - The date must be in the future

2333

# - The date cannot be more than a year in the future

2334

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

2335

"id": "A String", # 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.

2336

"kind": "drive#permission", # This is always drive#permission.

2337

"name": "A String", # The name for this permission.

2338

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

2339

{

2340

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

2341

"A String",

2342

],

2343

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2344

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2345

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2346

# - file

2347

# - member

2348

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

2356

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

2363

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2364

{

2365

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

2366

"A String",

2367

],

2368

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2369

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2370

"role": "A String", # Deprecated - use permissionDetails/role instead.

2371

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2372

},

2373

],

2374

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

2380

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2381

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2382

],

2383

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

2384

{ # A key-value pair attached to a file that is either public or private to an application.

2385

# The following limits apply to file properties:

2386

# - Maximum of 100 properties total per file

2387

# - Maximum of 30 private properties per app

2388

# - Maximum of 30 public properties

2389

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2390

"etag": "A String", # ETag of the property.

2391

"key": "A String", # The key of this property.

2392

"kind": "drive#property", # This is always drive#property.

2393

"selfLink": "A String", # The link back to this property.

2394

"value": "A String", # The value of this property.

2395

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2396

},

2397

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2398

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

2399

"selfLink": "A String", # A link back to this file.

2400

"shareable": True or False, # Deprecated: use capabilities/canShare.

2401

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

2402

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

2403

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

2404

"displayName": "A String", # A plain text displayable name for this user.

2405

"emailAddress": "A String", # The email address of the user.

2406

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2407

"kind": "drive#user", # This is always drive#user.

2408

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2409

"picture": { # The user's profile picture.

2410

"url": "A String", # A URL that points to a profile picture of this user.

2411

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2412

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2413

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

2414

"targetId": "A String", # The ID of the file that this shortcut points to.

2415

"targetMimeType": "A String", # 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.

2416

},

2417

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

2418

"A String",

2419

],

2420

"teamDriveId": "A String", # Deprecated - use driveId instead.

2421

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

2422

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

2423

"mimeType": "A String", # The MIME type of the thumbnail.

2424

},

2425

"thumbnailLink": "A String", # 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.

2426

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

2427

"title": "A String", # 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.

2428

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

2429

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

2430

"displayName": "A String", # A plain text displayable name for this user.

2431

"emailAddress": "A String", # The email address of the user.

2432

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2433

"kind": "drive#user", # This is always drive#user.

2434

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2435

"picture": { # The user's profile picture.

2436

"url": "A String", # A URL that points to a profile picture of this user.

2437

},

2438

},

2439

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

2440

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

2441

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2442

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

"authKey": "A String", # Deprecated.

2444

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2445

"domain": "A String", # 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.

2446

"emailAddress": "A String", # 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.

2447

"etag": "A String", # The ETag of the permission.

2448

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2449

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2450

# - They can only be set on user and group permissions

2451

# - The date must be in the future

2452

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2453

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2454

"id": "A String", # 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.

2455

"kind": "drive#permission", # This is always drive#permission.

2456

"name": "A String", # The name for this permission.

2457

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

2458

{

2459

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

2460

"A String",

2461

],

2462

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2463

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2464

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2465

# - file

2466

# - member

2467

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

2475

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2476

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2477

# - organizer

2478

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2479

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2480

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2481

"selfLink": "A String", # A link back to this permission.

2482

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2483

{

2484

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

2485

"A String",

2486

],

2487

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2488

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2489

"role": "A String", # Deprecated - use permissionDetails/role instead.

2490

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2491

},

2492

],

2493

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2498

"value": "A String", # 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.

2499

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2500

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2501

"version": "A String", # 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.

2502

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

2503

"durationMillis": "A String", # The duration of the video in milliseconds.

2504

"height": 42, # The height of the video in pixels.

2505

"width": 42, # The width of the video in pixels.

2506

},

2507

"webContentLink": "A String", # 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.

2508

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

2509

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2510

},

2511

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2512

"kind": "drive#fileList", # This is always drive#fileList.

2513

"nextLink": "A String", # A link to the next page of files.

2514

"nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.

2515

"selfLink": "A String", # A link back to this list.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2521

<pre>Retrieves the next page of results.

2522

2523

Args:

2524

previous_request: The request for the previous page. (required)

2525

previous_response: The response from the request for the previous page. (required)

2526

2527

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2528

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2529

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2534

<code class="details" id="patch">patch(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2535

<pre>Updates file metadata and/or content. This method supports patch semantics.

2536

2537

Args:

2538

fileId: string, The ID of the file to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2539

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2540

The object takes the form of:

2541

2542

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2543

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

2544

"appDataContents": True or False, # Whether this file is in the Application Data folder.

2545

"canComment": True or False, # Deprecated: use capabilities/canComment.

2546

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

2547

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

2548

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2549

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2550

"canAddMyDriveParent": True or False, # 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.

2551

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

2552

"canChangeRestrictedDownload": True or False, # Deprecated

2553

"canComment": True or False, # Whether the current user can comment on this file.

2554

"canCopy": True or False, # 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.

2555

"canDelete": True or False, # Whether the current user can delete this file.

2556

"canDeleteChildren": True or False, # 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.

2557

"canDownload": True or False, # Whether the current user can download this file.

2558

"canEdit": True or False, # 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.

2559

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

2560

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2561

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2562

"canMoveChildrenOutOfDrive": True or False, # 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.

2563

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

2564

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

2565

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

2566

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2567

"canMoveItemOutOfDrive": True or False, # 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.

2568

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2569

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

2570

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

2571

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

2572

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

2573

"canReadRevisions": True or False, # 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.

2574

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

2575

"canRemoveChildren": True or False, # 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.

2576

"canRemoveMyDriveParent": True or False, # 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.

2577

"canRename": True or False, # Whether the current user can rename this file.

2578

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

2579

"canTrash": True or False, # Whether the current user can move this file to trash.

2580

"canTrashChildren": True or False, # 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.

2581

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2582

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2583

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

2584

{ # A restriction for accessing the content of the file.

2585

"readOnly": True or False, # Whether the content of the file is read-only.

2586

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

2587

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

2588

"displayName": "A String", # A plain text displayable name for this user.

2589

"emailAddress": "A String", # The email address of the user.

2590

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2591

"kind": "drive#user", # This is always drive#user.

2592

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2593

"picture": { # The user's profile picture.

2594

"url": "A String", # A URL that points to a profile picture of this user.

2595

},

2596

},

2597

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

2598

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

2599

},

2600

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2601

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

2602

"copyable": True or False, # Deprecated: use capabilities/canCopy.

2603

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

2604

"defaultOpenWithLink": "A String", # 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.

2605

"description": "A String", # A short description of the file.

2606

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

2607

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

2608

"editable": True or False, # Deprecated: use capabilities/canEdit.

2609

"embedLink": "A String", # A link for embedding the file.

2610

"etag": "A String", # ETag of the file.

2611

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

2612

"exportLinks": { # Links for exporting Google Docs to specific formats.

2613

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2614

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2615

"fileExtension": "A String", # 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 Google Docs or shortcut files.

2616

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

2617

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

2618

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

2619

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

2620

"hasThumbnail": True or False, # 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.

2621

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

2622

"iconLink": "A String", # A link to the file's icon.

2623

"id": "A String", # The ID of the file.

2624

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

2625

"aperture": 3.14, # The aperture used to create the photo (f-number).

2626

"cameraMake": "A String", # The make of the camera used to create the photo.

2627

"cameraModel": "A String", # The model of the camera used to create the photo.

2628

"colorSpace": "A String", # The color space of the photo.

2629

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

2630

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

2631

"exposureMode": "A String", # The exposure mode used to create the photo.

2632

"exposureTime": 3.14, # The length of the exposure, in seconds.

2633

"flashUsed": True or False, # Whether a flash was used to create the photo.

2634

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

2635

"height": 42, # The height of the image in pixels.

2636

"isoSpeed": 42, # The ISO speed used to create the photo.

2637

"lens": "A String", # The lens used to create the photo.

2638

"location": { # Geographic location information stored in the image.

2639

"altitude": 3.14, # The altitude stored in the image.

2640

"latitude": 3.14, # The latitude stored in the image.

2641

"longitude": 3.14, # The longitude stored in the image.

2642

},

2643

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

2644

"meteringMode": "A String", # The metering mode used to create the photo.

2645

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

2646

"sensor": "A String", # The type of sensor used to create the photo.

2647

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

2648

"whiteBalance": "A String", # The white balance mode used to create the photo.

2649

"width": 42, # The width of the image in pixels.

2650

},

2651

"indexableText": { # Indexable text attributes for the file (can only be written)

2652

"text": "A String", # The text to be indexed for this file.

2653

},

2654

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

2655

"kind": "drive#file", # The type of file. This is always drive#file.

2656

"labels": { # A group of labels for the file.

2657

"hidden": True or False, # Deprecated.

2658

"modified": True or False, # Whether the file has been modified by this user.

2659

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

2660

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2661

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2662

"viewed": True or False, # Whether this file has been viewed by this user.

2663

},

2664

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

2665

"displayName": "A String", # A plain text displayable name for this user.

2666

"emailAddress": "A String", # The email address of the user.

2667

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2668

"kind": "drive#user", # This is always drive#user.

2669

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2670

"picture": { # The user's profile picture.

2671

"url": "A String", # A URL that points to a profile picture of this user.

2672

},

2673

},

2674

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

2675

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

2676

"markedViewedByMeDate": "A String", # Deprecated.

2677

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

2678

"mimeType": "A String", # 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.

2679

"modifiedByMeDate": "A String", # 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.

2680

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

2681

"openWithLinks": { # 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.

2682

"a_key": "A String",

2683

},

2684

"originalFilename": "A String", # 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.

2685

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

2686

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

2687

"A String",

2688

],

2689

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2690

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2691

"displayName": "A String", # A plain text displayable name for this user.

2692

"emailAddress": "A String", # The email address of the user.

2693

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2694

"kind": "drive#user", # This is always drive#user.

2695

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2696

"picture": { # The user's profile picture.

2697

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2698

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2699

},

2700

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2701

"parents": [ # Collection of parent folders which contain this file.

2702

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

2703

{ # A reference to a file's parent.

2704

"id": "A String", # The ID of the parent.

2705

"isRoot": True or False, # Whether or not the parent is the root folder.

2706

"kind": "drive#parentReference", # This is always drive#parentReference.

2707

"parentLink": "A String", # A link to the parent.

2708

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2709

},

2710

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2711

"permissionIds": [ # List of permission IDs for users with access to this file.

2712

"A String",

2713

],

2714

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

2715

{ # A permission for a file.

2716

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

2717

"A String",

2718

],

2719

"authKey": "A String", # Deprecated.

2720

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2721

"domain": "A String", # 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.

2722

"emailAddress": "A String", # 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.

2723

"etag": "A String", # The ETag of the permission.

2724

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

2725

# - They cannot be set on shared drive items

2726

# - They can only be set on user and group permissions

2727

# - The date must be in the future

2728

# - The date cannot be more than a year in the future

2729

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

2730

"id": "A String", # 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.

2731

"kind": "drive#permission", # This is always drive#permission.

2732

"name": "A String", # The name for this permission.

2733

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

2734

{

2735

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

2736

"A String",

2737

],

2738

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2739

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2740

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2741

# - file

2742

# - member

2743

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

2751

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

2758

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2759

{

2760

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

2761

"A String",

2762

],

2763

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2764

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2765

"role": "A String", # Deprecated - use permissionDetails/role instead.

2766

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2767

},

2768

],

2769

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

2775

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2776

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2777

],

2778

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

2779

{ # A key-value pair attached to a file that is either public or private to an application.

2780

# The following limits apply to file properties:

2781

# - Maximum of 100 properties total per file

2782

# - Maximum of 30 private properties per app

2783

# - Maximum of 30 public properties

2784

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2785

"etag": "A String", # ETag of the property.

2786

"key": "A String", # The key of this property.

2787

"kind": "drive#property", # This is always drive#property.

2788

"selfLink": "A String", # The link back to this property.

2789

"value": "A String", # The value of this property.

2790

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2791

},

2792

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2793

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

2794

"selfLink": "A String", # A link back to this file.

2795

"shareable": True or False, # Deprecated: use capabilities/canShare.

2796

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

2797

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

2798

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

2799

"displayName": "A String", # A plain text displayable name for this user.

2800

"emailAddress": "A String", # The email address of the user.

2801

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2802

"kind": "drive#user", # This is always drive#user.

2803

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2804

"picture": { # The user's profile picture.

2805

"url": "A String", # A URL that points to a profile picture of this user.

2806

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2807

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2808

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

2809

"targetId": "A String", # The ID of the file that this shortcut points to.

2810

"targetMimeType": "A String", # 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.

2811

},

2812

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

2813

"A String",

2814

],

2815

"teamDriveId": "A String", # Deprecated - use driveId instead.

2816

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

2817

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

2818

"mimeType": "A String", # The MIME type of the thumbnail.

2819

},

2820

"thumbnailLink": "A String", # 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.

2821

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

2822

"title": "A String", # 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.

2823

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

2824

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

2825

"displayName": "A String", # A plain text displayable name for this user.

2826

"emailAddress": "A String", # The email address of the user.

2827

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2828

"kind": "drive#user", # This is always drive#user.

2829

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2830

"picture": { # The user's profile picture.

2831

"url": "A String", # A URL that points to a profile picture of this user.

2832

},

2833

},

2834

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

2835

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

2836

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2837

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2838

"authKey": "A String", # Deprecated.

2839

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2840

"domain": "A String", # 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.

2841

"emailAddress": "A String", # 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.

2842

"etag": "A String", # The ETag of the permission.

2843

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2844

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2845

# - They can only be set on user and group permissions

2846

# - The date must be in the future

2847

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2848

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2849

"id": "A String", # 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.

2850

"kind": "drive#permission", # This is always drive#permission.

2851

"name": "A String", # The name for this permission.

2852

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

2853

{

2854

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

2855

"A String",

2856

],

2857

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2858

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2859

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2860

# - file

2861

# - member

2862

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

2870

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2871

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2872

# - organizer

2873

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2874

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2875

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2876

"selfLink": "A String", # A link back to this permission.

2877

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2878

{

2879

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

2880

"A String",

2881

],

2882

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2883

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2884

"role": "A String", # Deprecated - use permissionDetails/role instead.

2885

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2886

},

2887

],

2888

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2893

"value": "A String", # 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.

2894

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2895

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2896

"version": "A String", # 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.

2897

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

2898

"durationMillis": "A String", # The duration of the video in milliseconds.

2899

"height": 42, # The height of the video in pixels.

2900

"width": 42, # The width of the video in pixels.

2901

},

2902

"webContentLink": "A String", # 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.

2903

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

2904

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2905

}

2906

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2907

addParents: string, Comma-separated list of parent IDs to add.

2908

convert: boolean, This parameter is deprecated and has no function.

2909

enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2910

modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

2911

Allowed values

2912

fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.

2913

fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.

2914

fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.

2915

noChange - Maintain the previous value of modifiedDate.

2916

now - Set modifiedDate to the current time.

2917

nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2918

newRevision: boolean, 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2919

ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

2920

ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2921

pinned: boolean, 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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2922

removeParents: string, Comma-separated list of parent IDs to remove.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2923

setModifiedDate: boolean, 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2924

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2925

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2926

timedTextLanguage: string, The language of the timed text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2927

timedTextTrackName: string, The timed text track name.

2928

updateViewedDate: boolean, Whether to update the view date after successfully updating the file.

2929

useContentAsIndexableText: boolean, Whether to use the content as indexable text.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2930

2931

Returns:

2932

An object of the form:

2933

2934

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2935

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

2936

"appDataContents": True or False, # Whether this file is in the Application Data folder.

2937

"canComment": True or False, # Deprecated: use capabilities/canComment.

2938

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

2939

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

2940

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2941

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2942

"canAddMyDriveParent": True or False, # 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.

2943

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

2944

"canChangeRestrictedDownload": True or False, # Deprecated

2945

"canComment": True or False, # Whether the current user can comment on this file.

2946

"canCopy": True or False, # 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.

2947

"canDelete": True or False, # Whether the current user can delete this file.

2948

"canDeleteChildren": True or False, # 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.

2949

"canDownload": True or False, # Whether the current user can download this file.

2950

"canEdit": True or False, # 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.

2951

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

2952

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2953

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2954

"canMoveChildrenOutOfDrive": True or False, # 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.

2955

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

2956

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

2957

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

2958

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2959

"canMoveItemOutOfDrive": True or False, # 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.

2960

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2961

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

2962

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

2963

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

2964

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

2965

"canReadRevisions": True or False, # 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.

2966

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

2967

"canRemoveChildren": True or False, # 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.

2968

"canRemoveMyDriveParent": True or False, # 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.

2969

"canRename": True or False, # Whether the current user can rename this file.

2970

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

2971

"canTrash": True or False, # Whether the current user can move this file to trash.

2972

"canTrashChildren": True or False, # 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.

2973

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2974

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2975

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

2976

{ # A restriction for accessing the content of the file.

2977

"readOnly": True or False, # Whether the content of the file is read-only.

2978

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

2979

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

2980

"displayName": "A String", # A plain text displayable name for this user.

2981

"emailAddress": "A String", # The email address of the user.

2982

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

2983

"kind": "drive#user", # This is always drive#user.

2984

"permissionId": "A String", # The user's ID as visible in the permissions collection.

2985

"picture": { # The user's profile picture.

2986

"url": "A String", # A URL that points to a profile picture of this user.

2987

},

2988

},

2989

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

2990

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

2991

},

2992

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2993

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

2994

"copyable": True or False, # Deprecated: use capabilities/canCopy.

2995

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

2996

"defaultOpenWithLink": "A String", # 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.

2997

"description": "A String", # A short description of the file.

2998

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

2999

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

3000

"editable": True or False, # Deprecated: use capabilities/canEdit.

3001

"embedLink": "A String", # A link for embedding the file.

3002

"etag": "A String", # ETag of the file.

3003

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

3004

"exportLinks": { # Links for exporting Google Docs to specific formats.

3005

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3006

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

"fileExtension": "A String", # 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 Google Docs or shortcut files.

3008

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

3009

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

3010

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

3011

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

3012

"hasThumbnail": True or False, # 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.

3013

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

3014

"iconLink": "A String", # A link to the file's icon.

3015

"id": "A String", # The ID of the file.

3016

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

3017

"aperture": 3.14, # The aperture used to create the photo (f-number).

3018

"cameraMake": "A String", # The make of the camera used to create the photo.

3019

"cameraModel": "A String", # The model of the camera used to create the photo.

3020

"colorSpace": "A String", # The color space of the photo.

3021

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

3022

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

3023

"exposureMode": "A String", # The exposure mode used to create the photo.

3024

"exposureTime": 3.14, # The length of the exposure, in seconds.

3025

"flashUsed": True or False, # Whether a flash was used to create the photo.

3026

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

3027

"height": 42, # The height of the image in pixels.

3028

"isoSpeed": 42, # The ISO speed used to create the photo.

3029

"lens": "A String", # The lens used to create the photo.

3030

"location": { # Geographic location information stored in the image.

3031

"altitude": 3.14, # The altitude stored in the image.

3032

"latitude": 3.14, # The latitude stored in the image.

3033

"longitude": 3.14, # The longitude stored in the image.

3034

},

3035

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

3036

"meteringMode": "A String", # The metering mode used to create the photo.

3037

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

3038

"sensor": "A String", # The type of sensor used to create the photo.

3039

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

3040

"whiteBalance": "A String", # The white balance mode used to create the photo.

3041

"width": 42, # The width of the image in pixels.

3042

},

3043

"indexableText": { # Indexable text attributes for the file (can only be written)

3044

"text": "A String", # The text to be indexed for this file.

3045

},

3046

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

3047

"kind": "drive#file", # The type of file. This is always drive#file.

3048

"labels": { # A group of labels for the file.

3049

"hidden": True or False, # Deprecated.

3050

"modified": True or False, # Whether the file has been modified by this user.

3051

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

3052

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3053

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3054

"viewed": True or False, # Whether this file has been viewed by this user.

3055

},

3056

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

3057

"displayName": "A String", # A plain text displayable name for this user.

3058

"emailAddress": "A String", # The email address of the user.

3059

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3060

"kind": "drive#user", # This is always drive#user.

3061

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3062

"picture": { # The user's profile picture.

3063

"url": "A String", # A URL that points to a profile picture of this user.

3064

},

3065

},

3066

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

3067

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

3068

"markedViewedByMeDate": "A String", # Deprecated.

3069

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

3070

"mimeType": "A String", # 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.

3071

"modifiedByMeDate": "A String", # 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.

3072

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

3073

"openWithLinks": { # 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.

3074

"a_key": "A String",

3075

},

3076

"originalFilename": "A String", # 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.

3077

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

3078

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

3079

"A String",

3080

],

3081

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3082

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3083

"displayName": "A String", # A plain text displayable name for this user.

3084

"emailAddress": "A String", # The email address of the user.

3085

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3086

"kind": "drive#user", # This is always drive#user.

3087

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3088

"picture": { # The user's profile picture.

3089

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3090

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3091

},

3092

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3093

"parents": [ # Collection of parent folders which contain this file.

3094

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

3095

{ # A reference to a file's parent.

3096

"id": "A String", # The ID of the parent.

3097

"isRoot": True or False, # Whether or not the parent is the root folder.

3098

"kind": "drive#parentReference", # This is always drive#parentReference.

3099

"parentLink": "A String", # A link to the parent.

3100

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3101

},

3102

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3103

"permissionIds": [ # List of permission IDs for users with access to this file.

3104

"A String",

3105

],

3106

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

3107

{ # A permission for a file.

3108

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3109

"A String",

3110

],

3111

"authKey": "A String", # Deprecated.

3112

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3113

"domain": "A String", # 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.

3114

"emailAddress": "A String", # 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.

3115

"etag": "A String", # The ETag of the permission.

3116

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

3117

# - They cannot be set on shared drive items

3118

# - They can only be set on user and group permissions

3119

# - The date must be in the future

3120

# - The date cannot be more than a year in the future

3121

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

3122

"id": "A String", # 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.

3123

"kind": "drive#permission", # This is always drive#permission.

3124

"name": "A String", # The name for this permission.

3125

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

3126

{

3127

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

3128

"A String",

3129

],

3130

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

3131

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

3132

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

3133

# - file

3134

# - member

3135

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

3143

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

3150

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

3151

{

3152

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

3153

"A String",

3154

],

3155

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

3156

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

3157

"role": "A String", # Deprecated - use permissionDetails/role instead.

3158

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

3159

},

3160

],

3161

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

3167

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3168

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3169

],

3170

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

3171

{ # A key-value pair attached to a file that is either public or private to an application.

3172

# The following limits apply to file properties:

3173

# - Maximum of 100 properties total per file

3174

# - Maximum of 30 private properties per app

3175

# - Maximum of 30 public properties

3176

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3177

"etag": "A String", # ETag of the property.

3178

"key": "A String", # The key of this property.

3179

"kind": "drive#property", # This is always drive#property.

3180

"selfLink": "A String", # The link back to this property.

3181

"value": "A String", # The value of this property.

3182

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3183

},

3184

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3185

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

3186

"selfLink": "A String", # A link back to this file.

3187

"shareable": True or False, # Deprecated: use capabilities/canShare.

3188

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

3189

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

3190

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

3191

"displayName": "A String", # A plain text displayable name for this user.

3192

"emailAddress": "A String", # The email address of the user.

3193

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3194

"kind": "drive#user", # This is always drive#user.

3195

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3196

"picture": { # The user's profile picture.

3197

"url": "A String", # A URL that points to a profile picture of this user.

3198

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3199

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3200

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

3201

"targetId": "A String", # The ID of the file that this shortcut points to.

3202

"targetMimeType": "A String", # 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.

3203

},

3204

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

3205

"A String",

3206

],

3207

"teamDriveId": "A String", # Deprecated - use driveId instead.

3208

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

3209

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

3210

"mimeType": "A String", # The MIME type of the thumbnail.

3211

},

3212

"thumbnailLink": "A String", # 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.

3213

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

3214

"title": "A String", # 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.

3215

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

3216

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

3217

"displayName": "A String", # A plain text displayable name for this user.

3218

"emailAddress": "A String", # The email address of the user.

3219

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3220

"kind": "drive#user", # This is always drive#user.

3221

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3222

"picture": { # The user's profile picture.

3223

"url": "A String", # A URL that points to a profile picture of this user.

3224

},

3225

},

3226

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

3227

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3228

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3229

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"authKey": "A String", # Deprecated.

3231

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3232

"domain": "A String", # 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.

3233

"emailAddress": "A String", # 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.

3234

"etag": "A String", # The ETag of the permission.

3235

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3236

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3237

# - They can only be set on user and group permissions

3238

# - The date must be in the future

3239

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3240

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3241

"id": "A String", # 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.

3242

"kind": "drive#permission", # This is always drive#permission.

3243

"name": "A String", # The name for this permission.

3244

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

3245

{

3246

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

3247

"A String",

3248

],

3249

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

3250

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

3251

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

3252

# - file

3253

# - member

3254

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

3262

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3263

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3264

# - organizer

3265

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3266

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3267

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3268

"selfLink": "A String", # A link back to this permission.

3269

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

3270

{

3271

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

3272

"A String",

3273

],

3274

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

3275

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

3276

"role": "A String", # Deprecated - use permissionDetails/role instead.

3277

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

3278

},

3279

],

3280

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3285

"value": "A String", # 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.

3286

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3287

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"version": "A String", # 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.

3289

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

3290

"durationMillis": "A String", # The duration of the video in milliseconds.

3291

"height": 42, # The height of the video in pixels.

3292

"width": 42, # The width of the video in pixels.

3293

},

3294

"webContentLink": "A String", # 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.

3295

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

3296

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3301

<code class="details" id="touch">touch(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>

3302

<pre>Set the file's updated time to the current server time.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3303

3304

Args:

3305

fileId: string, The ID of the file to update. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3306

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3307

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3308

3309

Returns:

3310

An object of the form:

3311

3312

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3313

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

3314

"appDataContents": True or False, # Whether this file is in the Application Data folder.

3315

"canComment": True or False, # Deprecated: use capabilities/canComment.

3316

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

3317

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

3318

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3319

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3320

"canAddMyDriveParent": True or False, # 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.

3321

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

3322

"canChangeRestrictedDownload": True or False, # Deprecated

3323

"canComment": True or False, # Whether the current user can comment on this file.

3324

"canCopy": True or False, # 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.

3325

"canDelete": True or False, # Whether the current user can delete this file.

3326

"canDeleteChildren": True or False, # 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.

3327

"canDownload": True or False, # Whether the current user can download this file.

3328

"canEdit": True or False, # 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.

3329

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

3330

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3331

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3332

"canMoveChildrenOutOfDrive": True or False, # 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.

3333

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

3334

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

3335

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

3336

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

3337

"canMoveItemOutOfDrive": True or False, # 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.

3338

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

3339

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

3340

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

3341

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

3342

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

3343

"canReadRevisions": True or False, # 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.

3344

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

3345

"canRemoveChildren": True or False, # 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.

3346

"canRemoveMyDriveParent": True or False, # 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.

3347

"canRename": True or False, # Whether the current user can rename this file.

3348

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

3349

"canTrash": True or False, # Whether the current user can move this file to trash.

3350

"canTrashChildren": True or False, # 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.

3351

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3352

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3353

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

3354

{ # A restriction for accessing the content of the file.

3355

"readOnly": True or False, # Whether the content of the file is read-only.

3356

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

3357

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

3358

"displayName": "A String", # A plain text displayable name for this user.

3359

"emailAddress": "A String", # The email address of the user.

3360

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3361

"kind": "drive#user", # This is always drive#user.

3362

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3363

"picture": { # The user's profile picture.

3364

"url": "A String", # A URL that points to a profile picture of this user.

3365

},

3366

},

3367

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

3368

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

3369

},

3370

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3371

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

3372

"copyable": True or False, # Deprecated: use capabilities/canCopy.

3373

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

3374

"defaultOpenWithLink": "A String", # 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.

3375

"description": "A String", # A short description of the file.

3376

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

3377

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

3378

"editable": True or False, # Deprecated: use capabilities/canEdit.

3379

"embedLink": "A String", # A link for embedding the file.

3380

"etag": "A String", # ETag of the file.

3381

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

3382

"exportLinks": { # Links for exporting Google Docs to specific formats.

3383

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3384

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3385

"fileExtension": "A String", # 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 Google Docs or shortcut files.

3386

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

3387

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

3388

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

3389

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

3390

"hasThumbnail": True or False, # 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.

3391

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

3392

"iconLink": "A String", # A link to the file's icon.

3393

"id": "A String", # The ID of the file.

3394

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

3395

"aperture": 3.14, # The aperture used to create the photo (f-number).

3396

"cameraMake": "A String", # The make of the camera used to create the photo.

3397

"cameraModel": "A String", # The model of the camera used to create the photo.

3398

"colorSpace": "A String", # The color space of the photo.

3399

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

3400

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

3401

"exposureMode": "A String", # The exposure mode used to create the photo.

3402

"exposureTime": 3.14, # The length of the exposure, in seconds.

3403

"flashUsed": True or False, # Whether a flash was used to create the photo.

3404

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

3405

"height": 42, # The height of the image in pixels.

3406

"isoSpeed": 42, # The ISO speed used to create the photo.

3407

"lens": "A String", # The lens used to create the photo.

3408

"location": { # Geographic location information stored in the image.

3409

"altitude": 3.14, # The altitude stored in the image.

3410

"latitude": 3.14, # The latitude stored in the image.

3411

"longitude": 3.14, # The longitude stored in the image.

3412

},

3413

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

3414

"meteringMode": "A String", # The metering mode used to create the photo.

3415

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

3416

"sensor": "A String", # The type of sensor used to create the photo.

3417

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

3418

"whiteBalance": "A String", # The white balance mode used to create the photo.

3419

"width": 42, # The width of the image in pixels.

3420

},

3421

"indexableText": { # Indexable text attributes for the file (can only be written)

3422

"text": "A String", # The text to be indexed for this file.

3423

},

3424

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

3425

"kind": "drive#file", # The type of file. This is always drive#file.

3426

"labels": { # A group of labels for the file.

3427

"hidden": True or False, # Deprecated.

3428

"modified": True or False, # Whether the file has been modified by this user.

3429

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

3430

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3431

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3432

"viewed": True or False, # Whether this file has been viewed by this user.

3433

},

3434

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

3435

"displayName": "A String", # A plain text displayable name for this user.

3436

"emailAddress": "A String", # The email address of the user.

3437

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3438

"kind": "drive#user", # This is always drive#user.

3439

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3440

"picture": { # The user's profile picture.

3441

"url": "A String", # A URL that points to a profile picture of this user.

3442

},

3443

},

3444

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

3445

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

3446

"markedViewedByMeDate": "A String", # Deprecated.

3447

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

3448

"mimeType": "A String", # 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.

3449

"modifiedByMeDate": "A String", # 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.

3450

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

3451

"openWithLinks": { # 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.

3452

"a_key": "A String",

3453

},

3454

"originalFilename": "A String", # 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.

3455

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

3456

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

3457

"A String",

3458

],

3459

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3460

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3461

"displayName": "A String", # A plain text displayable name for this user.

3462

"emailAddress": "A String", # The email address of the user.

3463

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3464

"kind": "drive#user", # This is always drive#user.

3465

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3466

"picture": { # The user's profile picture.

3467

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3468

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3469

},

3470

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3471

"parents": [ # Collection of parent folders which contain this file.

3472

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

3473

{ # A reference to a file's parent.

3474

"id": "A String", # The ID of the parent.

3475

"isRoot": True or False, # Whether or not the parent is the root folder.

3476

"kind": "drive#parentReference", # This is always drive#parentReference.

3477

"parentLink": "A String", # A link to the parent.

3478

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3479

},

3480

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3481

"permissionIds": [ # List of permission IDs for users with access to this file.

3482

"A String",

3483

],

3484

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

3485

{ # A permission for a file.

3486

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3487

"A String",

3488

],

3489

"authKey": "A String", # Deprecated.

3490

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3491

"domain": "A String", # 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.

3492

"emailAddress": "A String", # 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.

3493

"etag": "A String", # The ETag of the permission.

3494

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

3495

# - They cannot be set on shared drive items

3496

# - They can only be set on user and group permissions

3497

# - The date must be in the future

3498

# - The date cannot be more than a year in the future

3499

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

3500

"id": "A String", # 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.

3501

"kind": "drive#permission", # This is always drive#permission.

3502

"name": "A String", # The name for this permission.

3503

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

3504

{

3505

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

3506

"A String",

3507

],

3508

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

3509

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

3510

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

3511

# - file

3512

# - member

3513

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

3521

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

3528

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

3529

{

3530

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

3531

"A String",

3532

],

3533

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

3534

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

3535

"role": "A String", # Deprecated - use permissionDetails/role instead.

3536

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

3537

},

3538

],

3539

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

3545

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3546

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3547

],

3548

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

3549

{ # A key-value pair attached to a file that is either public or private to an application.

3550

# The following limits apply to file properties:

3551

# - Maximum of 100 properties total per file

3552

# - Maximum of 30 private properties per app

3553

# - Maximum of 30 public properties

3554

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3555

"etag": "A String", # ETag of the property.

3556

"key": "A String", # The key of this property.

3557

"kind": "drive#property", # This is always drive#property.

3558

"selfLink": "A String", # The link back to this property.

3559

"value": "A String", # The value of this property.

3560

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3561

},

3562

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3563

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

3564

"selfLink": "A String", # A link back to this file.

3565

"shareable": True or False, # Deprecated: use capabilities/canShare.

3566

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

3567

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

3568

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

3569

"displayName": "A String", # A plain text displayable name for this user.

3570

"emailAddress": "A String", # The email address of the user.

3571

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3572

"kind": "drive#user", # This is always drive#user.

3573

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3574

"picture": { # The user's profile picture.

3575

"url": "A String", # A URL that points to a profile picture of this user.

3576

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3577

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3578

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

3579

"targetId": "A String", # The ID of the file that this shortcut points to.

3580

"targetMimeType": "A String", # 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.

3581

},

3582

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

3583

"A String",

3584

],

3585

"teamDriveId": "A String", # Deprecated - use driveId instead.

3586

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

3587

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

3588

"mimeType": "A String", # The MIME type of the thumbnail.

3589

},

3590

"thumbnailLink": "A String", # 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.

3591

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

3592

"title": "A String", # 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.

3593

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

3594

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

3595

"displayName": "A String", # A plain text displayable name for this user.

3596

"emailAddress": "A String", # The email address of the user.

3597

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3598

"kind": "drive#user", # This is always drive#user.

3599

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3600

"picture": { # The user's profile picture.

3601

"url": "A String", # A URL that points to a profile picture of this user.

3602

},

3603

},

3604

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

3605

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3606

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3607

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3608

"authKey": "A String", # Deprecated.

3609

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3610

"domain": "A String", # 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.

3611

"emailAddress": "A String", # 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.

3612

"etag": "A String", # The ETag of the permission.

3613

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3614

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3615

# - They can only be set on user and group permissions

3616

# - The date must be in the future

3617

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3618

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3619

"id": "A String", # 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.

3620

"kind": "drive#permission", # This is always drive#permission.

3621

"name": "A String", # The name for this permission.

3622

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

3623

{

3624

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

3625

"A String",

3626

],

3627

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

3628

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

3629

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

3630

# - file

3631

# - member

3632

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

3640

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3641

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3642

# - organizer

3643

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3644

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3645

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3646

"selfLink": "A String", # A link back to this permission.

3647

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

3648

{

3649

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

3650

"A String",

3651

],

3652

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

3653

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

3654

"role": "A String", # Deprecated - use permissionDetails/role instead.

3655

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

3656

},

3657

],

3658

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3663

"value": "A String", # 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.

3664

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3665

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

"version": "A String", # 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.

3667

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

3668

"durationMillis": "A String", # The duration of the video in milliseconds.

3669

"height": 42, # The height of the video in pixels.

3670

"width": 42, # The width of the video in pixels.

3671

},

3672

"webContentLink": "A String", # 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.

3673

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

3674

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3679

<code class="details" id="trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3680

<pre>Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. 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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3681

3682

Args:

3683

fileId: string, The ID of the file to trash. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3684

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3685

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3686

3687

Returns:

3688

An object of the form:

3689

3690

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3691

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

3692

"appDataContents": True or False, # Whether this file is in the Application Data folder.

3693

"canComment": True or False, # Deprecated: use capabilities/canComment.

3694

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

3695

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

3696

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3697

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3698

"canAddMyDriveParent": True or False, # 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.

3699

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

3700

"canChangeRestrictedDownload": True or False, # Deprecated

3701

"canComment": True or False, # Whether the current user can comment on this file.

3702

"canCopy": True or False, # 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.

3703

"canDelete": True or False, # Whether the current user can delete this file.

3704

"canDeleteChildren": True or False, # 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.

3705

"canDownload": True or False, # Whether the current user can download this file.

3706

"canEdit": True or False, # 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.

3707

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

3708

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3709

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3710

"canMoveChildrenOutOfDrive": True or False, # 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.

3711

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

3712

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

3713

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

3714

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

3715

"canMoveItemOutOfDrive": True or False, # 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.

3716

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

3717

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

3718

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

3719

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

3720

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

3721

"canReadRevisions": True or False, # 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.

3722

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

3723

"canRemoveChildren": True or False, # 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.

3724

"canRemoveMyDriveParent": True or False, # 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.

3725

"canRename": True or False, # Whether the current user can rename this file.

3726

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

3727

"canTrash": True or False, # Whether the current user can move this file to trash.

3728

"canTrashChildren": True or False, # 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.

3729

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3730

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3731

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

3732

{ # A restriction for accessing the content of the file.

3733

"readOnly": True or False, # Whether the content of the file is read-only.

3734

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

3735

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

3736

"displayName": "A String", # A plain text displayable name for this user.

3737

"emailAddress": "A String", # The email address of the user.

3738

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3739

"kind": "drive#user", # This is always drive#user.

3740

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3741

"picture": { # The user's profile picture.

3742

"url": "A String", # A URL that points to a profile picture of this user.

3743

},

3744

},

3745

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

3746

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

3747

},

3748

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3749

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

3750

"copyable": True or False, # Deprecated: use capabilities/canCopy.

3751

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

3752

"defaultOpenWithLink": "A String", # 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.

3753

"description": "A String", # A short description of the file.

3754

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

3755

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

3756

"editable": True or False, # Deprecated: use capabilities/canEdit.

3757

"embedLink": "A String", # A link for embedding the file.

3758

"etag": "A String", # ETag of the file.

3759

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

3760

"exportLinks": { # Links for exporting Google Docs to specific formats.

3761

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3762

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3763

"fileExtension": "A String", # 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 Google Docs or shortcut files.

3764

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

3765

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

3766

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

3767

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

3768

"hasThumbnail": True or False, # 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.

3769

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

3770

"iconLink": "A String", # A link to the file's icon.

3771

"id": "A String", # The ID of the file.

3772

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

3773

"aperture": 3.14, # The aperture used to create the photo (f-number).

3774

"cameraMake": "A String", # The make of the camera used to create the photo.

3775

"cameraModel": "A String", # The model of the camera used to create the photo.

3776

"colorSpace": "A String", # The color space of the photo.

3777

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

3778

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

3779

"exposureMode": "A String", # The exposure mode used to create the photo.

3780

"exposureTime": 3.14, # The length of the exposure, in seconds.

3781

"flashUsed": True or False, # Whether a flash was used to create the photo.

3782

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

3783

"height": 42, # The height of the image in pixels.

3784

"isoSpeed": 42, # The ISO speed used to create the photo.

3785

"lens": "A String", # The lens used to create the photo.

3786

"location": { # Geographic location information stored in the image.

3787

"altitude": 3.14, # The altitude stored in the image.

3788

"latitude": 3.14, # The latitude stored in the image.

3789

"longitude": 3.14, # The longitude stored in the image.

3790

},

3791

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

3792

"meteringMode": "A String", # The metering mode used to create the photo.

3793

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

3794

"sensor": "A String", # The type of sensor used to create the photo.

3795

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

3796

"whiteBalance": "A String", # The white balance mode used to create the photo.

3797

"width": 42, # The width of the image in pixels.

3798

},

3799

"indexableText": { # Indexable text attributes for the file (can only be written)

3800

"text": "A String", # The text to be indexed for this file.

3801

},

3802

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

3803

"kind": "drive#file", # The type of file. This is always drive#file.

3804

"labels": { # A group of labels for the file.

3805

"hidden": True or False, # Deprecated.

3806

"modified": True or False, # Whether the file has been modified by this user.

3807

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

3808

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3809

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3810

"viewed": True or False, # Whether this file has been viewed by this user.

3811

},

3812

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

3813

"displayName": "A String", # A plain text displayable name for this user.

3814

"emailAddress": "A String", # The email address of the user.

3815

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3816

"kind": "drive#user", # This is always drive#user.

3817

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3818

"picture": { # The user's profile picture.

3819

"url": "A String", # A URL that points to a profile picture of this user.

3820

},

3821

},

3822

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

3823

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

3824

"markedViewedByMeDate": "A String", # Deprecated.

3825

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

3826

"mimeType": "A String", # 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.

3827

"modifiedByMeDate": "A String", # 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.

3828

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

3829

"openWithLinks": { # 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.

3830

"a_key": "A String",

3831

},

3832

"originalFilename": "A String", # 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.

3833

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

3834

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

3835

"A String",

3836

],

3837

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3838

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3839

"displayName": "A String", # A plain text displayable name for this user.

3840

"emailAddress": "A String", # The email address of the user.

3841

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3842

"kind": "drive#user", # This is always drive#user.

3843

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3844

"picture": { # The user's profile picture.

3845

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3846

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3847

},

3848

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3849

"parents": [ # Collection of parent folders which contain this file.

3850

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

3851

{ # A reference to a file's parent.

3852

"id": "A String", # The ID of the parent.

3853

"isRoot": True or False, # Whether or not the parent is the root folder.

3854

"kind": "drive#parentReference", # This is always drive#parentReference.

3855

"parentLink": "A String", # A link to the parent.

3856

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3857

},

3858

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3859

"permissionIds": [ # List of permission IDs for users with access to this file.

3860

"A String",

3861

],

3862

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

3863

{ # A permission for a file.

3864

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3865

"A String",

3866

],

3867

"authKey": "A String", # Deprecated.

3868

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3869

"domain": "A String", # 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.

3870

"emailAddress": "A String", # 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.

3871

"etag": "A String", # The ETag of the permission.

3872

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

3873

# - They cannot be set on shared drive items

3874

# - They can only be set on user and group permissions

3875

# - The date must be in the future

3876

# - The date cannot be more than a year in the future

3877

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

3878

"id": "A String", # 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.

3879

"kind": "drive#permission", # This is always drive#permission.

3880

"name": "A String", # The name for this permission.

3881

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

3882

{

3883

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

3884

"A String",

3885

],

3886

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

3887

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

3888

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

3889

# - file

3890

# - member

3891

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

3899

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

3906

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

3907

{

3908

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

3909

"A String",

3910

],

3911

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

3912

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

3913

"role": "A String", # Deprecated - use permissionDetails/role instead.

3914

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

3915

},

3916

],

3917

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

3923

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3924

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3925

],

3926

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

3927

{ # A key-value pair attached to a file that is either public or private to an application.

3928

# The following limits apply to file properties:

3929

# - Maximum of 100 properties total per file

3930

# - Maximum of 30 private properties per app

3931

# - Maximum of 30 public properties

3932

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3933

"etag": "A String", # ETag of the property.

3934

"key": "A String", # The key of this property.

3935

"kind": "drive#property", # This is always drive#property.

3936

"selfLink": "A String", # The link back to this property.

3937

"value": "A String", # The value of this property.

3938

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3939

},

3940

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3941

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

3942

"selfLink": "A String", # A link back to this file.

3943

"shareable": True or False, # Deprecated: use capabilities/canShare.

3944

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

3945

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

3946

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

3947

"displayName": "A String", # A plain text displayable name for this user.

3948

"emailAddress": "A String", # The email address of the user.

3949

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3950

"kind": "drive#user", # This is always drive#user.

3951

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3952

"picture": { # The user's profile picture.

3953

"url": "A String", # A URL that points to a profile picture of this user.

3954

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3955

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3956

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

3957

"targetId": "A String", # The ID of the file that this shortcut points to.

3958

"targetMimeType": "A String", # 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.

3959

},

3960

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

3961

"A String",

3962

],

3963

"teamDriveId": "A String", # Deprecated - use driveId instead.

3964

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

3965

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

3966

"mimeType": "A String", # The MIME type of the thumbnail.

3967

},

3968

"thumbnailLink": "A String", # 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.

3969

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

3970

"title": "A String", # 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.

3971

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

3972

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

3973

"displayName": "A String", # A plain text displayable name for this user.

3974

"emailAddress": "A String", # The email address of the user.

3975

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

3976

"kind": "drive#user", # This is always drive#user.

3977

"permissionId": "A String", # The user's ID as visible in the permissions collection.

3978

"picture": { # The user's profile picture.

3979

"url": "A String", # A URL that points to a profile picture of this user.

3980

},

3981

},

3982

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

3983

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

3984

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3985

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3986

"authKey": "A String", # Deprecated.

3987

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

3988

"domain": "A String", # 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.

3989

"emailAddress": "A String", # 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.

3990

"etag": "A String", # The ETag of the permission.

3991

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3992

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3993

# - They can only be set on user and group permissions

3994

# - The date must be in the future

3995

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3996

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"id": "A String", # 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.

3998

"kind": "drive#permission", # This is always drive#permission.

3999

"name": "A String", # The name for this permission.

4000

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

4001

{

4002

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

4003

"A String",

4004

],

4005

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

4006

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

4007

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

4008

# - file

4009

# - member

4010

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

4018

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4019

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4020

# - organizer

4021

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4022

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4023

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4024

"selfLink": "A String", # A link back to this permission.

4025

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

4026

{

4027

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

4028

"A String",

4029

],

4030

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

4031

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

4032

"role": "A String", # Deprecated - use permissionDetails/role instead.

4033

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

4034

},

4035

],

4036

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4041

"value": "A String", # 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.

4042

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4043

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4044

"version": "A String", # 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.

4045

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

4046

"durationMillis": "A String", # The duration of the video in milliseconds.

4047

"height": 42, # The height of the video in pixels.

4048

"width": 42, # The width of the video in pixels.

4049

},

4050

"webContentLink": "A String", # 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.

4051

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

4052

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4057

<code class="details" id="untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4058

<pre>Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4059

4060

Args:

4061

fileId: string, The ID of the file to untrash. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4062

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4063

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4064

4065

Returns:

4066

An object of the form:

4067

4068

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4069

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

4070

"appDataContents": True or False, # Whether this file is in the Application Data folder.

4071

"canComment": True or False, # Deprecated: use capabilities/canComment.

4072

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

4073

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

4074

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4075

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4076

"canAddMyDriveParent": True or False, # 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.

4077

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

4078

"canChangeRestrictedDownload": True or False, # Deprecated

4079

"canComment": True or False, # Whether the current user can comment on this file.

4080

"canCopy": True or False, # 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.

4081

"canDelete": True or False, # Whether the current user can delete this file.

4082

"canDeleteChildren": True or False, # 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.

4083

"canDownload": True or False, # Whether the current user can download this file.

4084

"canEdit": True or False, # 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.

4085

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

4086

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4087

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4088

"canMoveChildrenOutOfDrive": True or False, # 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.

4089

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

4090

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

4091

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

4092

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4093

"canMoveItemOutOfDrive": True or False, # 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.

4094

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4095

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

4096

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

4097

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

4098

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

4099

"canReadRevisions": True or False, # 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.

4100

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

4101

"canRemoveChildren": True or False, # 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.

4102

"canRemoveMyDriveParent": True or False, # 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.

4103

"canRename": True or False, # Whether the current user can rename this file.

4104

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

4105

"canTrash": True or False, # Whether the current user can move this file to trash.

4106

"canTrashChildren": True or False, # 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.

4107

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4108

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4109

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

4110

{ # A restriction for accessing the content of the file.

4111

"readOnly": True or False, # Whether the content of the file is read-only.

4112

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

4113

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

4114

"displayName": "A String", # A plain text displayable name for this user.

4115

"emailAddress": "A String", # The email address of the user.

4116

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4117

"kind": "drive#user", # This is always drive#user.

4118

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4119

"picture": { # The user's profile picture.

4120

"url": "A String", # A URL that points to a profile picture of this user.

4121

},

4122

},

4123

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

4124

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

4125

},

4126

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4127

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

4128

"copyable": True or False, # Deprecated: use capabilities/canCopy.

4129

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

4130

"defaultOpenWithLink": "A String", # 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.

4131

"description": "A String", # A short description of the file.

4132

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

4133

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

4134

"editable": True or False, # Deprecated: use capabilities/canEdit.

4135

"embedLink": "A String", # A link for embedding the file.

4136

"etag": "A String", # ETag of the file.

4137

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

4138

"exportLinks": { # Links for exporting Google Docs to specific formats.

4139

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4140

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4141

"fileExtension": "A String", # 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 Google Docs or shortcut files.

4142

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

4143

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

4144

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

4145

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

4146

"hasThumbnail": True or False, # 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.

4147

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

4148

"iconLink": "A String", # A link to the file's icon.

4149

"id": "A String", # The ID of the file.

4150

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

4151

"aperture": 3.14, # The aperture used to create the photo (f-number).

4152

"cameraMake": "A String", # The make of the camera used to create the photo.

4153

"cameraModel": "A String", # The model of the camera used to create the photo.

4154

"colorSpace": "A String", # The color space of the photo.

4155

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

4156

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

4157

"exposureMode": "A String", # The exposure mode used to create the photo.

4158

"exposureTime": 3.14, # The length of the exposure, in seconds.

4159

"flashUsed": True or False, # Whether a flash was used to create the photo.

4160

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

4161

"height": 42, # The height of the image in pixels.

4162

"isoSpeed": 42, # The ISO speed used to create the photo.

4163

"lens": "A String", # The lens used to create the photo.

4164

"location": { # Geographic location information stored in the image.

4165

"altitude": 3.14, # The altitude stored in the image.

4166

"latitude": 3.14, # The latitude stored in the image.

4167

"longitude": 3.14, # The longitude stored in the image.

4168

},

4169

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

4170

"meteringMode": "A String", # The metering mode used to create the photo.

4171

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

4172

"sensor": "A String", # The type of sensor used to create the photo.

4173

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

4174

"whiteBalance": "A String", # The white balance mode used to create the photo.

4175

"width": 42, # The width of the image in pixels.

4176

},

4177

"indexableText": { # Indexable text attributes for the file (can only be written)

4178

"text": "A String", # The text to be indexed for this file.

4179

},

4180

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

4181

"kind": "drive#file", # The type of file. This is always drive#file.

4182

"labels": { # A group of labels for the file.

4183

"hidden": True or False, # Deprecated.

4184

"modified": True or False, # Whether the file has been modified by this user.

4185

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

4186

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4187

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4188

"viewed": True or False, # Whether this file has been viewed by this user.

4189

},

4190

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

4191

"displayName": "A String", # A plain text displayable name for this user.

4192

"emailAddress": "A String", # The email address of the user.

4193

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4194

"kind": "drive#user", # This is always drive#user.

4195

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4196

"picture": { # The user's profile picture.

4197

"url": "A String", # A URL that points to a profile picture of this user.

4198

},

4199

},

4200

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

4201

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

4202

"markedViewedByMeDate": "A String", # Deprecated.

4203

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

4204

"mimeType": "A String", # 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.

4205

"modifiedByMeDate": "A String", # 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.

4206

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

4207

"openWithLinks": { # 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.

4208

"a_key": "A String",

4209

},

4210

"originalFilename": "A String", # 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.

4211

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

4212

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

4213

"A String",

4214

],

4215

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4216

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4217

"displayName": "A String", # A plain text displayable name for this user.

4218

"emailAddress": "A String", # The email address of the user.

4219

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4220

"kind": "drive#user", # This is always drive#user.

4221

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4222

"picture": { # The user's profile picture.

4223

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4224

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4225

},

4226

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4227

"parents": [ # Collection of parent folders which contain this file.

4228

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

4229

{ # A reference to a file's parent.

4230

"id": "A String", # The ID of the parent.

4231

"isRoot": True or False, # Whether or not the parent is the root folder.

4232

"kind": "drive#parentReference", # This is always drive#parentReference.

4233

"parentLink": "A String", # A link to the parent.

4234

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4235

},

4236

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4237

"permissionIds": [ # List of permission IDs for users with access to this file.

4238

"A String",

4239

],

4240

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

4241

{ # A permission for a file.

4242

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

4243

"A String",

4244

],

4245

"authKey": "A String", # Deprecated.

4246

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

4247

"domain": "A String", # 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.

4248

"emailAddress": "A String", # 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.

4249

"etag": "A String", # The ETag of the permission.

4250

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

4251

# - They cannot be set on shared drive items

4252

# - They can only be set on user and group permissions

4253

# - The date must be in the future

4254

# - The date cannot be more than a year in the future

4255

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

4256

"id": "A String", # 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.

4257

"kind": "drive#permission", # This is always drive#permission.

4258

"name": "A String", # The name for this permission.

4259

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

4260

{

4261

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

4262

"A String",

4263

],

4264

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

4265

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

4266

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

4267

# - file

4268

# - member

4269

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

4277

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

4284

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

4285

{

4286

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

4287

"A String",

4288

],

4289

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

4290

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

4291

"role": "A String", # Deprecated - use permissionDetails/role instead.

4292

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

4293

},

4294

],

4295

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

4301

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4302

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4303

],

4304

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

4305

{ # A key-value pair attached to a file that is either public or private to an application.

4306

# The following limits apply to file properties:

4307

# - Maximum of 100 properties total per file

4308

# - Maximum of 30 private properties per app

4309

# - Maximum of 30 public properties

4310

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4311

"etag": "A String", # ETag of the property.

4312

"key": "A String", # The key of this property.

4313

"kind": "drive#property", # This is always drive#property.

4314

"selfLink": "A String", # The link back to this property.

4315

"value": "A String", # The value of this property.

4316

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4317

},

4318

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4319

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

4320

"selfLink": "A String", # A link back to this file.

4321

"shareable": True or False, # Deprecated: use capabilities/canShare.

4322

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

4323

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

4324

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

4325

"displayName": "A String", # A plain text displayable name for this user.

4326

"emailAddress": "A String", # The email address of the user.

4327

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4328

"kind": "drive#user", # This is always drive#user.

4329

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4330

"picture": { # The user's profile picture.

4331

"url": "A String", # A URL that points to a profile picture of this user.

4332

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4333

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4334

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

4335

"targetId": "A String", # The ID of the file that this shortcut points to.

4336

"targetMimeType": "A String", # 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.

4337

},

4338

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

4339

"A String",

4340

],

4341

"teamDriveId": "A String", # Deprecated - use driveId instead.

4342

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

4343

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

4344

"mimeType": "A String", # The MIME type of the thumbnail.

4345

},

4346

"thumbnailLink": "A String", # 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.

4347

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

4348

"title": "A String", # 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.

4349

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

4350

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

4351

"displayName": "A String", # A plain text displayable name for this user.

4352

"emailAddress": "A String", # The email address of the user.

4353

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4354

"kind": "drive#user", # This is always drive#user.

4355

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4356

"picture": { # The user's profile picture.

4357

"url": "A String", # A URL that points to a profile picture of this user.

4358

},

4359

},

4360

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

4361

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

4362

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4363

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4364

"authKey": "A String", # Deprecated.

4365

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

4366

"domain": "A String", # 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.

4367

"emailAddress": "A String", # 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.

4368

"etag": "A String", # The ETag of the permission.

4369

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4370

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4371

# - They can only be set on user and group permissions

4372

# - The date must be in the future

4373

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4374

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4375

"id": "A String", # 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.

4376

"kind": "drive#permission", # This is always drive#permission.

4377

"name": "A String", # The name for this permission.

4378

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

4379

{

4380

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

4381

"A String",

4382

],

4383

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

4384

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

4385

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

4386

# - file

4387

# - member

4388

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

4396

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4397

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4398

# - organizer

4399

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4400

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4401

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4402

"selfLink": "A String", # A link back to this permission.

4403

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

4404

{

4405

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

4406

"A String",

4407

],

4408

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

4409

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

4410

"role": "A String", # Deprecated - use permissionDetails/role instead.

4411

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

4412

},

4413

],

4414

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4419

"value": "A String", # 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.

4420

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4421

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4422

"version": "A String", # 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.

4423

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

4424

"durationMillis": "A String", # The duration of the video in milliseconds.

4425

"height": 42, # The height of the video in pixels.

4426

"width": 42, # The width of the video in pixels.

4427

},

4428

"webContentLink": "A String", # 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.

4429

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

4430

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4435

<code class="details" id="update">update(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4436

<pre>Updates file metadata and/or content.

4437

4438

Args:

4439

fileId: string, The ID of the file to update. (required)

4440

body: object, The request body.

4441

The object takes the form of:

4442

4443

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4444

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

4445

"appDataContents": True or False, # Whether this file is in the Application Data folder.

4446

"canComment": True or False, # Deprecated: use capabilities/canComment.

4447

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

4448

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

4449

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4450

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4451

"canAddMyDriveParent": True or False, # 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.

4452

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

4453

"canChangeRestrictedDownload": True or False, # Deprecated

4454

"canComment": True or False, # Whether the current user can comment on this file.

4455

"canCopy": True or False, # 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.

4456

"canDelete": True or False, # Whether the current user can delete this file.

4457

"canDeleteChildren": True or False, # 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.

4458

"canDownload": True or False, # Whether the current user can download this file.

4459

"canEdit": True or False, # 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.

4460

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

4461

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4462

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4463

"canMoveChildrenOutOfDrive": True or False, # 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.

4464

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

4465

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

4466

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

4467

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4468

"canMoveItemOutOfDrive": True or False, # 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.

4469

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4470

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

4471

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

4472

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

4473

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

4474

"canReadRevisions": True or False, # 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.

4475

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

4476

"canRemoveChildren": True or False, # 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.

4477

"canRemoveMyDriveParent": True or False, # 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.

4478

"canRename": True or False, # Whether the current user can rename this file.

4479

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

4480

"canTrash": True or False, # Whether the current user can move this file to trash.

4481

"canTrashChildren": True or False, # 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.

4482

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4483

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4484

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

4485

{ # A restriction for accessing the content of the file.

4486

"readOnly": True or False, # Whether the content of the file is read-only.

4487

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

4488

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

4489

"displayName": "A String", # A plain text displayable name for this user.

4490

"emailAddress": "A String", # The email address of the user.

4491

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4492

"kind": "drive#user", # This is always drive#user.

4493

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4494

"picture": { # The user's profile picture.

4495

"url": "A String", # A URL that points to a profile picture of this user.

4496

},

4497

},

4498

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

4499

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

4500

},

4501

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4502

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

4503

"copyable": True or False, # Deprecated: use capabilities/canCopy.

4504

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

4505

"defaultOpenWithLink": "A String", # 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.

4506

"description": "A String", # A short description of the file.

4507

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

4508

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

4509

"editable": True or False, # Deprecated: use capabilities/canEdit.

4510

"embedLink": "A String", # A link for embedding the file.

4511

"etag": "A String", # ETag of the file.

4512

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

4513

"exportLinks": { # Links for exporting Google Docs to specific formats.

4514

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4515

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4516

"fileExtension": "A String", # 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 Google Docs or shortcut files.

4517

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

4518

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

4519

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

4520

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

4521

"hasThumbnail": True or False, # 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.

4522

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

4523

"iconLink": "A String", # A link to the file's icon.

4524

"id": "A String", # The ID of the file.

4525

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

4526

"aperture": 3.14, # The aperture used to create the photo (f-number).

4527

"cameraMake": "A String", # The make of the camera used to create the photo.

4528

"cameraModel": "A String", # The model of the camera used to create the photo.

4529

"colorSpace": "A String", # The color space of the photo.

4530

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

4531

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

4532

"exposureMode": "A String", # The exposure mode used to create the photo.

4533

"exposureTime": 3.14, # The length of the exposure, in seconds.

4534

"flashUsed": True or False, # Whether a flash was used to create the photo.

4535

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

4536

"height": 42, # The height of the image in pixels.

4537

"isoSpeed": 42, # The ISO speed used to create the photo.

4538

"lens": "A String", # The lens used to create the photo.

4539

"location": { # Geographic location information stored in the image.

4540

"altitude": 3.14, # The altitude stored in the image.

4541

"latitude": 3.14, # The latitude stored in the image.

4542

"longitude": 3.14, # The longitude stored in the image.

4543

},

4544

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

4545

"meteringMode": "A String", # The metering mode used to create the photo.

4546

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

4547

"sensor": "A String", # The type of sensor used to create the photo.

4548

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

4549

"whiteBalance": "A String", # The white balance mode used to create the photo.

4550

"width": 42, # The width of the image in pixels.

4551

},

4552

"indexableText": { # Indexable text attributes for the file (can only be written)

4553

"text": "A String", # The text to be indexed for this file.

4554

},

4555

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

4556

"kind": "drive#file", # The type of file. This is always drive#file.

4557

"labels": { # A group of labels for the file.

4558

"hidden": True or False, # Deprecated.

4559

"modified": True or False, # Whether the file has been modified by this user.

4560

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

4561

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4562

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4563

"viewed": True or False, # Whether this file has been viewed by this user.

4564

},

4565

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

4566

"displayName": "A String", # A plain text displayable name for this user.

4567

"emailAddress": "A String", # The email address of the user.

4568

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4569

"kind": "drive#user", # This is always drive#user.

4570

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4571

"picture": { # The user's profile picture.

4572

"url": "A String", # A URL that points to a profile picture of this user.

4573

},

4574

},

4575

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

4576

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

4577

"markedViewedByMeDate": "A String", # Deprecated.

4578

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

4579

"mimeType": "A String", # 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.

4580

"modifiedByMeDate": "A String", # 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.

4581

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

4582

"openWithLinks": { # 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.

4583

"a_key": "A String",

4584

},

4585

"originalFilename": "A String", # 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.

4586

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

4587

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

4588

"A String",

4589

],

4590

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4591

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4592

"displayName": "A String", # A plain text displayable name for this user.

4593

"emailAddress": "A String", # The email address of the user.

4594

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4595

"kind": "drive#user", # This is always drive#user.

4596

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4597

"picture": { # The user's profile picture.

4598

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4599

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4600

},

4601

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4602

"parents": [ # Collection of parent folders which contain this file.

4603

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

4604

{ # A reference to a file's parent.

4605

"id": "A String", # The ID of the parent.

4606

"isRoot": True or False, # Whether or not the parent is the root folder.

4607

"kind": "drive#parentReference", # This is always drive#parentReference.

4608

"parentLink": "A String", # A link to the parent.

4609

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4610

},

4611

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4612

"permissionIds": [ # List of permission IDs for users with access to this file.

4613

"A String",

4614

],

4615

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

4616

{ # A permission for a file.

4617

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

4618

"A String",

4619

],

4620

"authKey": "A String", # Deprecated.

4621

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

4622

"domain": "A String", # 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.

4623

"emailAddress": "A String", # 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.

4624

"etag": "A String", # The ETag of the permission.

4625

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

4626

# - They cannot be set on shared drive items

4627

# - They can only be set on user and group permissions

4628

# - The date must be in the future

4629

# - The date cannot be more than a year in the future

4630

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

4631

"id": "A String", # 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.

4632

"kind": "drive#permission", # This is always drive#permission.

4633

"name": "A String", # The name for this permission.

4634

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

4635

{

4636

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

4637

"A String",

4638

],

4639

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

4640

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

4641

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

4642

# - file

4643

# - member

4644

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

4652

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

4659

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

4660

{

4661

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

4662

"A String",

4663

],

4664

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

4665

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

4666

"role": "A String", # Deprecated - use permissionDetails/role instead.

4667

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

4668

},

4669

],

4670

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

4676

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4677

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4678

],

4679

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

4680

{ # A key-value pair attached to a file that is either public or private to an application.

4681

# The following limits apply to file properties:

4682

# - Maximum of 100 properties total per file

4683

# - Maximum of 30 private properties per app

4684

# - Maximum of 30 public properties

4685

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4686

"etag": "A String", # ETag of the property.

4687

"key": "A String", # The key of this property.

4688

"kind": "drive#property", # This is always drive#property.

4689

"selfLink": "A String", # The link back to this property.

4690

"value": "A String", # The value of this property.

4691

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4692

},

4693

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4694

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

4695

"selfLink": "A String", # A link back to this file.

4696

"shareable": True or False, # Deprecated: use capabilities/canShare.

4697

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

4698

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

4699

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

4700

"displayName": "A String", # A plain text displayable name for this user.

4701

"emailAddress": "A String", # The email address of the user.

4702

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4703

"kind": "drive#user", # This is always drive#user.

4704

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4705

"picture": { # The user's profile picture.

4706

"url": "A String", # A URL that points to a profile picture of this user.

4707

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4708

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4709

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

4710

"targetId": "A String", # The ID of the file that this shortcut points to.

4711

"targetMimeType": "A String", # 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.

4712

},

4713

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

4714

"A String",

4715

],

4716

"teamDriveId": "A String", # Deprecated - use driveId instead.

4717

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

4718

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

4719

"mimeType": "A String", # The MIME type of the thumbnail.

4720

},

4721

"thumbnailLink": "A String", # 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.

4722

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

4723

"title": "A String", # 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.

4724

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

4725

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

4726

"displayName": "A String", # A plain text displayable name for this user.

4727

"emailAddress": "A String", # The email address of the user.

4728

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4729

"kind": "drive#user", # This is always drive#user.

4730

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4731

"picture": { # The user's profile picture.

4732

"url": "A String", # A URL that points to a profile picture of this user.

4733

},

4734

},

4735

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

4736

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

4737

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4738

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4739

"authKey": "A String", # Deprecated.

4740

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

4741

"domain": "A String", # 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.

4742

"emailAddress": "A String", # 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.

4743

"etag": "A String", # The ETag of the permission.

4744

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4745

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4746

# - They can only be set on user and group permissions

4747

# - The date must be in the future

4748

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4749

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4750

"id": "A String", # 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.

4751

"kind": "drive#permission", # This is always drive#permission.

4752

"name": "A String", # The name for this permission.

4753

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

4754

{

4755

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

4756

"A String",

4757

],

4758

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

4759

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

4760

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

4761

# - file

4762

# - member

4763

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

4771

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4772

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4773

# - organizer

4774

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4775

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4776

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4777

"selfLink": "A String", # A link back to this permission.

4778

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

4779

{

4780

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

4781

"A String",

4782

],

4783

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

4784

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

4785

"role": "A String", # Deprecated - use permissionDetails/role instead.

4786

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

4787

},

4788

],

4789

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4794

"value": "A String", # 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.

4795

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4796

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4797

"version": "A String", # 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.

4798

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

4799

"durationMillis": "A String", # The duration of the video in milliseconds.

4800

"height": 42, # The height of the video in pixels.

4801

"width": 42, # The width of the video in pixels.

4802

},

4803

"webContentLink": "A String", # 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.

4804

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

4805

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4806

}

4807

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4808

addParents: string, Comma-separated list of parent IDs to add.

4809

convert: boolean, This parameter is deprecated and has no function.

4810

enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

4811

modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

4812

Allowed values

4813

fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.

4814

fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.

4815

fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.

4816

noChange - Maintain the previous value of modifiedDate.

4817

now - Set modifiedDate to the current time.

4818

nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4819

newRevision: boolean, 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4820

ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

4821

ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4822

pinned: boolean, 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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4823

removeParents: string, Comma-separated list of parent IDs to remove.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4824

setModifiedDate: boolean, 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4825

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4826

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4827

timedTextLanguage: string, The language of the timed text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4828

timedTextTrackName: string, The timed text track name.

4829

updateViewedDate: boolean, Whether to update the view date after successfully updating the file.

4830

useContentAsIndexableText: boolean, Whether to use the content as indexable text.

4831

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

4832

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4833

4834

Returns:

4835

An object of the form:

4836

4837

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4838

"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.

4839

"appDataContents": True or False, # Whether this file is in the Application Data folder.

4840

"canComment": True or False, # Deprecated: use capabilities/canComment.

4841

"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.

4842

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

4843

"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4844

"canAddFolderFromAnotherDrive": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4845

"canAddMyDriveParent": True or False, # 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.

4846

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

4847

"canChangeRestrictedDownload": True or False, # Deprecated

4848

"canComment": True or False, # Whether the current user can comment on this file.

4849

"canCopy": True or False, # 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.

4850

"canDelete": True or False, # Whether the current user can delete this file.

4851

"canDeleteChildren": True or False, # 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.

4852

"canDownload": True or False, # Whether the current user can download this file.

4853

"canEdit": True or False, # 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.

4854

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.

4855

"canModifyContent": True or False, # Whether the current user can modify the content of this file.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4856

"canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4857

"canMoveChildrenOutOfDrive": True or False, # 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.

4858

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

4859

"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.

4860

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

4861

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4862

"canMoveItemOutOfDrive": True or False, # 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.

4863

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

4864

"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.

4865

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

4866

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

4867

"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

4868

"canReadRevisions": True or False, # 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.

4869

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

4870

"canRemoveChildren": True or False, # 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.

4871

"canRemoveMyDriveParent": True or False, # 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.

4872

"canRename": True or False, # Whether the current user can rename this file.

4873

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

4874

"canTrash": True or False, # Whether the current user can move this file to trash.

4875

"canTrashChildren": True or False, # 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.

4876

"canUntrash": True or False, # Whether the current user can restore this file from trash.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4877

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4878

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

4879

{ # A restriction for accessing the content of the file.

4880

"readOnly": True or False, # Whether the content of the file is read-only.

4881

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

4882

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

4883

"displayName": "A String", # A plain text displayable name for this user.

4884

"emailAddress": "A String", # The email address of the user.

4885

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4886

"kind": "drive#user", # This is always drive#user.

4887

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4888

"picture": { # The user's profile picture.

4889

"url": "A String", # A URL that points to a profile picture of this user.

4890

},

4891

},

4892

"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

4893

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

4894

},

4895

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4896

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

4897

"copyable": True or False, # Deprecated: use capabilities/canCopy.

4898

"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).

4899

"defaultOpenWithLink": "A String", # 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.

4900

"description": "A String", # A short description of the file.

4901

"downloadUrl": "A String", # 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 Google Docs or shortcut files.

4902

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

4903

"editable": True or False, # Deprecated: use capabilities/canEdit.

4904

"embedLink": "A String", # A link for embedding the file.

4905

"etag": "A String", # ETag of the file.

4906

"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.

4907

"exportLinks": { # Links for exporting Google Docs to specific formats.

4908

"a_key": "A String", # A mapping from export format to URL

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4909

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4910

"fileExtension": "A String", # 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 Google Docs or shortcut files.

4911

"fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.

4912

"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is 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. Not populated for items in shared drives.

4913

"fullFileExtension": "A String", # 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 Google Docs or shortcut files.

4914

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

4915

"hasThumbnail": True or False, # 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.

4916

"headRevisionId": "A String", # 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 Google Docs or shortcut files.

4917

"iconLink": "A String", # A link to the file's icon.

4918

"id": "A String", # The ID of the file.

4919

"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

4920

"aperture": 3.14, # The aperture used to create the photo (f-number).

4921

"cameraMake": "A String", # The make of the camera used to create the photo.

4922

"cameraModel": "A String", # The model of the camera used to create the photo.

4923

"colorSpace": "A String", # The color space of the photo.

4924

"date": "A String", # The date and time the photo was taken (EXIF format timestamp).

4925

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

4926

"exposureMode": "A String", # The exposure mode used to create the photo.

4927

"exposureTime": 3.14, # The length of the exposure, in seconds.

4928

"flashUsed": True or False, # Whether a flash was used to create the photo.

4929

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

4930

"height": 42, # The height of the image in pixels.

4931

"isoSpeed": 42, # The ISO speed used to create the photo.

4932

"lens": "A String", # The lens used to create the photo.

4933

"location": { # Geographic location information stored in the image.

4934

"altitude": 3.14, # The altitude stored in the image.

4935

"latitude": 3.14, # The latitude stored in the image.

4936

"longitude": 3.14, # The longitude stored in the image.

4937

},

4938

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

4939

"meteringMode": "A String", # The metering mode used to create the photo.

4940

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

4941

"sensor": "A String", # The type of sensor used to create the photo.

4942

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

4943

"whiteBalance": "A String", # The white balance mode used to create the photo.

4944

"width": 42, # The width of the image in pixels.

4945

},

4946

"indexableText": { # Indexable text attributes for the file (can only be written)

4947

"text": "A String", # The text to be indexed for this file.

4948

},

4949

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

4950

"kind": "drive#file", # The type of file. This is always drive#file.

4951

"labels": { # A group of labels for the file.

4952

"hidden": True or False, # Deprecated.

4953

"modified": True or False, # Whether the file has been modified by this user.

4954

"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.

4955

"starred": True or False, # Whether this file is starred by the user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4956

"trashed": True or False, # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4957

"viewed": True or False, # Whether this file has been viewed by this user.

4958

},

4959

"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.

4960

"displayName": "A String", # A plain text displayable name for this user.

4961

"emailAddress": "A String", # The email address of the user.

4962

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4963

"kind": "drive#user", # This is always drive#user.

4964

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4965

"picture": { # The user's profile picture.

4966

"url": "A String", # A URL that points to a profile picture of this user.

4967

},

4968

},

4969

"lastModifyingUserName": "A String", # Name of the last user to modify this file.

4970

"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).

4971

"markedViewedByMeDate": "A String", # Deprecated.

4972

"md5Checksum": "A String", # 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 Google Docs or shortcut files.

4973

"mimeType": "A String", # 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.

4974

"modifiedByMeDate": "A String", # 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.

4975

"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

4976

"openWithLinks": { # 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.

4977

"a_key": "A String",

4978

},

4979

"originalFilename": "A String", # 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.

4980

"ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.

4981

"ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.

4982

"A String",

4983

],

4984

"owners": [ # The owner(s) of this file. Not populated for items in shared drives.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4985

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4986

"displayName": "A String", # A plain text displayable name for this user.

4987

"emailAddress": "A String", # The email address of the user.

4988

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

4989

"kind": "drive#user", # This is always drive#user.

4990

"permissionId": "A String", # The user's ID as visible in the permissions collection.

4991

"picture": { # The user's profile picture.

4992

"url": "A String", # A URL that points to a profile picture of this user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4993

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

4994

},

4995

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4996

"parents": [ # Collection of parent folders which contain this file.

4997

# If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.

4998

{ # A reference to a file's parent.

4999

"id": "A String", # The ID of the parent.

5000

"isRoot": True or False, # Whether or not the parent is the root folder.

5001

"kind": "drive#parentReference", # This is always drive#parentReference.

5002

"parentLink": "A String", # A link to the parent.

5003

"selfLink": "A String", # A link back to this reference.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5004

},

5005

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5006

"permissionIds": [ # List of permission IDs for users with access to this file.

5007

"A String",

5008

],

5009

"permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.

5010

{ # A permission for a file.

5011

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

5012

"A String",

5013

],

5014

"authKey": "A String", # Deprecated.

5015

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

5016

"domain": "A String", # 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.

5017

"emailAddress": "A String", # 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.

5018

"etag": "A String", # The ETag of the permission.

5019

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

5020

# - They cannot be set on shared drive items

5021

# - They can only be set on user and group permissions

5022

# - The date must be in the future

5023

# - The date cannot be more than a year in the future

5024

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

5025

"id": "A String", # 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.

5026

"kind": "drive#permission", # This is always drive#permission.

5027

"name": "A String", # The name for this permission.

5028

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

5029

{

5030

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

5031

"A String",

5032

],

5033

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

5034

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

5035

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

5036

# - file

5037

# - member

5038

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

5046

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

# - owner

# - organizer

# - fileOrganizer

# - writer

# - reader

"selfLink": "A String", # A link back to this permission.

5053

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

5054

{

5055

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

5056

"A String",

5057

],

5058

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

5059

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

5060

"role": "A String", # Deprecated - use permissionDetails/role instead.

5061

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

5062

},

5063

],

5064

"type": "A String", # The account type. Allowed values are:

# - user

# - group

# - domain

# - anyone

"value": "A String", # 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.

5070

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5071

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5072

],

5073

"properties": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

5074

{ # A key-value pair attached to a file that is either public or private to an application.

5075

# The following limits apply to file properties:

5076

# - Maximum of 100 properties total per file

5077

# - Maximum of 30 private properties per app

5078

# - Maximum of 30 public properties

5079

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5080

"etag": "A String", # ETag of the property.

5081

"key": "A String", # The key of this property.

5082

"kind": "drive#property", # This is always drive#property.

5083

"selfLink": "A String", # The link back to this property.

5084

"value": "A String", # The value of this property.

5085

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5086

},

5087

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5088

"quotaBytesUsed": "A String", # The number of quota bytes used by this file.

5089

"selfLink": "A String", # A link back to this file.

5090

"shareable": True or False, # Deprecated: use capabilities/canShare.

5091

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

5092

"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).

5093

"sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.

5094

"displayName": "A String", # A plain text displayable name for this user.

5095

"emailAddress": "A String", # The email address of the user.

5096

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

5097

"kind": "drive#user", # This is always drive#user.

5098

"permissionId": "A String", # The user's ID as visible in the permissions collection.

5099

"picture": { # The user's profile picture.

5100

"url": "A String", # A URL that points to a profile picture of this user.

5101

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

5102

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5103

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

5104

"targetId": "A String", # The ID of the file that this shortcut points to.

5105

"targetMimeType": "A String", # 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.

5106

},

5107

"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.

5108

"A String",

5109

],

5110

"teamDriveId": "A String", # Deprecated - use driveId instead.

5111

"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.

5112

"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.

5113

"mimeType": "A String", # The MIME type of the thumbnail.

5114

},

5115

"thumbnailLink": "A String", # 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.

5116

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

5117

"title": "A String", # 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.

5118

"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.

5119

"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

5120

"displayName": "A String", # A plain text displayable name for this user.

5121

"emailAddress": "A String", # The email address of the user.

5122

"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.

5123

"kind": "drive#user", # This is always drive#user.

5124

"permissionId": "A String", # The user's ID as visible in the permissions collection.

5125

"picture": { # The user's profile picture.

5126

"url": "A String", # A URL that points to a profile picture of this user.

5127

},

5128

},

5129

"userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.

5130

"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

5131

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5132

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5133

"authKey": "A String", # Deprecated.

5134

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

5135

"domain": "A String", # 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.

5136

"emailAddress": "A String", # 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.

5137

"etag": "A String", # The ETag of the permission.

5138

"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5139

# - They cannot be set on shared drive items

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5140

# - They can only be set on user and group permissions

5141

# - The date must be in the future

5142

# - The date cannot be more than a year in the future

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5143

# - The date can only be set on drive.permissions.update or drive.permissions.patch requests

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5144

"id": "A String", # 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.

5145

"kind": "drive#permission", # This is always drive#permission.

5146

"name": "A String", # The name for this permission.

5147

"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

5148

{

5149

"additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.

5150

"A String",

5151

],

5152

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

5153

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

5154

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

5155

# - file

5156

# - member

5157

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

# - organizer

# - fileOrganizer

# - writer

# - reader

},

],

"photoLink": "A String", # A link to the profile photo, if available.

5165

"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5166

# - owner

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5167

# - organizer

5168

# - fileOrganizer

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5169

# - writer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5170

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5171

"selfLink": "A String", # A link back to this permission.

5172

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

5173

{

5174

"additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.

5175

"A String",

5176

],

5177

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

5178

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

5179

"role": "A String", # Deprecated - use permissionDetails/role instead.

5180

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

5181

},

5182

],

5183

"type": "A String", # The account type. Allowed values are:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

# - user

# - group

# - domain

# - anyone

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5188

"value": "A String", # 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.

5189

"withLink": True or False, # Whether the link is required for this permission.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5190

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5191

"version": "A String", # 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.

5192

"videoMediaMetadata": { # Metadata about video media. This will only be present for video types.

5193

"durationMillis": "A String", # The duration of the video in milliseconds.

5194

"height": 42, # The height of the video in pixels.

5195

"width": 42, # The width of the video in pixels.

5196

},

5197

"webContentLink": "A String", # 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.

5198

"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.

5199

"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5204

<code class="details" id="watch">watch(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5205

<pre>Subscribe to changes on a file

5206

5207

Args:

5208

fileId: string, The ID for the file in question. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5209

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5210

The object takes the form of:

5211

5212

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5213

"address": "A String", # The address where notifications are delivered for this channel.

5214

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

5215

"id": "A String", # A UUID or similar unique string that identifies this channel.

5216

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

5217

"params": { # Additional parameters controlling delivery channel behavior. Optional.

5218

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5219

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5220

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

5221

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

5222

"resourceUri": "A String", # A version-specific identifier for the watched resource.

5223

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

5224

"type": "A String", # The type of delivery mechanism used for this channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5225

}

5226

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5227

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5228

projection: string, This parameter is deprecated and has no function.

5229

Allowed values

5230

BASIC - Deprecated

5231

FULL - Deprecated

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

5232

revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5233

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5234

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5235

updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5236

5237

Returns:

5238

An object of the form:

5239

5240

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5241

"address": "A String", # The address where notifications are delivered for this channel.

5242

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

5243

"id": "A String", # A UUID or similar unique string that identifies this channel.

5244

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

5245

"params": { # Additional parameters controlling delivery channel behavior. Optional.

5246

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

5247

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5248

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

5249

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

5250

"resourceUri": "A String", # A version-specific identifier for the watched resource.

5251

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

5252

"type": "A String", # The type of delivery mechanism used for this channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5256

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5257

<code class="details" id="watch_media">watch_media(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5258

<pre>Subscribe to changes on a file

5259

5260

Args:

5261

fileId: string, The ID for the file in question. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5262

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5263

The object takes the form of:

5264

5265

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5266

"address": "A String", # The address where notifications are delivered for this channel.

5267

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

5268

"id": "A String", # A UUID or similar unique string that identifies this channel.

5269

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

5270

"params": { # Additional parameters controlling delivery channel behavior. Optional.

5271

"a_key": "A String", # Declares a new parameter by name.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5273

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

5274

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

5275

"resourceUri": "A String", # A version-specific identifier for the watched resource.

5276

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

5277

"type": "A String", # The type of delivery mechanism used for this channel.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5278

}

5279

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5280

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

5281

projection: string, This parameter is deprecated and has no function.

5282

Allowed values

5283

BASIC - Deprecated

5284

FULL - Deprecated

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

5285

revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5286

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5287

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5288

updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Craig Citro