Drive API

The Drive API helps you manage my drive, collaborative drives, and team/group folders.

To use the Drive API, you need an access token that you can get by authenticating with a user account, not a service account. Available API operations may vary depending on your pricing plan.

The API scopes are as follows:

• file or file.read : All Drive API operations are available.
• group.folder or group.folder.read : Only the Drive API operations associated with Team/Group Folder are available.

How to use the Drive API {#user-drive-api}

There are separate groups of Drive API operations for my drive, collaborative drives, and team/group folders, but you can use them in a similar way. Different API operations are available for each drive type: API operations to manage permission are not available for my drive, while API operations to create and delete a drive are available only for collaborative drives.

For both drive types, different API operations are available to upload files, get files, and create folders for the root folder and the rest of the folders.

To access a folder or file in a drive, you need to first get files of the root folder to get its ID and use it to make an API call based on the folder hierarchy. If you already know the parameter required to access a file or folder, such as sharedriveId and fileId, you can access it right away.

Manage drives {#manage-drive}

Manage my drive {#manage-mydrive}

No preparation is required to use my drive.
You can check the usage of my drive using the Drive API.
A member has only one "my drive," so there are no API operations to get drives and to manage permissions.

Manage collaborative drives {#manage-sharedrive}

You can manage collaborative drives on the desktop or mobile app as well as through the following API operations.

Manage team/group folders {#manage-groupfolder}

A team/group folder is part of the team and group features. You can enable or disable this feature using the useFolder property of the API operation that manages teams or groups.

Managing teams requires the orgunit or directory scope, and managing groups requires the group or directory scope.

Use the following API operation to check the usage of team/group folders.
You can access a team/group folder by specifying orgUnitId or groupId, as there is no team/group folder ID.

To use a team/group folder after enabling it using useFolder, you need to create a folder using the following API operation.

Even if you disable the team/group folder using useFolder, the folder data will remain unchanged. To actually delete the folder data, you need to use the following API operation.

Manage folders shared by me {#manage-sharefolder}

You can manage folders shared by me on the desktop or mobile app as well as through the following API operations.

Manage folders shared with me {#manage-sharedfolder}

You can manage folders shared with me on the desktop or mobile app as well as through the following API operations.

Manage drive permissions {#manage-sharedrive-permission}

You can manage collaborative drive permissions using the following API operations.

Manage the root folder {#manage-rootfolder}

You can upload files to the root folder, get files, and create a folder using the following API operations.

Manage my drive root folder {#manage-mydrive-rootfolder}

You can manage the root folder of my drive using the following API operations.

Manage collaborative drive root folder {#manage-sharedrive-rootfolder}

You can manage the root folder of a collaborative drive using the following API operations.

Manage team/group folder root folder {#manage-groupfolder-rootfolder}

You can manage the root folder of a team/group folder using the following API operations.

Manage shared folder root folder {#manage-sharedfolder-rootfolder}

You can manage the root folder of a folder shared with me using the following API operations.

Manage files and folders {#manage-file-folder}

For how to upload or download a file, see Upload or Download Files. You can lock or unlock a file to restrict editing.

Manage my drive files and folders {#manage-mydrive-file-folder}

You can manage files and folders in my drive using the following API operations.

Manage collaborative drive files and folders {#manage-sharedrive-file-folder}

Manage files and folders in a collaborative drive using the following API operations.

Manage team/group files and folders {#manage-groupfolder-file-folder}

You can manage files and folders in a team/group folder using the following API operations.

Manage shared folder files and folders {#manage-sharedfolder-file-folder}

You can manage files and folders in a folder shared with me using the following API operations.

Manage folder access permissions {#manage-folder-permission}

For collaborative drives and team/group folder, API operations for managing folder access permissions are available.
A folder basically inherits the permissions of its parent folder, but you can use the Enable folder access permissions API operation to set different permissions than the parent folder.
You can grant a member, team, and group access permissions using the Create a folder access permission API operation. The access permissions include READ and WRITE permissions.

You can get users who can access a folder and their permissions using the Get folder access permissions API operation. The permission of a user (member, team, and group) is assigned a permissionId.
You can remove a user's permission using the Remove a folder access permission API operation with the permissionId specified, or you can change it using the Update a folder access permission API operation.

To inherit the permissions of the parent folder, use the Disable folder access permission API operation.
You can allow only the collaborative drive or team/group master to access the folder using the Remove a folder access permission API operation.

Note

• Note that you cannot manage my drive permissions using the API.

Manage collaborative drive folder access permissions {#manage-sharedrive-folder-permission}

You can manage folder access permissions of a collaborative drive using the following API operations.

Manage team/group folder access permissions {#manage-groupfolder-folder-permission}

You can manage folder access permissions of a team/group using the following API operations.

Manage shared folder permissions {#manage-sharedfolder-folder-permission}

You can manage access permissions of a folder shared with me using the following API operation.

Manage file revisions {#manage-version}

You can use file revisions to check whether a file is updated or overwritten, and restore or download a previous file revision.

Manage revisions in my drive {#manage-mydrive-version}

You can manage file revisions in my drive using the following API operations.

Manage revisions in a collaborative drive {#manage-sharedrive-version}

You can manage file revisions in a collaborative drive using the following API operations.

Manage versions in a team/group folder {#manage-groupfolder-version}

You can manage file revisions in a team/group folder using the following API operations.

Manage file revisions in a shared folder {#manage-sharedfolder-version}

You can manage file revisions in a folder shared with me using the following API operations.

Manage link sharing {#manage-link}

You can share a file or folder through a link.

Manage link sharing in my drive {#manage-link-drive}

Manage link sharing in a collaborative drive {#manage-link-sharedrive}

Manage link sharing in a team/group folder {#manage-link-group}

Manage link sharing in a shared folder {#manage-link-sharedfolder}

Manage trashed files {#manage-trashfile}

A file deleted by a user is moved to the trash and then permanently deleted after the retention period specified by the administrator.
You can delete or restore files in the trash using the following API operations.

Manage trashed files in my drive {#manage-mydrive-trashfile}

You can manage trashed files in my drive using the following API operations.

Manage trashed files in a collaborative drive {#manage-sharedrive-trashfile}

You can manage trashed files in a collaborative drive using the following API operations.

Manage trashed files in a team/group folder {#manage-groupfolder-trashfile}

You can manage trashed files in a team/group folder using the following API operations.