Drive API v2

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 files

procedure
(drive-files-list [ #:projection projection
#:maxResults maxResults
#:pageToken pageToken
#:q q
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  projection : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  q : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Lists the user’s files.

projection: This parameter is deprecated and has no function.

maxResults: Maximum number of files to return.

pageToken: Page token for files.

q: Query string for searching files.

procedure
(drive-files-touch #:fileId fileId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  fileId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Set the file’s updated time to the current server time.

fileId: The ID of the file to update.

procedure
(drive-files-get #:fileId fileId
[ #:projection projection
#:updateViewedDate updateViewedDate
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  fileId : string?
  projection : string? = 'N/A
  updateViewedDate : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets a file’s metadata by ID.

fileId: The ID for the file in question.

projection: This parameter is deprecated and has no function.

updateViewedDate: Whether to update the view date after successfully retrieving the file.

procedure
(drive-files-insert
[ #:pinned pinned
#:convert convert
#:ocr ocr
#:ocrLanguage ocrLanguage
#:sourceLanguage sourceLanguage
#:targetLanguage targetLanguage
#:timedTextLanguage timedTextLanguage
#:timedTextTrackName timedTextTrackName
#:id id
#:description description
#:kind kind
#:title title
#:etag etag
#:labels labels
#:quotaBytesUsed quotaBytesUsed
#:selfLink selfLink
#:createdDate createdDate
#:modifiedDate modifiedDate
#:mimeType mimeType
#:alternateLink alternateLink
#:downloadUrl downloadUrl
#:editable editable
#:embedLink embedLink
#:explicitlyTrashed explicitlyTrashed
#:exportLinks exportLinks
#:fileExtension fileExtension
#:fileSize fileSize
#:imageMediaMetadata imageMediaMetadata
#:indexableText indexableText
#:lastModifyingUserName lastModifyingUserName
#:lastViewedByMeDate lastViewedByMeDate
#:md5Checksum md5Checksum
#:modifiedByMeDate modifiedByMeDate
#:originalFilename originalFilename
#:ownerNames ownerNames
#:parents parents
#:sharedWithMeDate sharedWithMeDate
#:thumbnail thumbnail
#:thumbnailLink thumbnailLink
#:userPermission userPermission
#:webContentLink webContentLink
#:writersCanShare writersCanShare
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  pinned : string? = 'N/A
  convert : string? = 'N/A
  ocr : string? = 'N/A
  ocrLanguage : string? = 'N/A
  sourceLanguage : string? = 'N/A
  targetLanguage : string? = 'N/A
  timedTextLanguage : string? = 'N/A
  timedTextTrackName : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  title : string? = 'N/A
  etag : string? = 'N/A
  labels : string? = 'N/A
  quotaBytesUsed : string? = 'N/A
  selfLink : string? = 'N/A
  createdDate : string? = 'N/A
  modifiedDate : string? = 'N/A
  mimeType : string? = 'N/A
  alternateLink : string? = 'N/A
  downloadUrl : string? = 'N/A
  editable : string? = 'N/A
  embedLink : string? = 'N/A
  explicitlyTrashed : string? = 'N/A
  exportLinks : string? = 'N/A
  fileExtension : string? = 'N/A
  fileSize : string? = 'N/A
  imageMediaMetadata : string? = 'N/A
  indexableText : string? = 'N/A
  lastModifyingUserName : string? = 'N/A
  lastViewedByMeDate : string? = 'N/A
  md5Checksum : string? = 'N/A
  modifiedByMeDate : string? = 'N/A
  originalFilename : string? = 'N/A
  ownerNames : string? = 'N/A
  parents : string? = 'N/A
  sharedWithMeDate : string? = 'N/A
  thumbnail : string? = 'N/A
  thumbnailLink : string? = 'N/A
  userPermission : string? = 'N/A
  webContentLink : string? = 'N/A
  writersCanShare : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Insert a new file.

pinned: Whether to pin the head revision of the uploaded file.

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

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

ocrLanguage: If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.

sourceLanguage: The language of the original file to be translated.

targetLanguage: Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.

timedTextLanguage: The language of the timed text.

timedTextTrackName: The timed text track name.

id: The id of the file.

description: A short description of the file.

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

title: The title of this file.

etag: ETag of the file.

labels: A group of labels for the file.

quotaBytesUsed: The number of quota bytes used by this file.

selfLink: A link back to this file.

createdDate: Create time for this file (formatted ISO8601 timestamp).

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

mimeType: The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content’s MIME type.

alternateLink: A link for opening the file in using a relevant Google editor or viewer.

downloadUrl: Short term download URL for the file. This will only be populated on files with content stored in Drive.

editable: Whether the file can be edited by the current user.

embedLink: A link for embedding the file.

explicitlyTrashed: Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.

exportLinks: Links for exporting Google Docs to specific formats.

fileExtension: The file extension used when downloading this file. This field is set from the title when inserting or uploading new content. This will only be populated on files with content stored in Drive.

fileSize: The size of the file in bytes. This will only be populated on files with content stored in Drive.

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

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

lastModifyingUserName: Name of the last user to modify this file. This will only be populated if a user has edited this file.

lastViewedByMeDate: Last time this file was viewed by the user (formatted RFC 3339 timestamp).

md5Checksum: An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.

modifiedByMeDate: Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.

originalFilename: The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.

ownerNames: Name(s) of the owner(s) of this file.

parents: Collection of parent folders which contain this file. Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.

sharedWithMeDate: Time at which this file was shared with the user (formatted RFC 3339 timestamp).

thumbnail: Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.

thumbnailLink: A link to the file’s thumbnail.

userPermission: The permissions for the authenticated user on this file.

webContentLink: A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.

writersCanShare: Whether writers can share the document with other users.

procedure
(drive-files-patch
#:fileId fileId
[ #:pinned pinned
#:convert convert
#:ocr ocr
#:ocrLanguage ocrLanguage
#:sourceLanguage sourceLanguage
#:targetLanguage targetLanguage
#:timedTextLanguage timedTextLanguage
#:timedTextTrackName timedTextTrackName
#:updateViewedDate updateViewedDate
#:newRevision newRevision
#:setModifiedDate setModifiedDate
#:id id
#:description description
#:kind kind
#:title title
#:etag etag
#:labels labels
#:quotaBytesUsed quotaBytesUsed
#:selfLink selfLink
#:createdDate createdDate
#:modifiedDate modifiedDate
#:mimeType mimeType
#:alternateLink alternateLink
#:downloadUrl downloadUrl
#:editable editable
#:embedLink embedLink
#:explicitlyTrashed explicitlyTrashed
#:exportLinks exportLinks
#:fileExtension fileExtension
#:fileSize fileSize
#:imageMediaMetadata imageMediaMetadata
#:indexableText indexableText
#:lastModifyingUserName lastModifyingUserName
#:lastViewedByMeDate lastViewedByMeDate
#:md5Checksum md5Checksum
#:modifiedByMeDate modifiedByMeDate
#:originalFilename originalFilename
#:ownerNames ownerNames
#:parents parents
#:sharedWithMeDate sharedWithMeDate
#:thumbnail thumbnail
#:thumbnailLink thumbnailLink
#:userPermission userPermission
#:webContentLink webContentLink
#:writersCanShare writersCanShare
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  fileId : string?
  pinned : string? = 'N/A
  convert : string? = 'N/A
  ocr : string? = 'N/A
  ocrLanguage : string? = 'N/A
  sourceLanguage : string? = 'N/A
  targetLanguage : string? = 'N/A
  timedTextLanguage : string? = 'N/A
  timedTextTrackName : string? = 'N/A
  updateViewedDate : string? = 'N/A
  newRevision : string? = 'N/A
  setModifiedDate : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  title : string? = 'N/A
  etag : string? = 'N/A
  labels : string? = 'N/A
  quotaBytesUsed : string? = 'N/A
  selfLink : string? = 'N/A
  createdDate : string? = 'N/A
  modifiedDate : string? = 'N/A
  mimeType : string? = 'N/A
  alternateLink : string? = 'N/A
  downloadUrl : string? = 'N/A
  editable : string? = 'N/A
  embedLink : string? = 'N/A
  explicitlyTrashed : string? = 'N/A
  exportLinks : string? = 'N/A
  fileExtension : string? = 'N/A
  fileSize : string? = 'N/A
  imageMediaMetadata : string? = 'N/A
  indexableText : string? = 'N/A
  lastModifyingUserName : string? = 'N/A
  lastViewedByMeDate : string? = 'N/A
  md5Checksum : string? = 'N/A
  modifiedByMeDate : string? = 'N/A
  originalFilename : string? = 'N/A
  ownerNames : string? = 'N/A
  parents : string? = 'N/A
  sharedWithMeDate : string? = 'N/A
  thumbnail : string? = 'N/A
  thumbnailLink : string? = 'N/A
  userPermission : string? = 'N/A
  webContentLink : string? = 'N/A
  writersCanShare : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates file metadata and/or content. This method supports patch semantics.

fileId: The ID of the file to update.

pinned: Whether to pin the new revision.