Use wide Google Drive integration

With Ants & Apps platform you can connect Google Drive with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • about

    • Get information about the user, the user's Drive, and system capabilities

      This action gets information about the user, the user's Drive, and system capabilities.

      GETDriveAboutGet
  • changes

    • Get the starting pageToken for listing future changes

      This action gets the starting pageToken for listing future changes.

      GETDriveChangesGetStartPageToken

      Request parameters

      • driveIdstring

        The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • teamDriveIdstring

        Deprecated use driveId instead.

    • List the changes for a user or shared drive

      This action lists the changes for a user or shared drive.

      GETDriveChangesList

      Request parameters

      • 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 or to the response from the getStartPageToken method.

      • driveIdstring

        The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

      • includeCorpusRemovalsboolean

        Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

      • includeItemsFromAllDrivesboolean

        Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.

      • includeRemovedboolean

        Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

      • includeTeamDriveItemsboolean

        Deprecated use includeItemsFromAllDrives instead.

      • pageSizeinteger

        The maximum number of changes to return per page.

      • restrictToMyDriveboolean

        Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

      • spacesstring

        A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • teamDriveIdstring

        Deprecated use driveId instead.

    • Subscribe to changes for a user

      This action subscribes to changes for a user.

      POSTDriveChangesWatch

      Request parameters

      • 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 or to the response from the getStartPageToken method.

      • driveIdstring

        The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

      • includeCorpusRemovalsboolean

        Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

      • includeItemsFromAllDrivesboolean

        Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.

      • includeRemovedboolean

        Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

      • includeTeamDriveItemsboolean

        Deprecated use includeItemsFromAllDrives instead.

      • pageSizeinteger

        The maximum number of changes to return per page.

      • restrictToMyDriveboolean

        Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

      • spacesstring

        A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • teamDriveIdstring

        Deprecated use driveId instead.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

  • channels

    • Stop watching resources through this channel

      This action stop watching resources through this channel

      POSTDriveChannelsStop

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

  • comments

    • Get a comment by ID

      This action gets a comment by ID.

      GETDriveCommentsGet

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      • includeDeletedboolean

        Whether to return deleted comments. Deleted comments will not include their original content.

    • List a file's comments

      This action lists a file's comments.

      GETDriveCommentsList

      Request parameters

      • fileId*string

        The ID of the file.

      • includeDeletedboolean

        Whether to include deleted comments. Deleted comments will not include their original content.

      • pageSizeinteger

        The maximum number of comments to return per page.

      • pageTokenstring

        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.

      • startModifiedTimestring

        The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).

    • Create a new comment on a file

      This action creates a new comment on a file.

      POSTDriveCommentsCreate

      Request parameters

      • fileId*string

        The ID of the file.

      Request body

      • anchorstring

        A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.

      • authorobject

        The user who created the comment.

      • contentstring

        The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.

      • createdTimestring

        The time at which the comment was created (RFC 3339 date-time).

      • deletedboolean

        Whether the comment has been deleted. A deleted comment has no content.

      • htmlContentstring

        The content of the comment with HTML formatting.

      • idstring

        The ID of the comment.

      • kindstring

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

      • modifiedTimestring

        The last time the comment or any of its replies was modified (RFC 3339 date-time).

      • quotedFileContentobject

        The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.

      • repliesarray

        The full list of replies to the comment in chronological order.

      • resolvedboolean

        Whether the comment has been resolved by one of its replies.

      • suggestionobject

        A change on a suggestion.

      • postobject

        A change on a regular posted comment.

      • mentionedUsersarray

        Users who are mentioned in this comment.

      • assignmentobject

        A change on an assignment.

      • authorobject

        The author of this Comment.

      • blogobject

        Data about the blog containing this comment.

      • contentstring

        The actual content of the comment. May include HTML markup.

      • idstring

        The identifier for this resource.

      • inReplyToobject

        Data about the comment this is in reply to.

      • kindstring

        The kind of this entry. Always blogger#comment

      • postobject

        Data about the post containing this comment.

      • publishedstring

        RFC 3339 date-time when this comment was published.

      • selfLinkstring

        The API REST URL to fetch this resource from.

      • statusstring

        The status of the comment (only populated for admin users)

      • updatedstring

        RFC 3339 date-time when this comment was last updated.

    • Update a comment with patch semantics

      This action updates a comment with patch semantics.

      PATCHDriveCommentsUpdate

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      Request body

      • anchorstring

        A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.

      • authorobject

        The user who created the comment.

      • contentstring

        The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.

      • createdTimestring

        The time at which the comment was created (RFC 3339 date-time).

      • deletedboolean

        Whether the comment has been deleted. A deleted comment has no content.

      • htmlContentstring

        The content of the comment with HTML formatting.

      • idstring

        The ID of the comment.

      • kindstring

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

      • modifiedTimestring

        The last time the comment or any of its replies was modified (RFC 3339 date-time).

      • quotedFileContentobject

        The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.

      • repliesarray

        The full list of replies to the comment in chronological order.

      • resolvedboolean

        Whether the comment has been resolved by one of its replies.

      • suggestionobject

        A change on a suggestion.

      • postobject

        A change on a regular posted comment.

      • mentionedUsersarray

        Users who are mentioned in this comment.

      • assignmentobject

        A change on an assignment.

      • authorobject

        The author of this Comment.

      • blogobject

        Data about the blog containing this comment.

      • contentstring

        The actual content of the comment. May include HTML markup.

      • idstring

        The identifier for this resource.

      • inReplyToobject

        Data about the comment this is in reply to.

      • kindstring

        The kind of this entry. Always blogger#comment

      • postobject

        Data about the post containing this comment.

      • publishedstring

        RFC 3339 date-time when this comment was published.

      • selfLinkstring

        The API REST URL to fetch this resource from.

      • statusstring

        The status of the comment (only populated for admin users)

      • updatedstring

        RFC 3339 date-time when this comment was last updated.

    • Delete a comment

      This action deletes a comment.

      DELETEDriveCommentsDelete

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

  • drives

    • Get a shared drive's metadata by ID

      This action gets a shared drive's metadata by ID.

      GETDriveDrivesGet

      Request parameters

      • driveId*string

        The ID of the shared drive.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

    • List the user's shared drives

      This action lists the user's shared drives.

      GETDriveDrivesList

      Request parameters

      • pageSizeinteger

        Maximum number of shared drives to return.

      • pageTokenstring

        Page token for shared drives.

      • qstring

        Query string for searching shared drives.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.

    • Create a new shared drive

      This action creates a new shared drive.

      POSTDriveDrivesCreate

      Request parameters

      • requestId*string

        An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.

      Request body

      • backgroundImageFileobject

        An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

      • backgroundImageLinkstring

        A short-lived link to this shared drive's background image.

      • capabilitiesobject

        Capabilities the current user has on this shared drive.

      • colorRgbstring

        The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.

      • createdTimestring

        The time at which the shared drive was created (RFC 3339 date-time).

      • hiddenboolean

        Whether the shared drive is hidden from default view.

      • idstring

        The ID of this shared drive which is also the ID of the top level folder of this shared drive.

      • kindstring

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

      • namestring

        The name of this shared drive.

      • restrictionsobject

        A set of restrictions that apply to this shared drive or items inside this shared drive.

      • themeIdstring

        The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

      • rootobject

        The root of this shared drive.

      • titlestring

        The title of the shared drive.

      • namestring

        The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name.

    • Hide a shared drive from the default view

      This action hides a shared drive from the default view.

      POSTDriveDrivesHide

      Request parameters

      • driveId*string

        The ID of the shared drive.

    • Restore a shared drive to the default view

      This action restores a shared drive to the default view.

      POSTDriveDrivesUnhide

      Request parameters

      • driveId*string

        The ID of the shared drive.

    • Update the metadate for a shared drive

      This action updates the metadate for a shared drive.

      PATCHDriveDrivesUpdate

      Request parameters

      • driveId*string

        The ID of the shared drive.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

      Request body

      • backgroundImageFileobject

        An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

      • backgroundImageLinkstring

        A short-lived link to this shared drive's background image.

      • capabilitiesobject

        Capabilities the current user has on this shared drive.

      • colorRgbstring

        The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.

      • createdTimestring

        The time at which the shared drive was created (RFC 3339 date-time).

      • hiddenboolean

        Whether the shared drive is hidden from default view.

      • idstring

        The ID of this shared drive which is also the ID of the top level folder of this shared drive.

      • kindstring

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

      • namestring

        The name of this shared drive.

      • restrictionsobject

        A set of restrictions that apply to this shared drive or items inside this shared drive.

      • themeIdstring

        The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

      • rootobject

        The root of this shared drive.

      • titlestring

        The title of the shared drive.

      • namestring

        The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name.

    • Permanently deletes a shared drive for which the user is an organizer

      This action permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.

      DELETEDriveDrivesDelete

      Request parameters

      • driveId*string

        The ID of the shared drive.

  • files

    • Export a Google Doc to the requested MIME type and returns the exported content

      This action exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.

      GETDriveFilesExport

      Request parameters

      • fileId*string

        The ID of the file.

      • mimeType*string

        The MIME type of the format requested for this export.

    • Generate a set of file IDs which can be provided in create or copy requests

      This action generates a set of file IDs which can be provided in create or copy requests.

      GETDriveFilesGenerateIds

      Request parameters

      • countinteger

        The number of IDs to return.

      • spacestring

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

    • Get a file's metadata or content by ID

      This action gets a file's metadata or content by ID.

      GETDriveFilesGet

      Request parameters

      • fileId*string

        The ID of the file.

      • acknowledgeAbuseboolean

        Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

    • List or searches files

      This action lists or searches files.

      GETDriveFilesList

      Request parameters

      • corporastring

        Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.

      • corpusstring

        The source of files to list. Deprecated: use 'corpora' instead.

      • driveIdstring

        ID of the shared drive to search.

      • includeItemsFromAllDrivesboolean

        Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.

      • includeTeamDriveItemsboolean

        Deprecated use includeItemsFromAllDrives instead.

      • orderBystring

        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.

      • pageSizeinteger

        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.

      • pageTokenstring

        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.

      • qstring

        A query for filtering the file results. See the "Search for Files" guide for supported syntax.

      • spacesstring

        A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • teamDriveIdstring

        Deprecated use driveId instead.

    • Create a copy of a file and applies any requested updates with patch semantics

      This action creates a copy of a file and applies any requested updates with patch semantics.

      POSTDriveFilesCopy

      Request parameters

      • fileId*string

        The ID of the file.

      • ignoreDefaultVisibilityboolean

        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.

      • keepRevisionForeverboolean

        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.

      • ocrLanguagestring

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

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      Request body

      • appPropertiesobject

        A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.

      • capabilitiesobject

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

      • contentHintsobject

        Additional information about the content of the file. These fields are never populated in responses.

      • copyRequiresWriterPermissionboolean

        Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

      • createdTimestring

        The time at which the file was created (RFC 3339 date-time).

      • descriptionstring

        A short description of the file.

      • driveIdstring

        ID of the shared drive the file resides in. Only populated for items in shared drives.

      • explicitlyTrashedboolean

        Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

      • exportLinksobject

        Links for exporting Google Docs to specific formats.

      • fileExtensionstring

        The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

      • folderColorRgbstring

        The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

      • fullFileExtensionstring

        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. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

      • hasAugmentedPermissionsboolean

        Whether there are permissions directly on this file. This field is only populated for items in shared drives.

      • hasThumbnailboolean

        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.

      • headRevisionIdstring

        The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

      • iconLinkstring

        A static, unauthenticated link to the file's icon.

      • idstring

        The ID of the file.

      • imageMediaMetadataobject

        Additional metadata about image media, if available.

      • isAppAuthorizedboolean

        Whether the file was created or opened by the requesting app.

      • kindstring

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

      • lastModifyingUserobject

        The last user to modify the file.

      • md5Checksumstring

        The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

      • mimeTypestring

        The MIME type of the file. 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. 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.

      • modifiedByMeboolean

        Whether the file has been modified by this user.

      • modifiedByMeTimestring

        The last time the file was modified by the user (RFC 3339 date-time).

      • modifiedTimestring

        The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

      • namestring

        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.

      • originalFilenamestring

        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.

      • ownedByMeboolean

        Whether the user owns the file. Not populated for items in shared drives.

      • ownersarray

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

      • parentsarray

        The IDs of the parent folders which contain the file. 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.

      • permissionIdsarray

        List of permission IDs for users with access to this file.

      • permissionsarray

        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.

      • propertiesobject

        A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.

      • quotaBytesUsedstring

        The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

      • sharedboolean

        Whether the file has been shared. Not populated for items in shared drives.

      • sharedWithMeTimestring

        The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

      • sharingUserobject

        The user who shared the file with the requesting user, if applicable.

      • sizestring

        The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

      • spacesarray

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

      • starredboolean

        Whether the user has starred the file.

      • teamDriveIdstring

        Deprecated - use driveId instead.

      • thumbnailLinkstring

        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.

      • thumbnailVersionstring

        The thumbnail version for use in thumbnail cache invalidation.

      • trashedboolean

        Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.

      • trashedTimestring

        The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

      • trashingUserobject

        If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

      • versionstring

        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.

      • videoMediaMetadataobject

        Additional metadata about video media. This may not be available immediately upon upload.

      • viewedByMeboolean

        Whether the file has been viewed by this user.

      • viewedByMeTimestring

        The last time the file was viewed by the user (RFC 3339 date-time).

      • viewersCanCopyContentboolean

        Deprecated - use copyRequiresWriterPermission instead.

      • webContentLinkstring

        A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

      • webViewLinkstring

        A link for opening the file in a relevant Google editor or viewer in a browser.

      • writersCanShareboolean

        Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

    • Create a new file

      This action creates a new file.

      POSTDriveFilesCreate

      Request parameters

      • ignoreDefaultVisibilityboolean

        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.

      • keepRevisionForeverboolean

        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.

      • ocrLanguagestring

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

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • useContentAsIndexableTextboolean

        Whether to use the uploaded content as indexable text.

      Request body

      • appPropertiesobject

        A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.

      • capabilitiesobject

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

      • contentHintsobject

        Additional information about the content of the file. These fields are never populated in responses.

      • copyRequiresWriterPermissionboolean

        Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

      • createdTimestring

        The time at which the file was created (RFC 3339 date-time).

      • descriptionstring

        A short description of the file.

      • driveIdstring

        ID of the shared drive the file resides in. Only populated for items in shared drives.

      • explicitlyTrashedboolean

        Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

      • exportLinksobject

        Links for exporting Google Docs to specific formats.

      • fileExtensionstring

        The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

      • folderColorRgbstring

        The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

      • fullFileExtensionstring

        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. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

      • hasAugmentedPermissionsboolean

        Whether there are permissions directly on this file. This field is only populated for items in shared drives.

      • hasThumbnailboolean

        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.

      • headRevisionIdstring

        The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

      • iconLinkstring

        A static, unauthenticated link to the file's icon.

      • idstring

        The ID of the file.

      • imageMediaMetadataobject

        Additional metadata about image media, if available.

      • isAppAuthorizedboolean

        Whether the file was created or opened by the requesting app.

      • kindstring

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

      • lastModifyingUserobject

        The last user to modify the file.

      • md5Checksumstring

        The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

      • mimeTypestring

        The MIME type of the file. 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. 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.

      • modifiedByMeboolean

        Whether the file has been modified by this user.

      • modifiedByMeTimestring

        The last time the file was modified by the user (RFC 3339 date-time).

      • modifiedTimestring

        The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

      • namestring

        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.

      • originalFilenamestring

        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.

      • ownedByMeboolean

        Whether the user owns the file. Not populated for items in shared drives.

      • ownersarray

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

      • parentsarray

        The IDs of the parent folders which contain the file. 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.

      • permissionIdsarray

        List of permission IDs for users with access to this file.

      • permissionsarray

        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.

      • propertiesobject

        A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.

      • quotaBytesUsedstring

        The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

      • sharedboolean

        Whether the file has been shared. Not populated for items in shared drives.

      • sharedWithMeTimestring

        The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

      • sharingUserobject

        The user who shared the file with the requesting user, if applicable.

      • sizestring

        The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

      • spacesarray

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

      • starredboolean

        Whether the user has starred the file.

      • teamDriveIdstring

        Deprecated - use driveId instead.

      • thumbnailLinkstring

        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.

      • thumbnailVersionstring

        The thumbnail version for use in thumbnail cache invalidation.

      • trashedboolean

        Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.

      • trashedTimestring

        The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

      • trashingUserobject

        If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

      • versionstring

        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.

      • videoMediaMetadataobject

        Additional metadata about video media. This may not be available immediately upon upload.

      • viewedByMeboolean

        Whether the file has been viewed by this user.

      • viewedByMeTimestring

        The last time the file was viewed by the user (RFC 3339 date-time).

      • viewersCanCopyContentboolean

        Deprecated - use copyRequiresWriterPermission instead.

      • webContentLinkstring

        A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

      • webViewLinkstring

        A link for opening the file in a relevant Google editor or viewer in a browser.

      • writersCanShareboolean

        Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

    • Subscribe to changes to a file

      This action subscribes to changes to a file

      POSTDriveFilesWatch

      Request parameters

      • fileId*string

        The ID of the file.

      • acknowledgeAbuseboolean

        Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

    • Update a file's metadata and/or content with patch semantics

      This action updates a file's metadata and/or content with patch semantics.

      PATCHDriveFilesUpdate

      Request parameters

      • fileId*string

        The ID of the file.

      • addParentsstring

        A comma-separated list of parent IDs to add.

      • keepRevisionForeverboolean

        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.

      • ocrLanguagestring

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

      • removeParentsstring

        A comma-separated list of parent IDs to remove.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • useContentAsIndexableTextboolean

        Whether to use the uploaded content as indexable text.

      Request body

      • appPropertiesobject

        A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.

      • capabilitiesobject

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

      • contentHintsobject

        Additional information about the content of the file. These fields are never populated in responses.

      • copyRequiresWriterPermissionboolean

        Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

      • createdTimestring

        The time at which the file was created (RFC 3339 date-time).

      • descriptionstring

        A short description of the file.

      • driveIdstring

        ID of the shared drive the file resides in. Only populated for items in shared drives.

      • explicitlyTrashedboolean

        Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

      • exportLinksobject

        Links for exporting Google Docs to specific formats.

      • fileExtensionstring

        The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

      • folderColorRgbstring

        The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

      • fullFileExtensionstring

        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. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

      • hasAugmentedPermissionsboolean

        Whether there are permissions directly on this file. This field is only populated for items in shared drives.

      • hasThumbnailboolean

        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.

      • headRevisionIdstring

        The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

      • iconLinkstring

        A static, unauthenticated link to the file's icon.

      • idstring

        The ID of the file.

      • imageMediaMetadataobject

        Additional metadata about image media, if available.

      • isAppAuthorizedboolean

        Whether the file was created or opened by the requesting app.

      • kindstring

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

      • lastModifyingUserobject

        The last user to modify the file.

      • md5Checksumstring

        The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

      • mimeTypestring

        The MIME type of the file. 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. 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.

      • modifiedByMeboolean

        Whether the file has been modified by this user.

      • modifiedByMeTimestring

        The last time the file was modified by the user (RFC 3339 date-time).

      • modifiedTimestring

        The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

      • namestring

        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.

      • originalFilenamestring

        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.

      • ownedByMeboolean

        Whether the user owns the file. Not populated for items in shared drives.

      • ownersarray

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

      • parentsarray

        The IDs of the parent folders which contain the file. 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.

      • permissionIdsarray

        List of permission IDs for users with access to this file.

      • permissionsarray

        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.

      • propertiesobject

        A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.

      • quotaBytesUsedstring

        The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

      • sharedboolean

        Whether the file has been shared. Not populated for items in shared drives.

      • sharedWithMeTimestring

        The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

      • sharingUserobject

        The user who shared the file with the requesting user, if applicable.

      • sizestring

        The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

      • spacesarray

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

      • starredboolean

        Whether the user has starred the file.

      • teamDriveIdstring

        Deprecated - use driveId instead.

      • thumbnailLinkstring

        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.

      • thumbnailVersionstring

        The thumbnail version for use in thumbnail cache invalidation.

      • trashedboolean

        Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.

      • trashedTimestring

        The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

      • trashingUserobject

        If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

      • versionstring

        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.

      • videoMediaMetadataobject

        Additional metadata about video media. This may not be available immediately upon upload.

      • viewedByMeboolean

        Whether the file has been viewed by this user.

      • viewedByMeTimestring

        The last time the file was viewed by the user (RFC 3339 date-time).

      • viewersCanCopyContentboolean

        Deprecated - use copyRequiresWriterPermission instead.

      • webContentLinkstring

        A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

      • webViewLinkstring

        A link for opening the file in a relevant Google editor or viewer in a browser.

      • writersCanShareboolean

        Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.

    • Permanently deletes a file owned by the user without moving it to the trash

      This action 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.

      DELETEDriveFilesDelete

      Request parameters

      • fileId*string

        The ID of the file.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

    • Permanently deletes all of the user's trashed files

      This action permanently deletes all of the user's trashed files.

      DELETEDriveFilesEmptyTrash
  • permissions

    • Get a permission by ID

      This action gets a permission by ID.

      GETDrivePermissionsGet

      Request parameters

      • fileId*string

        The ID of the file.

      • permissionId*string

        The ID of the permission.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

    • List a file's or shared drive's permissions

      This action lists a file's or shared drive's permissions.

      GETDrivePermissionsList

      Request parameters

      • fileId*string

        The ID of the file or shared drive.

      • pageSizeinteger

        The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.

      • pageTokenstring

        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.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

    • Create a permission for a file or shared drive

      This action creates a permission for a file or shared drive.

      POSTDrivePermissionsCreate

      Request parameters

      • fileId*string

        The ID of the file or shared drive.

      • emailMessagestring

        A plain text custom message to include in the notification email.

      • sendNotificationEmailboolean

        Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • transferOwnershipboolean

        Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

      Request body

      • allowFileDiscoveryboolean

        Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

      • deletedboolean

        Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

      • displayNamestring

        A displayable name for users, groups or domains.

      • domainstring

        The domain to which this permission refers.

      • emailAddressstring

        The email address of the user or group to which this permission refers.

      • expirationTimestring

        The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future

      • idstring

        The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.

      • kindstring

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

      • permissionDetailsarray

        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.

      • photoLinkstring

        A link to the user's profile photo, if available.

      • rolestring

        The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader

      • teamDrivePermissionDetailsarray

        Deprecated - use permissionDetails instead.

      • typestring

        The type of the grantee. Valid values are: - user - group - domain - anyone

      • rolestring

        Indicates theGoogle Drive permissions role. The role determines a user's ability to read, write, and comment on items.

      • domainobject

        The domain to whom this permission applies.

      • allowDiscoveryboolean

        If true, the item can be discovered (e.g. in the user's "Shared with me" collection) without needing a link to the item.

      • userobject

        The user to whom this permission applies.

      • anyoneobject

        If set, this permission applies to anyone, even logged out users.

      • groupobject

        The group to whom this permission applies.

    • Update a permission with patch semantics

      This action updates a permission with patch semantics.

      PATCHDrivePermissionsUpdate

      Request parameters

      • fileId*string

        The ID of the file or shared drive.

      • permissionId*string

        The ID of the permission.

      • removeExpirationboolean

        Whether to remove the expiration date.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • transferOwnershipboolean

        Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

      Request body

      • allowFileDiscoveryboolean

        Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

      • deletedboolean

        Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

      • displayNamestring

        A displayable name for users, groups or domains.

      • domainstring

        The domain to which this permission refers.

      • emailAddressstring

        The email address of the user or group to which this permission refers.

      • expirationTimestring

        The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future

      • idstring

        The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.

      • kindstring

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

      • permissionDetailsarray

        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.

      • photoLinkstring

        A link to the user's profile photo, if available.

      • rolestring

        The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader

      • teamDrivePermissionDetailsarray

        Deprecated - use permissionDetails instead.

      • typestring

        The type of the grantee. Valid values are: - user - group - domain - anyone

      • rolestring

        Indicates theGoogle Drive permissions role. The role determines a user's ability to read, write, and comment on items.

      • domainobject

        The domain to whom this permission applies.

      • allowDiscoveryboolean

        If true, the item can be discovered (e.g. in the user's "Shared with me" collection) without needing a link to the item.

      • userobject

        The user to whom this permission applies.

      • anyoneobject

        If set, this permission applies to anyone, even logged out users.

      • groupobject

        The group to whom this permission applies.

    • Delete a permission

      This action deletes a permission.

      DELETEDrivePermissionsDelete

      Request parameters

      • fileId*string

        The ID of the file or shared drive.

      • permissionId*string

        The ID of the permission.

      • supportsAllDrivesboolean

        Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

      • supportsTeamDrivesboolean

        Deprecated use supportsAllDrives instead.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

  • replies

    • Get a reply by ID

      This action gets a reply by ID.

      GETDriveRepliesGet

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      • replyId*string

        The ID of the reply.

      • includeDeletedboolean

        Whether to return deleted replies. Deleted replies will not include their original content.

    • List a comment's replies

      This action lists a comment's replies.

      GETDriveRepliesList

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      • includeDeletedboolean

        Whether to include deleted replies. Deleted replies will not include their original content.

      • pageSizeinteger

        The maximum number of replies to return per page.

      • pageTokenstring

        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.

    • Create a new reply to a comment

      This action creates a new reply to a comment.

      POSTDriveRepliesCreate

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      Request body

      • actionstring

        The action the reply performed to the parent comment. Valid values are: - resolve - reopen

      • authorobject

        The user who created the reply.

      • contentstring

        The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.

      • createdTimestring

        The time at which the reply was created (RFC 3339 date-time).

      • deletedboolean

        Whether the reply has been deleted. A deleted reply has no content.

      • htmlContentstring

        The content of the reply with HTML formatting.

      • idstring

        The ID of the reply.

      • kindstring

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

      • modifiedTimestring

        The last time the reply was modified (RFC 3339 date-time).

    • Update a reply with patch semantics

      This action updates a reply with patch semantics.

      PATCHDriveRepliesUpdate

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      • replyId*string

        The ID of the reply.

      Request body

      • actionstring

        The action the reply performed to the parent comment. Valid values are: - resolve - reopen

      • authorobject

        The user who created the reply.

      • contentstring

        The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.

      • createdTimestring

        The time at which the reply was created (RFC 3339 date-time).

      • deletedboolean

        Whether the reply has been deleted. A deleted reply has no content.

      • htmlContentstring

        The content of the reply with HTML formatting.

      • idstring

        The ID of the reply.

      • kindstring

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

      • modifiedTimestring

        The last time the reply was modified (RFC 3339 date-time).

    • Delete a reply

      This action deletes a reply.

      DELETEDriveRepliesDelete

      Request parameters

      • commentId*string

        The ID of the comment.

      • fileId*string

        The ID of the file.

      • replyId*string

        The ID of the reply.

  • revisions

    • Get a revision's metadata or content by ID

      This action gets a revision's metadata or content by ID.

      GETDriveRevisionsGet

      Request parameters

      • fileId*string

        The ID of the file.

      • revisionId*string

        The ID of the revision.

      • acknowledgeAbuseboolean

        Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

    • List a file's revisions

      This action lists a file's revisions.

      GETDriveRevisionsList

      Request parameters

      • fileId*string

        The ID of the file.

      • pageSizeinteger

        The maximum number of revisions to return per page.

      • pageTokenstring

        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.

    • Update a revision with patch semantics

      This action updates a revision with patch semantics.

      PATCHDriveRevisionsUpdate

      Request parameters

      • fileId*string

        The ID of the file.

      • revisionId*string

        The ID of the revision.

      Request body

      • exportLinksobject

        Links for exporting Google Docs to specific formats.

      • idstring

        The ID of the revision.

      • keepForeverboolean

        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.

      • kindstring

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

      • lastModifyingUserobject

        The last user to modify this revision.

      • md5Checksumstring

        The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.

      • mimeTypestring

        The MIME type of the revision.

      • modifiedTimestring

        The last time the revision was modified (RFC 3339 date-time).

      • originalFilenamestring

        The original filename used to create this revision. This is only applicable to files with binary content in Drive.

      • publishAutoboolean

        Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.

      • publishedboolean

        Whether this revision is published. This is only applicable to Google Docs.

      • publishedOutsideDomainboolean

        Whether this revision is published outside the domain. This is only applicable to Google Docs.

      • sizestring

        The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.

    • Permanently deletes a file version

      This action permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

      DELETEDriveRevisionsDelete

      Request parameters

      • fileId*string

        The ID of the file.

      • revisionId*string

        The ID of the revision.

  • teamdrives

    • Deprecated use drives

      This action deprecated use drives.get instead.

      GETDriveTeamdrivesGet

      Request parameters

      • teamDriveId*string

        The ID of the Team Drive

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.

    • Deprecated use drives

      This action deprecated use drives.list instead.

      GETDriveTeamdrivesList

      Request parameters

      • pageSizeinteger

        Maximum number of Team Drives to return.

      • pageTokenstring

        Page token for Team Drives.

      • qstring

        Query string for searching Team Drives.

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.

    • Deprecated use drives

      This action deprecated use drives.create instead.

      POSTDriveTeamdrivesCreate

      Request parameters

      • requestId*string

        An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.

      Request body

      • backgroundImageFileobject

        An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

      • backgroundImageLinkstring

        A short-lived link to this Team Drive's background image.

      • capabilitiesobject

        Capabilities the current user has on this Team Drive.

      • colorRgbstring

        The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.

      • createdTimestring

        The time at which the Team Drive was created (RFC 3339 date-time).

      • idstring

        The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.

      • kindstring

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

      • namestring

        The name of this Team Drive.

      • restrictionsobject

        A set of restrictions that apply to this Team Drive or items inside this Team Drive.

      • themeIdstring

        The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

      • rootobject

        This field is deprecated; please see `Drive.root` instead.

      • titlestring

        This field is deprecated; please see `Drive.title` instead.

      • namestring

        This field is deprecated; please see `Drive.name` instead.

    • Deprecated use drives

      This action deprecated use drives.update instead

      PATCHDriveTeamdrivesUpdate

      Request parameters

      • teamDriveId*string

        The ID of the Team Drive

      • useDomainAdminAccessboolean

        Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.

      Request body

      • backgroundImageFileobject

        An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

      • backgroundImageLinkstring

        A short-lived link to this Team Drive's background image.

      • capabilitiesobject

        Capabilities the current user has on this Team Drive.

      • colorRgbstring

        The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.

      • createdTimestring

        The time at which the Team Drive was created (RFC 3339 date-time).

      • idstring

        The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.

      • kindstring

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

      • namestring

        The name of this Team Drive.

      • restrictionsobject

        A set of restrictions that apply to this Team Drive or items inside this Team Drive.

      • themeIdstring

        The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

      • rootobject

        This field is deprecated; please see `Drive.root` instead.

      • titlestring

        This field is deprecated; please see `Drive.title` instead.

      • namestring

        This field is deprecated; please see `Drive.name` instead.

    • Deprecated use drives

      This action deprecated use drives.delete instead.

      DELETEDriveTeamdrivesDelete

      Request parameters

      • teamDriveId*string

        The ID of the Team Drive