Enum Permission

  • DriveApp.Permission is an enum that represents the permissions granted to users for accessing files or folders, in addition to individually assigned permissions.

  • You can use DriveApp.Permission properties like VIEW, EDIT, COMMENT, etc. to define access levels when setting sharing settings for files or folders.

  • Calling an enum property involves using the parent class, name, and property, such as DriveApp.Permission.VIEW.

  • While some properties like OWNER, ORGANIZER, FILE_ORGANIZER, and NONE can be returned, they cannot be used to set sharing permissions and will throw an exception.
Permission

An enum representing the permissions granted to users who can access a file or folder, besides any individual users who have been explicitly given access. These properties can be accessed from DriveApp.Permission.

To call an enum, you call its parent class, name, and property. For example, DriveApp.Permission.VIEW. 

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for Google Workspace users.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Properties

PropertyTypeDescription
VIEWEnumUsers who can access the file or folder are able only to view it or copy it. Passing this value to File.setSharing(accessType, permissionType) throws an exception if the type of file does not support it.
EDITEnumUsers who can access the file or folder are able to edit it. Unless File.setShareableByEditors(shareable) is set to false, users can also change the sharing settings. Passing this value to File.setSharing(accessType, permissionType) throws an exception if the type of file does not support it.
COMMENTEnumUsers who can access the file or folder are able only to view it, copy it, or comment on it. Passing this value to File.setSharing(accessType, permissionType) throws an exception if the type of file does not support it.
OWNEREnumThe user owns the file or folder. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception.
ORGANIZEREnumUsers who can organize files and folders within a shared drive. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception.
FILE_ORGANIZEREnumUsers who can edit, trash, and move content within a shared drive. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception.
NONEEnumThe user does not have any permissions for the file or folder. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception unless it is set in combination with Access.ANYONE.