blob: 2c866896ff90493c55fe8ebc051fe39988ba8280 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(fileId, revisionId)</a></code></p>
<p class="firstline">Permanently deletes a revision. This method is only applicable to files with binary content in Drive.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, pageToken=None, pageSize=None)</a></code></p>
<p class="firstline">Lists a file's revisions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision with patch semantics.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(fileId, revisionId)</code>
<pre>Permanently deletes a revision. This method is only applicable to files with binary content in Drive.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, revisionId, acknowledgeAbuse=None)</code>
<pre>Gets a revision's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
An object of the form:
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
"kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"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.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
"originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
"size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</code>
<pre>Gets a revision's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, pageToken=None, pageSize=None)</code>
<pre>Lists a file's revisions.
Args:
fileId: string, The ID of the file. (required)
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.
pageSize: integer, The maximum number of revisions to return per page.
Returns:
An object of the form:
{ # A list of revisions of a file.
"nextPageToken": "A String", # The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached.
"kind": "drive#revisionList", # Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
"revisions": [ # The full list of revisions.
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
"kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"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.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
"originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
"size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, revisionId, body)</code>
<pre>Updates a revision with patch semantics.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
"kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"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.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
"originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
"size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
}
Returns:
An object of the form:
{ # The metadata for a revision to a file.
"mimeType": "A String", # The MIME type of the revision.
"kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"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.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
"originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
"size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
}</pre>
</div>
</body></html>