Blame - docs/dyn/drive_v3.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 a file and applies any requested updates with patch semantics. Folders cannot be copied.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

80

Bu Sun Kim

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

[diff] [blame]

81

<code><a href="#create">create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

82

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

83

Bu Sun Kim

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

[diff] [blame]

84

<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]

85

<p class="firstline">Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

86

87

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

88

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

89

90

<code><a href="#export">export(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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

92

93

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

Bu Sun Kim

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

[diff] [blame]

94

<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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

95

96

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

Dan O'Meara

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

[diff] [blame]

97

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

98

Bu Sun Kim

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

[diff] [blame]

99

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

103

<p class="firstline">Gets a file's metadata or content by ID.</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, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

106

<p class="firstline">Lists or searches 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="#update">update(fileId, body=None, addParents=None, enforceSingleParent=None, keepRevisionForever=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame^]

112

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

113

Bu Sun Kim

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

[diff] [blame]

114

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

115

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

116

Bu Sun Kim

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

[diff] [blame]

117

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

118

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

119

<h3>Method Details</h3>

120

Bu Sun Kim

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

[diff] [blame]

121

<code class="details" id="copy">copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)</code>

Bu Sun Kim

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

[diff] [blame^]

122

<pre>Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

123

124

Args:

125

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

Dan O'Meara

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

[diff] [blame]

126

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

127

The object takes the form of:

128

129

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

130

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

131

# Entries with null values are cleared in update and copy requests.

132

"a_key": "A String",

133

},

134

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

135

"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^]

136

"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]

137

"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.

138

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

139

"canChangeViewersCanCopyContent": True or False, # Deprecated

140

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

141

"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.

142

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

143

"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.

144

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

145

"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.

146

"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.

147

"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^]

148

"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]

149

"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.

150

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

151

"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.

152

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

153

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

154

"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.

155

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

156

"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.

157

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

158

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

159

"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.

160

"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.

161

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

162

"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.

163

"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.

164

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

165

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

166

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

167

"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.

168

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

169

},

170

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

171

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

172

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

173

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

174

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

175

},

176

},

Bu Sun Kim

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

[diff] [blame^]

177

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

178

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

179

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

180

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

181

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

182

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

183

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

184

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

185

"me": True or False, # Whether this user is the requesting user.

186

"permissionId": "A String", # The user's ID as visible in Permission resources.

187

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

188

},

189

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

190

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

191

},

192

],

Bu Sun Kim

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

[diff] [blame]

193

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

194

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

195

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

196

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

197

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

198

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

199

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

200

},

201

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

202

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

203

# If an unsupported color is specified, the closest color in the palette will be used instead.

204

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

205

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

206

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

207

"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.

208

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

209

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

210

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

211

"imageMediaMetadata": { # Additional metadata about image media, if available.

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

},

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

},

238

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

239

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

240

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

241

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

242

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

243

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

244

"me": True or False, # Whether this user is the requesting user.

245

"permissionId": "A String", # The user's ID as visible in Permission resources.

246

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

247

},

248

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

249

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

Bu Sun Kim

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

[diff] [blame]

250

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

251

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

252

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

253

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

254

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

255

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

256

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

257

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

258

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

259

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

260

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

261

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

262

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

263

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

264

"me": True or False, # Whether this user is the requesting user.

265

"permissionId": "A String", # The user's ID as visible in Permission resources.

266

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

267

},

268

],

Bu Sun Kim

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

[diff] [blame]

269

"parents": [ # The IDs of the parent folders which contain the file.

270

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

271

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

272

],

Bu Sun Kim

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

[diff] [blame]

273

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

274

"A String",

Bu Sun Kim

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

[diff] [blame]

275

],

Bu Sun Kim

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

[diff] [blame]

276

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

277

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

278

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

279

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

280

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

281

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

282

# - group - Name of the Google Group, such as "The Company Administrators."

283

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

284

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

285

"domain": "A String", # The domain to which this permission refers.

286

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

287

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

288

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

289

# - The time must be in the future

290

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

291

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

292

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

293

"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.

Bu Sun Kim

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

[diff] [blame]

294

{

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

297

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

298

# - file

299

# - member

300

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

Bu Sun Kim

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

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

306

},

307

],

Bu Sun Kim

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

[diff] [blame]

308

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

309

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

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

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

316

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

317

{

318

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

319

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

320

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

321

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

322

},

323

],

324

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

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

[diff] [blame]

325

# - user

326

# - group

327

# - domain

Bu Sun Kim

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

[diff] [blame]

328

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

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

[diff] [blame]

329

},

330

],

Bu Sun Kim

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

[diff] [blame]

331

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

332

# Entries with null values are cleared in update and copy requests.

333

"a_key": "A String",

334

},

335

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

336

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

337

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

338

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

339

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

340

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

341

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

342

"me": True or False, # Whether this user is the requesting user.

343

"permissionId": "A String", # The user's ID as visible in Permission resources.

344

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

345

},

346

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

347

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

348

"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.

349

},

350

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

351

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

352

"A String",

353

],

354

"starred": True or False, # Whether the user has starred the file.

355

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

356

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

357

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

Bu Sun Kim

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

[diff] [blame^]

358

"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]

359

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

360

"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.

361

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

362

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

363

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

364

"me": True or False, # Whether this user is the requesting user.

365

"permissionId": "A String", # The user's ID as visible in Permission resources.

366

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

367

},

368

"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 user.

369

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

370

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

371

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

372

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

373

},

374

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

375

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

376

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

377

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

378

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

379

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

380

}

381

Dan O'Meara

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

[diff] [blame]

382

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

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

[diff] [blame]

383

ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

384

keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

Dan O'Meara

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

[diff] [blame]

385

ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

Bu Sun Kim

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

[diff] [blame^]

386

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]

387

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

388

389

Returns:

390

An object of the form:

391

392

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

393

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

394

# Entries with null values are cleared in update and copy requests.

395

"a_key": "A String",

396

},

397

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

398

"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^]

399

"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]

400

"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.

401

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

402

"canChangeViewersCanCopyContent": True or False, # Deprecated

403

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

404

"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.

405

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

406

"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.

407

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

408

"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.

409

"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.

410

"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^]

411

"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]

412

"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.

413

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

414

"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.

415

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

416

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

417

"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.

418

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

419

"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.

420

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

421

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

422

"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.

423

"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.

424

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

425

"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.

426

"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.

427

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

428

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

429

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

430

"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.

431

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

432

},

433

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

434

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

435

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

436

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

437

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

438

},

439

},

Bu Sun Kim

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

[diff] [blame^]

440

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

441

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

442

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

443

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

444

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

445

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

446

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

447

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

448

"me": True or False, # Whether this user is the requesting user.

449

"permissionId": "A String", # The user's ID as visible in Permission resources.

450

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

451

},

452

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

453

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

454

},

455

],

Bu Sun Kim

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

[diff] [blame]

456

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

457

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

458

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

459

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

460

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

461

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

462

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

463

},

464

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

465

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

466

# If an unsupported color is specified, the closest color in the palette will be used instead.

467

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

468

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

469

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

470

"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.

471

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

472

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

473

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

474

"imageMediaMetadata": { # Additional metadata about image media, if available.

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

},

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

},

501

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

502

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

503

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

504

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

505

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

506

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

507

"me": True or False, # Whether this user is the requesting user.

508

"permissionId": "A String", # The user's ID as visible in Permission resources.

509

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

510

},

511

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

512

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

Bu Sun Kim

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

[diff] [blame]

513

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

514

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

515

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

516

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

517

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

518

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

519

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

520

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

521

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

522

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

523

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

524

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

525

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

526

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

527

"me": True or False, # Whether this user is the requesting user.

528

"permissionId": "A String", # The user's ID as visible in Permission resources.

529

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

530

},

531

],

Bu Sun Kim

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

[diff] [blame]

532

"parents": [ # The IDs of the parent folders which contain the file.

533

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

534

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

535

],

Bu Sun Kim

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

[diff] [blame]

536

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

537

"A String",

Bu Sun Kim

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

[diff] [blame]

538

],

Bu Sun Kim

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

[diff] [blame]

539

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

540

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

541

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

542

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

543

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

544

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

545

# - group - Name of the Google Group, such as "The Company Administrators."

546

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

547

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

548

"domain": "A String", # The domain to which this permission refers.

549

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

550

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

551

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

552

# - The time must be in the future

553

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

554

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

555

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

556

"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.

Bu Sun Kim

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

[diff] [blame]

557

{

Bu Sun Kim

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

[diff] [blame]

558

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

559

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

560

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

561

# - file

562

# - member

563

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

Bu Sun Kim

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

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

569

},

570

],

Bu Sun Kim

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

[diff] [blame]

571

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

572

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

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

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

579

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

580

{

581

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

582

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

583

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

584

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

585

},

586

],

587

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

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

[diff] [blame]

588

# - user

589

# - group

590

# - domain

Bu Sun Kim

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

[diff] [blame]

591

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

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

[diff] [blame]

592

},

593

],

Bu Sun Kim

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

[diff] [blame]

594

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

595

# Entries with null values are cleared in update and copy requests.

596

"a_key": "A String",

597

},

598

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

599

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

600

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

601

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

602

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

603

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

604

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

605

"me": True or False, # Whether this user is the requesting user.

606

"permissionId": "A String", # The user's ID as visible in Permission resources.

607

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

608

},

609

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

610

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

611

"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.

612

},

613

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

614

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

615

"A String",

616

],

617

"starred": True or False, # Whether the user has starred the file.

618

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

619

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

620

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

Bu Sun Kim

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

[diff] [blame^]

621

"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]

622

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

623

"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.

624

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

625

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

626

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

627

"me": True or False, # Whether this user is the requesting user.

628

"permissionId": "A String", # The user's ID as visible in Permission resources.

629

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

630

},

631

"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 user.

632

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

633

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

634

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

635

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

636

},

637

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

638

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

639

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

640

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

641

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

642

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

647

<code class="details" id="create">create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

648

<pre>Creates a new file.

649

650

Args:

651

body: object, The request body.

652

The object takes the form of:

653

654

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

655

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

656

# Entries with null values are cleared in update and copy requests.

657

"a_key": "A String",

658

},

659

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

660

"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^]

661

"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]

662

"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.

663

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

664

"canChangeViewersCanCopyContent": True or False, # Deprecated

665

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

666

"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.

667

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

668

"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.

669

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

670

"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.

671

"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.

672

"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^]

673

"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]

674

"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.

675

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

676

"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.

677

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

678

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

679

"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.

680

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

681

"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.

682

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

683

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

684

"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.

685

"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.

686

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

687

"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.

688

"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.

689

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

690

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

691

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

692

"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.

693

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

694

},

695

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

696

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

697

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

698

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

699

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

700

},

701

},

Bu Sun Kim

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

[diff] [blame^]

702

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

703

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

704

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

705

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

706

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

707

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

708

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

709

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

710

"me": True or False, # Whether this user is the requesting user.

711

"permissionId": "A String", # The user's ID as visible in Permission resources.

712

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

713

},

714

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

715

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

716

},

717

],

Bu Sun Kim

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

[diff] [blame]

718

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

719

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

720

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

721

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

722

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

723

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

724

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

725

},

726

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

727

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

728

# If an unsupported color is specified, the closest color in the palette will be used instead.

729

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

730

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

731

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

732

"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.

733

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

734

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

735

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

736

"imageMediaMetadata": { # Additional metadata about image media, if available.

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

},

754

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

755

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

756

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

757

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

758

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

759

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

760

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

761

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

762

},

763

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

764

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

765

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

766

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

767

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

768

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

769

"me": True or False, # Whether this user is the requesting user.

770

"permissionId": "A String", # The user's ID as visible in Permission resources.

771

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

772

},

773

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

774

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

Bu Sun Kim

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

[diff] [blame]

775

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

776

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

777

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

778

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

779

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

780

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

781

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

782

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

783

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

784

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

785

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

786

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

787

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

788

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

789

"me": True or False, # Whether this user is the requesting user.

790

"permissionId": "A String", # The user's ID as visible in Permission resources.

791

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

792

},

793

],

Bu Sun Kim

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

[diff] [blame]

794

"parents": [ # The IDs of the parent folders which contain the file.

795

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

796

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

797

],

Bu Sun Kim

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

[diff] [blame]

798

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

799

"A String",

Bu Sun Kim

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

[diff] [blame]

800

],

Bu Sun Kim

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

[diff] [blame]

801

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

802

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

803

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

804

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

805

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

806

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

807

# - group - Name of the Google Group, such as "The Company Administrators."

808

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

809

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

810

"domain": "A String", # The domain to which this permission refers.

811

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

812

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

813

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

814

# - The time must be in the future

815

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

816

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

817

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

818

"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.

Bu Sun Kim

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

[diff] [blame]

819

{

Bu Sun Kim

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

[diff] [blame]

820

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

821

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

822

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

823

# - file

824

# - member

825

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

Bu Sun Kim

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

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

831

},

832

],

Bu Sun Kim

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

[diff] [blame]

833

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

834

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

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

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

841

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

842

{

843

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

844

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

845

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

846

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

847

},

848

],

849

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

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

[diff] [blame]

850

# - user

851

# - group

852

# - domain

Bu Sun Kim

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

[diff] [blame]

853

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

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

[diff] [blame]

854

},

855

],

Bu Sun Kim

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

[diff] [blame]

856

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

857

# Entries with null values are cleared in update and copy requests.

858

"a_key": "A String",

859

},

860

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

861

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

862

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

863

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

864

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

865

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

866

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

867

"me": True or False, # Whether this user is the requesting user.

868

"permissionId": "A String", # The user's ID as visible in Permission resources.

869

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

870

},

871

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

872

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

873

"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.

874

},

875

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

876

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

877

"A String",

878

],

879

"starred": True or False, # Whether the user has starred the file.

880

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

881

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

882

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

Bu Sun Kim

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

[diff] [blame^]

883

"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]

884

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

885

"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.

886

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

887

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

888

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

889

"me": True or False, # Whether this user is the requesting user.

890

"permissionId": "A String", # The user's ID as visible in Permission resources.

891

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

892

},

893

"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 user.

894

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

895

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

896

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

897

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

898

},

899

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

900

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

901

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

902

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

903

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

904

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

905

}

906

Dan O'Meara

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

[diff] [blame]

907

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

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

[diff] [blame]

908

ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

909

keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

910

ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

Bu Sun Kim

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

[diff] [blame^]

911

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]

912

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

913

useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.

914

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Bu Sun Kim

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

[diff] [blame]

915

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

916

917

Returns:

918

An object of the form:

919

920

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

921

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

922

# Entries with null values are cleared in update and copy requests.

923

"a_key": "A String",

924

},

925

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

926

"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^]

927

"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]

928

"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.

929

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

930

"canChangeViewersCanCopyContent": True or False, # Deprecated

931

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

932

"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.

933

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

934

"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.

935

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

936

"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.

937

"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.

938

"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^]

939

"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]

940

"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.

941

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

942

"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.

943

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

944

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

945

"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.

946

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

947

"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.

948

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

949

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

950

"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.

951

"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.

952

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

953

"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.

954

"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.

955

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

956

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

957

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

958

"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.

959

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

960

},

961

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

962

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

963

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

964

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

965

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

966

},

967

},

Bu Sun Kim

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

[diff] [blame^]

968

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

969

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

970

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

971

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

972

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

973

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

974

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

975

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

976

"me": True or False, # Whether this user is the requesting user.

977

"permissionId": "A String", # The user's ID as visible in Permission resources.

978

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

979

},

980

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

981

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

982

},

983

],

Bu Sun Kim

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

[diff] [blame]

984

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

985

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

986

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

987

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

988

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

989

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

990

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

991

},

992

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

993

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

994

# If an unsupported color is specified, the closest color in the palette will be used instead.

995

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

996

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

997

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

998

"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.

999

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

1000

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

1001

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

1002

"imageMediaMetadata": { # Additional metadata about image media, if available.

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

},

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

},

1029

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

1030

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

1031

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

1032

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

1033

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1034

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1035

"me": True or False, # Whether this user is the requesting user.

1036

"permissionId": "A String", # The user's ID as visible in Permission resources.

1037

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

1038

},

1039

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1042

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

1043

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

1044

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

1045

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1046

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

1047

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

1048

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

1049

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

1050

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1051

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1054

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1055

"me": True or False, # Whether this user is the requesting user.

1056

"permissionId": "A String", # The user's ID as visible in Permission resources.

1057

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1058

},

1059

],

Bu Sun Kim

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

[diff] [blame]

1060

"parents": [ # The IDs of the parent folders which contain the file.

1061

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

1062

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1063

],

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

"A String",

Bu Sun Kim

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

[diff] [blame]

1066

],

Bu Sun Kim

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

[diff] [blame]

1067

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

1068

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

1069

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

1070

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

1071

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

1072

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

1073

# - group - Name of the Google Group, such as "The Company Administrators."

1074

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

1075

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

1076

"domain": "A String", # The domain to which this permission refers.

1077

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

1078

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

1079

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

1080

# - The time must be in the future

1081

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

1082

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

1083

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

1084

"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.

Bu Sun Kim

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

[diff] [blame]

1085

{

Bu Sun Kim

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

[diff] [blame]

1086

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

1087

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

1088

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

1089

# - file

1090

# - member

1091

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

Bu Sun Kim

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

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

1097

},

1098

],

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

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

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

{

1109

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

1110

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

1111

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

1112

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

1113

},

1114

],

1115

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

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

[diff] [blame]

1116

# - user

1117

# - group

1118

# - domain

Bu Sun Kim

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

[diff] [blame]

1119

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

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

[diff] [blame]

1120

},

1121

],

Bu Sun Kim

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

[diff] [blame]

1122

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

1123

# Entries with null values are cleared in update and copy requests.

1124

"a_key": "A String",

1125

},

1126

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

1127

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

1128

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

1129

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

1130

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

1131

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1132

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1133

"me": True or False, # Whether this user is the requesting user.

1134

"permissionId": "A String", # The user's ID as visible in Permission resources.

1135

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

1136

},

1137

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

1138

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

1139

"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.

1140

},

1141

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

1142

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

1143

"A String",

1144

],

1145

"starred": True or False, # Whether the user has starred the file.

1146

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

1147

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

1148

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

Bu Sun Kim

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

[diff] [blame^]

1149

"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]

1150

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

1151

"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.

1152

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

1153

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1154

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1155

"me": True or False, # Whether this user is the requesting user.

1156

"permissionId": "A String", # The user's ID as visible in Permission resources.

1157

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

1158

},

1159

"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 user.

1160

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

1161

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

1162

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

1163

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

1164

},

1165

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

1166

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

1167

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

1168

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

1169

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

1170

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1175

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

Bu Sun Kim

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

[diff] [blame]

1176

<pre>Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1177

1178

Args:

1179

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

Bu Sun Kim

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

[diff] [blame^]

1180

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]

1181

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1187

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

Args:

</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1195

<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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1196

1197

Args:

1198

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

1199

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]

1205

<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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1206

1207

Args:

1208

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

1209

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

</pre>

</div>

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

Dan O'Meara

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

[diff] [blame]

1215

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1216

1217

Args:

1218

count: integer, The number of IDs to return.

Bu Sun Kim

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

[diff] [blame]

1219

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1220

1221

Returns:

1222

An object of the form:

1223

1224

{ # A list of generated file IDs which can be provided in create requests.

Bu Sun Kim

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

[diff] [blame]

1225

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

1226

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1227

],

Bu Sun Kim

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

[diff] [blame]

1228

"kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".

1229

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1234

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

1235

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1236

1237

Args:

1238

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

1239

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Bu Sun Kim

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

[diff] [blame^]

1240

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]

1241

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1242

1243

Returns:

1244

An object of the form:

1245

1246

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

1247

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

1248

# Entries with null values are cleared in update and copy requests.

1249

"a_key": "A String",

1250

},

1251

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

1252

"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^]

1253

"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]

1254

"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.

1255

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

1256

"canChangeViewersCanCopyContent": True or False, # Deprecated

1257

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

1258

"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.

1259

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

1260

"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.

1261

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

1262

"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.

1263

"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.

1264

"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^]

1265

"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]

1266

"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.

1267

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

1268

"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.

1269

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

1270

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

1271

"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.

1272

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

1273

"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.

1274

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

1275

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

1276

"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.

1277

"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.

1278

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

1279

"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.

1280

"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.

1281

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

1282

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

1283

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

1284

"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.

1285

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

1286

},

1287

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

1288

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

1289

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

1290

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

1291

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

1292

},

1293

},

Bu Sun Kim

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

[diff] [blame^]

1294

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

1295

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

1296

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

1297

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

1298

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

1299

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

1300

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1301

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1302

"me": True or False, # Whether this user is the requesting user.

1303

"permissionId": "A String", # The user's ID as visible in Permission resources.

1304

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

1305

},

1306

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

1307

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

1308

},

1309

],

Bu Sun Kim

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

[diff] [blame]

1310

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

1311

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

1312

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

1313

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

1314

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

1315

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

1316

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

1317

},

1318

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

1319

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

1320

# If an unsupported color is specified, the closest color in the palette will be used instead.

1321

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

1322

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

1323

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

1324

"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.

1325

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

1326

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

1327

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

1328

"imageMediaMetadata": { # Additional metadata about image media, if available.

1329

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

1330

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

1331

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

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

},

1346

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

1347

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

1348

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

1349

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

1350

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

1351

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

1352

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

1353

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

1354

},

1355

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

1356

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

1357

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

1358

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

1359

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1360

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1361

"me": True or False, # Whether this user is the requesting user.

1362

"permissionId": "A String", # The user's ID as visible in Permission resources.

1363

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

1364

},

1365

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

1366

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

Bu Sun Kim

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

[diff] [blame]

1367

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1368

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

1369

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

1370

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

1371

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1372

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

1373

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

1374

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

1375

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

1376

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1377

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

1378

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

1379

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1380

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1381

"me": True or False, # Whether this user is the requesting user.

1382

"permissionId": "A String", # The user's ID as visible in Permission resources.

1383

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1384

},

1385

],

Bu Sun Kim

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

[diff] [blame]

1386

"parents": [ # The IDs of the parent folders which contain the file.

1387

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

1388

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1389

],

Bu Sun Kim

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

[diff] [blame]

1390

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

1391

"A String",

Bu Sun Kim

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

[diff] [blame]

1392

],

Bu Sun Kim

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

[diff] [blame]

1393

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

1394

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

1395

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

1396

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

1397

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

1398

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

1399

# - group - Name of the Google Group, such as "The Company Administrators."

1400

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

1401

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

1402

"domain": "A String", # The domain to which this permission refers.

1403

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

1404

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

1405

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

1406

# - The time must be in the future

1407

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

1408

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

1409

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

1410

"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.

Bu Sun Kim

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

[diff] [blame]

1411

{

Bu Sun Kim

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

[diff] [blame]

1412

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

1413

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

1414

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

1415

# - file

1416

# - member

1417

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

Bu Sun Kim

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

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

1423

},

1424

],

Bu Sun Kim

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

[diff] [blame]

1425

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

1426

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

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

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

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

[diff] [blame]

1433

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

1434

{

1435

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

1436

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

1437

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

1438

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

1439

},

1440

],

1441

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

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

[diff] [blame]

1442

# - user

1443

# - group

1444

# - domain

Bu Sun Kim

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

[diff] [blame]

1445

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

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

[diff] [blame]

1446

},

1447

],

Bu Sun Kim

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

[diff] [blame]

1448

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

1449

# Entries with null values are cleared in update and copy requests.

1450

"a_key": "A String",

1451

},

1452

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

1453

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

1454

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

1455

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

1456

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

1457

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1458

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1459

"me": True or False, # Whether this user is the requesting user.

1460

"permissionId": "A String", # The user's ID as visible in Permission resources.

1461

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

1462

},

1463

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

1464

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

1465

"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.

1466

},

1467

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

1468

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

1469

"A String",

1470

],

1471

"starred": True or False, # Whether the user has starred the file.

1472

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

1473

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

1474

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

Bu Sun Kim

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

[diff] [blame^]

1475

"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]

1476

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

1477

"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.

1478

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

1479

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1480

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1481

"me": True or False, # Whether this user is the requesting user.

1482

"permissionId": "A String", # The user's ID as visible in Permission resources.

1483

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

1484

},

1485

"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 user.

1486

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

1487

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

1488

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

1489

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

1490

},

1491

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

1492

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

1493

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

1494

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

1495

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

1496

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1501

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

1502

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1503

1504

Args:

1505

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

1506

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Bu Sun Kim

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

[diff] [blame^]

1507

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]

1508

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1509

1510

Returns:

1511

The media object as a string.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1517

<code class="details" id="list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1518

<pre>Lists or searches files.

1519

1520

Args:

Bu Sun Kim

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

[diff] [blame^]

1521

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]

1522

corpus: string, The source of files to list. Deprecated: use 'corpora' instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1523

Allowed values

Bu Sun Kim

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

[diff] [blame]

1524

domain - Files shared to the user's domain.

Bu Sun Kim

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

[diff] [blame^]

1525

user - Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file.

Bu Sun Kim

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

[diff] [blame]

1526

driveId: string, ID of the shared drive to search.

Bu Sun Kim

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

[diff] [blame^]

1527

includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.

Bu Sun Kim

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

[diff] [blame]

1528

includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.

Bu Sun Kim

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

[diff] [blame]

1529

orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

1530

pageSize: 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.

1531

pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

1532

q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.

1533

spaces: string, A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

Bu Sun Kim

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

[diff] [blame^]

1534

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]

1535

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

1536

teamDriveId: string, Deprecated use driveId instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1537

1538

Returns:

1539

An object of the form:

1540

1541

{ # A list of files.

Bu Sun Kim

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

[diff] [blame]

1542

"files": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1543

{ # The metadata for a file.

Bu Sun Kim

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

[diff] [blame]

1544

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

1545

# Entries with null values are cleared in update and copy requests.

1546

"a_key": "A String",

1547

},

1548

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

1549

"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^]

1550

"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]

1551

"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.

1552

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

1553

"canChangeViewersCanCopyContent": True or False, # Deprecated

1554

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

1555

"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.

1556

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

1557

"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.

1558

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

1559

"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.

1560

"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.

1561

"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^]

1562

"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]

1563

"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.

1564

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

1565

"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.

1566

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

1567

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

1568

"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.

1569

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

1570

"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.

1571

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

1572

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

1573

"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.

1574

"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.

1575

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

1576

"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.

1577

"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.

1578

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

1579

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

1580

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

1581

"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.

1582

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

1583

},

1584

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

1585

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

1586

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

1587

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

1588

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

1589

},

1590

},

Bu Sun Kim

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

[diff] [blame^]

1591

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

1592

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

1593

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

1594

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

1595

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

1596

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

1597

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1598

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1599

"me": True or False, # Whether this user is the requesting user.

1600

"permissionId": "A String", # The user's ID as visible in Permission resources.

1601

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

1602

},

1603

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

1604

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

1605

},

1606

],

Bu Sun Kim

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

[diff] [blame]

1607

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

1608

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

1609

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

1610

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

1611

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

1612

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

1613

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

1614

},

1615

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

1616

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

1617

# If an unsupported color is specified, the closest color in the palette will be used instead.

1618

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

1619

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

1620

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

1621

"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.

1622

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

1623

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

1624

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

1625

"imageMediaMetadata": { # Additional metadata about image media, if available.

1626

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

1627

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

1628

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

1629

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

1630

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

1631

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

1632

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

1633

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

1634

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

1635

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

1636

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

1637

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

1638

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

1639

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

1640

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

1641

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

1642

},

1643

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

1644

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

1645

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

1646

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

1647

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

1648

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

1649

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

1650

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

1651

},

1652

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

1653

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

1654

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

1655

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

1656

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1657

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1658

"me": True or False, # Whether this user is the requesting user.

1659

"permissionId": "A String", # The user's ID as visible in Permission resources.

1660

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

1661

},

1662

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

1663

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

Bu Sun Kim

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

[diff] [blame]

1664

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1665

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

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

[diff] [blame]

1666

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

1667

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

1668

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1669

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

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

[diff] [blame]

1670

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

1671

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

1672

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

1673

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1674

{ # Information about a Drive user.

Bu Sun Kim

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

[diff] [blame]

1675

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

1676

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1677

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1678

"me": True or False, # Whether this user is the requesting user.

1679

"permissionId": "A String", # The user's ID as visible in Permission resources.

1680

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1681

},

1682

],

Bu Sun Kim

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

[diff] [blame]

1683

"parents": [ # The IDs of the parent folders which contain the file.

1684

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

1685

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1686

],

Bu Sun Kim

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

[diff] [blame]

1687

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

1688

"A String",

Bu Sun Kim

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

[diff] [blame]

1689

],

Bu Sun Kim

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

[diff] [blame]

1690

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

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

[diff] [blame]

1691

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

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

[diff] [blame]

1692

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

1693

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

1694

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

1695

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

1696

# - group - Name of the Google Group, such as "The Company Administrators."

1697

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

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

[diff] [blame]

1698

# - anyone - No displayName is present.

Bu Sun Kim

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

[diff] [blame]

1699

"domain": "A String", # The domain to which this permission refers.

1700

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

1701

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

1702

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

1703

# - The time must be in the future

1704

# - The time cannot be more than a year in the future

1705

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

1706

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

1707

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1708

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1709

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1710

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1711

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1712

# - file

1713

# - member

1714

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1720

},

1721

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1722

"photoLink": "A String", # A link to the user's profile photo, if available.

1723

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1730

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

1731

{

1732

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

1733

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

1734

"role": "A String", # Deprecated - use permissionDetails/role instead.

1735

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

1736

},

1737

],

1738

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1739

# - user

1740

# - group

1741

# - domain

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1742

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1743

},

1744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1745

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

1746

# Entries with null values are cleared in update and copy requests.

1747

"a_key": "A String",

1748

},

1749

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

1750

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

1751

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

1752

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

1753

"displayName": "A String", # A plain text displayable name for this user.

1754

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1755

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1756

"me": True or False, # Whether this user is the requesting user.

1757

"permissionId": "A String", # The user's ID as visible in Permission resources.

1758

"photoLink": "A String", # A link to the user's profile photo, if available.

1759

},

1760

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

1761

"targetId": "A String", # The ID of the file that this shortcut points to.

1762

"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.

1763

},

1764

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

1765

"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.

1766

"A String",

1767

],

1768

"starred": True or False, # Whether the user has starred the file.

1769

"teamDriveId": "A String", # Deprecated - use driveId instead.

1770

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

1771

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1772

"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]

1773

"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

1774

"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.

1775

"displayName": "A String", # A plain text displayable name for this user.

1776

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1777

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1778

"me": True or False, # Whether this user is the requesting user.

1779

"permissionId": "A String", # The user's ID as visible in Permission resources.

1780

"photoLink": "A String", # A link to the user's profile photo, if available.

1781

},

1782

"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 user.

1783

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

1784

"durationMillis": "A String", # The duration of the video in milliseconds.

1785

"height": 42, # The height of the video in pixels.

1786

"width": 42, # The width of the video in pixels.

1787

},

1788

"viewedByMe": True or False, # Whether the file has been viewed by this user.

1789

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

1790

"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.

1791

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

1792

"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.

1793

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1794

},

1795

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1796

"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 "user" or "drive".

1797

"kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string "drive#fileList".

1798

"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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1804

<pre>Retrieves the next page of results.

1805

1806

Args:

1807

previous_request: The request for the previous page. (required)

1808

previous_response: The response from the request for the previous page. (required)

1809

1810

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1811

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1812

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]

1817

<code class="details" id="update">update(fileId, body=None, addParents=None, enforceSingleParent=None, keepRevisionForever=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1818

<pre>Updates a file's metadata and/or content. This method supports patch semantics.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1819

1820

Args:

1821

fileId: string, The ID of the file. (required)

1822

body: object, The request body.

1823

The object takes the form of:

1824

1825

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

1827

# Entries with null values are cleared in update and copy requests.

1828

"a_key": "A String",

1829

},

1830

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

1831

"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^]

1832

"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]

1833

"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.

1834

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

1835

"canChangeViewersCanCopyContent": True or False, # Deprecated

1836

"canComment": True or False, # Whether the current user can comment on this file.

1837

"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.

1838

"canDelete": True or False, # Whether the current user can delete this file.

1839

"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.

1840

"canDownload": True or False, # Whether the current user can download this file.

1841

"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.

1842

"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.

1843

"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^]

1844

"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]

1845

"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.

1846

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

1847

"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.

1848

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

1849

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1850

"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.

1851

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

1852

"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.

1853

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

1854

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

1855

"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.

1856

"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.

1857

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

1858

"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.

1859

"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.

1860

"canRename": True or False, # Whether the current user can rename this file.

1861

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

1862

"canTrash": True or False, # Whether the current user can move this file to trash.

1863

"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.

1864

"canUntrash": True or False, # Whether the current user can restore this file from trash.

1865

},

1866

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

1867

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

1868

"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.

1869

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

1870

"mimeType": "A String", # The MIME type of the thumbnail.

1871

},

1872

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1873

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

1874

{ # A restriction for accessing the content of the file.

1875

"readOnly": True or False, # Whether the content of the file is read-only.

1876

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

1877

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

1878

"displayName": "A String", # A plain text displayable name for this user.

1879

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1880

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1881

"me": True or False, # Whether this user is the requesting user.

1882

"permissionId": "A String", # The user's ID as visible in Permission resources.

1883

"photoLink": "A String", # A link to the user's profile photo, if available.

1884

},

1885

"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

1886

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

1887

},

1888

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1889

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

1890

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

1891

"description": "A String", # A short description of the file.

1892

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

1893

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

1894

"exportLinks": { # Links for exporting Google Docs to specific formats.

1895

"a_key": "A String", # A mapping from export format to URL

1896

},

1897

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

1898

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

1899

# If an unsupported color is specified, the closest color in the palette will be used instead.

1900

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

1901

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

1902

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

1903

"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.

1904

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

1905

"iconLink": "A String", # A static, unauthenticated link to the file's icon.

1906

"id": "A String", # The ID of the file.

1907

"imageMediaMetadata": { # Additional metadata about image media, if available.

1908

"aperture": 3.14, # The aperture used to create the photo (f-number).

1909

"cameraMake": "A String", # The make of the camera used to create the photo.

1910

"cameraModel": "A String", # The model of the camera used to create the photo.

1911

"colorSpace": "A String", # The color space of the photo.

1912

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

1913

"exposureMode": "A String", # The exposure mode used to create the photo.

1914

"exposureTime": 3.14, # The length of the exposure, in seconds.

1915

"flashUsed": True or False, # Whether a flash was used to create the photo.

1916

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

1917

"height": 42, # The height of the image in pixels.

1918

"isoSpeed": 42, # The ISO speed used to create the photo.

1919

"lens": "A String", # The lens used to create the photo.

1920

"location": { # Geographic location information stored in the image.

1921

"altitude": 3.14, # The altitude stored in the image.

1922

"latitude": 3.14, # The latitude stored in the image.

1923

"longitude": 3.14, # The longitude stored in the image.

1924

},

1925

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

1926

"meteringMode": "A String", # The metering mode used to create the photo.

1927

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

1928

"sensor": "A String", # The type of sensor used to create the photo.

1929

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

1930

"time": "A String", # The date and time the photo was taken (EXIF DateTime).

1931

"whiteBalance": "A String", # The white balance mode used to create the photo.

1932

"width": 42, # The width of the image in pixels.

1933

},

1934

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

1935

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

1936

"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.

1937

"displayName": "A String", # A plain text displayable name for this user.

1938

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1939

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1940

"me": True or False, # Whether this user is the requesting user.

1941

"permissionId": "A String", # The user's ID as visible in Permission resources.

1942

"photoLink": "A String", # A link to the user's profile photo, if available.

1943

},

1944

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

1945

"mimeType": "A String", # The MIME type of the file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1946

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1947

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1948

"modifiedByMe": True or False, # Whether the file has been modified by this user.

1949

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

1950

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1951

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1952

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

1953

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

1954

"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.

1955

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1956

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1957

"displayName": "A String", # A plain text displayable name for this user.

1958

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

1959

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

1960

"me": True or False, # Whether this user is the requesting user.

1961

"permissionId": "A String", # The user's ID as visible in Permission resources.

1962

"photoLink": "A String", # A link to the user's profile photo, if available.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1963

},

1964

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1965

"parents": [ # The IDs of the parent folders which contain the file.

1966

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

1967

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1968

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1969

"permissionIds": [ # List of permission IDs for users with access to this file.

1970

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1971

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1973

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1974

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

1975

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

1976

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

1977

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

1978

# - group - Name of the Google Group, such as "The Company Administrators."

1979

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1980

# - anyone - No displayName is present.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1981

"domain": "A String", # The domain to which this permission refers.

1982

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

1983

"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:

1984

# - They can only be set on user and group permissions

1985

# - The time must be in the future

1986

# - The time cannot be more than a year in the future

1987

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

1988

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

1989

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1990

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1991

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

1992

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

1993

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

1994

# - file

1995

# - member

1996

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2002

},

2003

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2004

"photoLink": "A String", # A link to the user's profile photo, if available.

2005

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2012

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2013

{

2014

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2015

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2016

"role": "A String", # Deprecated - use permissionDetails/role instead.

2017

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2018

},

2019

],

2020

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2021

# - user

2022

# - group

2023

# - domain

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2024

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2025

},

2026

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2027

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

2028

# Entries with null values are cleared in update and copy requests.

2029

"a_key": "A String",

2030

},

2031

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

2032

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

2033

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

2034

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

2035

"displayName": "A String", # A plain text displayable name for this user.

2036

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2037

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2038

"me": True or False, # Whether this user is the requesting user.

2039

"permissionId": "A String", # The user's ID as visible in Permission resources.

2040

"photoLink": "A String", # A link to the user's profile photo, if available.

2041

},

2042

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

2043

"targetId": "A String", # The ID of the file that this shortcut points to.

2044

"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.

2045

},

2046

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

2047

"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.

2048

"A String",

2049

],

2050

"starred": True or False, # Whether the user has starred the file.

2051

"teamDriveId": "A String", # Deprecated - use driveId instead.

2052

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

2053

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2054

"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]

2055

"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

2056

"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.

2057

"displayName": "A String", # A plain text displayable name for this user.

2058

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2059

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2060

"me": True or False, # Whether this user is the requesting user.

2061

"permissionId": "A String", # The user's ID as visible in Permission resources.

2062

"photoLink": "A String", # A link to the user's profile photo, if available.

2063

},

2064

"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 user.

2065

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

2066

"durationMillis": "A String", # The duration of the video in milliseconds.

2067

"height": 42, # The height of the video in pixels.

2068

"width": 42, # The width of the video in pixels.

2069

},

2070

"viewedByMe": True or False, # Whether the file has been viewed by this user.

2071

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

2072

"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.

2073

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

2074

"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.

2075

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2076

}

2077

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2078

addParents: string, A comma-separated list of parent IDs to add.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2079

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.

2080

keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

2081

ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).

2082

removeParents: string, A comma-separated list of parent IDs to remove.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2083

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]

2084

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

2085

useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.

2086

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2087

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2088

2089

Returns:

2090

An object of the form:

2091

2092

{ # The metadata for a file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2093

"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.

2094

# Entries with null values are cleared in update and copy requests.

2095

"a_key": "A String",

2096

},

2097

"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

2098

"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^]

2099

"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]

2100

"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.

2101

"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.

2102

"canChangeViewersCanCopyContent": True or False, # Deprecated

2103

"canComment": True or False, # Whether the current user can comment on this file.

2104

"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.

2105

"canDelete": True or False, # Whether the current user can delete this file.

2106

"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.

2107

"canDownload": True or False, # Whether the current user can download this file.

2108

"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.

2109

"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.

2110

"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^]

2111

"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]

2112

"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.

2113

"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.

2114

"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.

2115

"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.

2116

"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2117

"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.

2118

"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.

2119

"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.

2120

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.

2121

"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

2122

"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.

2123

"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.

2124

"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.

2125

"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.

2126

"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.

2127

"canRename": True or False, # Whether the current user can rename this file.

2128

"canShare": True or False, # Whether the current user can modify the sharing settings for this file.

2129

"canTrash": True or False, # Whether the current user can move this file to trash.

2130

"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.

2131

"canUntrash": True or False, # Whether the current user can restore this file from trash.

2132

},

2133

"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.

2134

"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.

2135

"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.

2136

"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).

2137

"mimeType": "A String", # The MIME type of the thumbnail.

2138

},

2139

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2140

"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.

2141

{ # A restriction for accessing the content of the file.

2142

"readOnly": True or False, # Whether the content of the file is read-only.

2143

"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

2144

"restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.

2145

"displayName": "A String", # A plain text displayable name for this user.

2146

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2147

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2148

"me": True or False, # Whether this user is the requesting user.

2149

"permissionId": "A String", # The user's ID as visible in Permission resources.

2150

"photoLink": "A String", # A link to the user's profile photo, if available.

2151

},

2152

"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

2153

"type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.

2154

},

2155

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2156

"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

2157

"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).

2158

"description": "A String", # A short description of the file.

2159

"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.

2160

"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

2161

"exportLinks": { # Links for exporting Google Docs to specific formats.

2162

"a_key": "A String", # A mapping from export format to URL

2163

},

2164

"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

2165

"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.

2166

# If an unsupported color is specified, the closest color in the palette will be used instead.

2167

"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.

2168

# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

2169

"hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.

2170

"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.

2171

"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

2172

"iconLink": "A String", # A static, unauthenticated link to the file's icon.

2173

"id": "A String", # The ID of the file.

2174

"imageMediaMetadata": { # Additional metadata about image media, if available.

2175

"aperture": 3.14, # The aperture used to create the photo (f-number).

2176

"cameraMake": "A String", # The make of the camera used to create the photo.

2177

"cameraModel": "A String", # The model of the camera used to create the photo.

2178

"colorSpace": "A String", # The color space of the photo.

2179

"exposureBias": 3.14, # The exposure bias of the photo (APEX value).

2180

"exposureMode": "A String", # The exposure mode used to create the photo.

2181

"exposureTime": 3.14, # The length of the exposure, in seconds.

2182

"flashUsed": True or False, # Whether a flash was used to create the photo.

2183

"focalLength": 3.14, # The focal length used to create the photo, in millimeters.

2184

"height": 42, # The height of the image in pixels.

2185

"isoSpeed": 42, # The ISO speed used to create the photo.

2186

"lens": "A String", # The lens used to create the photo.

2187

"location": { # Geographic location information stored in the image.

2188

"altitude": 3.14, # The altitude stored in the image.

2189

"latitude": 3.14, # The latitude stored in the image.

2190

"longitude": 3.14, # The longitude stored in the image.

2191

},

2192

"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).

2193

"meteringMode": "A String", # The metering mode used to create the photo.

2194

"rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.

2195

"sensor": "A String", # The type of sensor used to create the photo.

2196

"subjectDistance": 42, # The distance to the subject of the photo, in meters.

2197

"time": "A String", # The date and time the photo was taken (EXIF DateTime).

2198

"whiteBalance": "A String", # The white balance mode used to create the photo.

2199

"width": 42, # The width of the image in pixels.

2200

},

2201

"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.

2202

"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".

2203

"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.

2204

"displayName": "A String", # A plain text displayable name for this user.

2205

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2206

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2207

"me": True or False, # Whether this user is the requesting user.

2208

"permissionId": "A String", # The user's ID as visible in Permission resources.

2209

"photoLink": "A String", # A link to the user's profile photo, if available.

2210

},

2211

"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

2212

"mimeType": "A String", # The MIME type of the file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2213

# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2214

# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2215

"modifiedByMe": True or False, # Whether the file has been modified by this user.

2216

"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).

2217

"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2218

# Note that setting modifiedTime will also update modifiedByMeTime for the user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2219

"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

2220

"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

2221

"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.

2222

"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2223

{ # Information about a Drive user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2224

"displayName": "A String", # A plain text displayable name for this user.

2225

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2226

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2227

"me": True or False, # Whether this user is the requesting user.

2228

"permissionId": "A String", # The user's ID as visible in Permission resources.

2229

"photoLink": "A String", # A link to the user's profile photo, if available.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2230

},

2231

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2232

"parents": [ # The IDs of the parent folders which contain the file.

2233

# If not specified as part of a create 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 must use the addParents and removeParents parameters to modify the parents list.

2234

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2235

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2236

"permissionIds": [ # List of permission IDs for users with access to this file.

2237

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2238

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2239

"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2240

{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2241

"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

2242

"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

2243

"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

2244

# - user - User's full name, as defined for their Google account, such as "Joe Smith."

2245

# - group - Name of the Google Group, such as "The Company Administrators."

2246

# - domain - String domain name, such as "thecompany.com."

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2247

# - anyone - No displayName is present.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2248

"domain": "A String", # The domain to which this permission refers.

2249

"emailAddress": "A String", # The email address of the user or group to which this permission refers.

2250

"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:

2251

# - They can only be set on user and group permissions

2252

# - The time must be in the future

2253

# - The time cannot be more than a year in the future

2254

"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

2255

"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".

2256

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2257

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2258

"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.

2259

"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.

2260

"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:

2261

# - file

2262

# - member

2263

"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2269

},

2270

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2271

"photoLink": "A String", # A link to the user's profile photo, if available.

2272

"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# - owner

# - organizer

# - fileOrganizer

# - writer

# - commenter

# - reader

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2279

"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.

2280

{

2281

"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.

2282

"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.

2283

"role": "A String", # Deprecated - use permissionDetails/role instead.

2284

"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.

2285

},

2286

],

2287

"type": "A String", # The type of the grantee. Valid values are:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2288

# - user

2289

# - group

2290

# - domain

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2291

# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2292

},

2293

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2294

"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.

2295

# Entries with null values are cleared in update and copy requests.

2296

"a_key": "A String",

2297

},

2298

"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

2299

"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.

2300

"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

2301

"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.

2302

"displayName": "A String", # A plain text displayable name for this user.

2303

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2304

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2305

"me": True or False, # Whether this user is the requesting user.

2306

"permissionId": "A String", # The user's ID as visible in Permission resources.

2307

"photoLink": "A String", # A link to the user's profile photo, if available.

2308

},

2309

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

2310

"targetId": "A String", # The ID of the file that this shortcut points to.

2311

"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.

2312

},

2313

"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

2314

"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.

2315

"A String",

2316

],

2317

"starred": True or False, # Whether the user has starred the file.

2318

"teamDriveId": "A String", # Deprecated - use driveId instead.

2319

"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

2320

"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2321

"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]

2322

"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

2323

"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.

2324

"displayName": "A String", # A plain text displayable name for this user.

2325

"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

2326

"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".

2327

"me": True or False, # Whether this user is the requesting user.

2328

"permissionId": "A String", # The user's ID as visible in Permission resources.

2329

"photoLink": "A String", # A link to the user's profile photo, if available.

2330

},

2331

"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 user.

2332

"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.

2333

"durationMillis": "A String", # The duration of the video in milliseconds.

2334

"height": 42, # The height of the video in pixels.

2335

"width": 42, # The width of the video in pixels.

2336

},

2337

"viewedByMe": True or False, # Whether the file has been viewed by this user.

2338

"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).

2339

"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.

2340

"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

2341

"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.

2342

"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2347

<code class="details" id="watch">watch(fileId, body=None, acknowledgeAbuse=None, supportsAllDrives=None, supportsTeamDrives=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2348

<pre>Subscribes to changes to a file

2349

2350

Args:

2351

fileId: string, The ID of the file. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2352

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2353

The object takes the form of:

2354

2355

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2356

"address": "A String", # The address where notifications are delivered for this channel.

2357

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

2358

"id": "A String", # A UUID or similar unique string that identifies this channel.

2359

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

2360

"params": { # Additional parameters controlling delivery channel behavior. Optional.

2361

"a_key": "A String", # Declares a new parameter by name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2362

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2363

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

2364

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

2365

"resourceUri": "A String", # A version-specific identifier for the watched resource.

2366

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

2367

"type": "A String", # The type of delivery mechanism used for this channel.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2368

}

2369

2370

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2371

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]

2372

supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2373

2374

Returns:

2375

An object of the form:

2376

2377

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2378

"address": "A String", # The address where notifications are delivered for this channel.

2379

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

2380

"id": "A String", # A UUID or similar unique string that identifies this channel.

2381

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

2382

"params": { # Additional parameters controlling delivery channel behavior. Optional.

2383

"a_key": "A String", # Declares a new parameter by name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2384

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

2386

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

2387

"resourceUri": "A String", # A version-specific identifier for the watched resource.

2388

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

2389

"type": "A String", # The type of delivery mechanism used for this channel.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2394

<code class="details" id="watch_media">watch_media(fileId, body=None, acknowledgeAbuse=None, supportsAllDrives=None, supportsTeamDrives=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2395

<pre>Subscribes to changes to a file

2396

2397

Args:

2398

fileId: string, The ID of the file. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2399

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2400

The object takes the form of:

2401

2402

{ # An notification channel used to watch for resource changes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2403

"address": "A String", # The address where notifications are delivered for this channel.

2404

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

2405

"id": "A String", # A UUID or similar unique string that identifies this channel.

2406

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

2407

"params": { # Additional parameters controlling delivery channel behavior. Optional.

2408

"a_key": "A String", # Declares a new parameter by name.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2409

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2410

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

2411

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

2412

"resourceUri": "A String", # A version-specific identifier for the watched resource.

2413

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

2414

"type": "A String", # The type of delivery mechanism used for this channel.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2415

}

2416

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2417

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2418

supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.

Bu Sun Kim