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

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

[diff] [blame]

80

81

<code><a href="#get">get(fileId, revisionId)</a></code></p>

82

<p class="firstline">Gets a specific revision.</p>

83

Bu Sun Kim

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

[diff] [blame]

84

<code><a href="#list">list(fileId, maxResults=None, pageToken=None)</a></code></p>

John Asmuth

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

[diff] [blame]

85

<p class="firstline">Lists a file's revisions.</p>

86

Sai Cheemalapati

df61397

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

[diff] [blame]

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#patch">patch(fileId, revisionId, body=None)</a></code></p>

91

<p class="firstline">Updates a revision.</p>

John Asmuth

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

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#update">update(fileId, revisionId, body=None)</a></code></p>

John Asmuth

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

[diff] [blame]

94

<p class="firstline">Updates a revision.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="delete">delete(fileId, revisionId)</code>

Bu Sun Kim

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

[diff] [blame]

98

<pre>Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

John Asmuth

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

[diff] [blame]

99

100

Args:

101

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

102

revisionId: string, The ID of the revision. (required)

</pre>

</div>

<code class="details" id="get">get(fileId, revisionId)</code>

108

<pre>Gets a specific revision.

109

110

Args:

111

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

112

revisionId: string, The ID of the revision. (required)

113

114

Returns:

115

An object of the form:

116

117

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

118

"downloadUrl": "A String",

119

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

120

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

121

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

122

},

123

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

John Asmuth

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

[diff] [blame]

134

},

Bu Sun Kim

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

[diff] [blame]

135

},

136

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

137

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

138

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

139

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

140

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

141

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

142

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

143

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

144

"publishedLink": "A String", # A link to the published revision.

145

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

146

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

147

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

151

<code class="details" id="list">list(fileId, maxResults=None, pageToken=None)</code>

152

<pre>Lists a file's revisions.

John Asmuth

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

[diff] [blame]

153

154

Args:

155

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

Sai Cheemalapati

df61397

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

[diff] [blame]

156

maxResults: integer, Maximum number of revisions to return.

Bu Sun Kim

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

[diff] [blame]

157

pageToken: string, Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

John Asmuth

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

[diff] [blame]

158

159

Returns:

160

An object of the form:

161

162

{ # A list of revisions of a file.

Bu Sun Kim

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

[diff] [blame]

163

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

164

"items": [ # The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

John Asmuth

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

[diff] [blame]

165

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

166

"downloadUrl": "A String",

167

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

168

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

169

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

John Asmuth

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

[diff] [blame]

170

},

Bu Sun Kim

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

[diff] [blame]

171

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

},

183

},

184

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

185

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

186

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

187

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

188

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

189

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

190

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

191

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

192

"publishedLink": "A String", # A link to the published revision.

193

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

194

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

195

},

John Asmuth

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

[diff] [blame]

196

],

Bu Sun Kim

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

[diff] [blame]

197

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

198

"nextPageToken": "A String", # The page token for the next page of revisions. This field will be absent if the end of the revisions 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.

199

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

204

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

205

<pre>Retrieves the next page of results.

206

207

Args:

208

previous_request: The request for the previous page. (required)

209

previous_response: The response from the request for the previous page. (required)

210

211

Returns:

Bu Sun Kim

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

[diff] [blame]

212

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

df61397

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

[diff] [blame]

213

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

218

<code class="details" id="patch">patch(fileId, revisionId, body=None)</code>

219

<pre>Updates a revision.

John Asmuth

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

[diff] [blame]

220

221

Args:

222

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

223

revisionId: string, The ID for the revision. (required)

Dan O'Meara

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

[diff] [blame]

224

body: object, The request body.

John Asmuth

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

[diff] [blame]

225

The object takes the form of:

226

227

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

228

"downloadUrl": "A String",

229

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

230

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

231

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

232

},

233

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

John Asmuth

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

[diff] [blame]

244

},

Bu Sun Kim

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

[diff] [blame]

245

},

246

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

247

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

248

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

249

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

250

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

251

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

252

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

253

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

254

"publishedLink": "A String", # A link to the published revision.

255

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

256

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

257

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

262

263

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

264

"downloadUrl": "A String",

265

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

266

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

267

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

268

},

269

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

John Asmuth

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

[diff] [blame]

280

},

Bu Sun Kim

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

[diff] [blame]

281

},

282

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

283

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

284

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

285

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

286

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

287

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

288

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

289

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

290

"publishedLink": "A String", # A link to the published revision.

291

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

292

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

293

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

297

<code class="details" id="update">update(fileId, revisionId, body=None)</code>

John Asmuth

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

[diff] [blame]

298

<pre>Updates a revision.

299

300

Args:

301

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

302

revisionId: string, The ID for the revision. (required)

Dan O'Meara

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

[diff] [blame]

303

body: object, The request body.

John Asmuth

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

[diff] [blame]

304

The object takes the form of:

305

306

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

307

"downloadUrl": "A String",

308

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

309

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

310

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

311

},

312

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

John Asmuth

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

[diff] [blame]

323

},

Bu Sun Kim

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

[diff] [blame]

324

},

325

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

326

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

327

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

328

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

329

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

330

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

331

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

332

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

333

"publishedLink": "A String", # A link to the published revision.

334

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

335

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

336

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

341

342

{ # A revision of a file.

Bu Sun Kim

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

[diff] [blame]

343

"downloadUrl": "A String",

344

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

345

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

346

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

347

},

348

"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

John Asmuth

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

[diff] [blame]

359

},

Bu Sun Kim

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

[diff] [blame]

360

},

361

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

362

"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.

363

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

364

"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).

365

"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.

366

"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.

367

"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.

368

"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.

369

"publishedLink": "A String", # A link to the published revision.

370

"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.

371

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

372

}</pre>

John Asmuth