Enum Permission
Stay organized with collections
Save and categorize content based on your preferences.
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
Property | Type | Description |
VIEW | Enum | Users 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. |
EDIT | Enum | Users 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. |
COMMENT | Enum | Users 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. |
OWNER | Enum | The user owns the file or folder. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception. |
ORGANIZER | Enum | Users 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_ORGANIZER | Enum | Users 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. |
NONE | Enum | The 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 . |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eDriveApp.Permission\u003c/code\u003e is an enum that represents the permissions granted to users for accessing files or folders, in addition to individually assigned permissions.\u003c/p\u003e\n"],["\u003cp\u003eYou can use \u003ccode\u003eDriveApp.Permission\u003c/code\u003e properties like \u003ccode\u003eVIEW\u003c/code\u003e, \u003ccode\u003eEDIT\u003c/code\u003e, \u003ccode\u003eCOMMENT\u003c/code\u003e, etc. to define access levels when setting sharing settings for files or folders.\u003c/p\u003e\n"],["\u003cp\u003eCalling an enum property involves using the parent class, name, and property, such as \u003ccode\u003eDriveApp.Permission.VIEW\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhile some properties like \u003ccode\u003eOWNER\u003c/code\u003e, \u003ccode\u003eORGANIZER\u003c/code\u003e, \u003ccode\u003eFILE_ORGANIZER\u003c/code\u003e, and \u003ccode\u003eNONE\u003c/code\u003e can be returned, they cannot be used to set sharing permissions and will throw an exception.\u003c/p\u003e\n"]]],["The `Permission` enum in DriveApp defines user access levels for files/folders. Key permissions include `VIEW` (view/copy), `EDIT` (edit, potentially share), and `COMMENT` (view, copy, comment). `OWNER`, `ORGANIZER`, and `FILE_ORGANIZER` are for ownership and shared drive organization. `NONE` indicates no permissions. `setSharing()` can define these permissions using `DriveApp.Permission.ENUM_NAME`, except for `OWNER`, `ORGANIZER`, `FILE_ORGANIZER`, and sometimes `NONE`. The `setSharing` method also accepts an `Access` type to define who these permissions apply to.\n"],null,["# Enum Permission\n\nPermission\n\nAn enum representing the permissions granted to users who can access a file or folder, besides\nany individual users who have been explicitly given access. These properties can be accessed from\n[DriveApp.Permission](/apps-script/reference/drive/drive-app#Permission).\n\nTo call an enum, you call its parent class, name, and property. For example, `\nDriveApp.Permission.VIEW`.\n\n```javascript\n// Creates a folder that anyone on the Internet can read from and write to.\n// (Domain administrators can prohibit this setting for Google Workspace users.)\nconst folder = DriveApp.createFolder('Shared Folder');\nfolder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);\n``` \n\n### Properties\n\n| Property | Type | Description |\n|------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `VIEW` | `Enum` | Users who can access the file or folder are able only to view it or copy it. Passing this value to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception if the type of file does not support it. |\n| `EDIT` | `Enum` | Users who can access the file or folder are able to edit it. Unless [File.setShareableByEditors(shareable)](/apps-script/reference/drive/file#setShareableByEditors(Boolean)) is set to `false`, users can also change the sharing settings. Passing this value to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception if the type of file does not support it. |\n| `COMMENT` | `Enum` | Users 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)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception if the type of file does not support it. |\n| `OWNER` | `Enum` | The user owns the file or folder. This value can be returned, but passing it to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception. |\n| `ORGANIZER` | `Enum` | Users who can organize files and folders within a shared drive. This value can be returned, but passing it to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception. |\n| `FILE_ORGANIZER` | `Enum` | Users who can edit, trash, and move content within a shared drive. This value can be returned, but passing it to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception. |\n| `NONE` | `Enum` | The user does not have any permissions for the file or folder. This value can be returned, but passing it to [File.setSharing(accessType, permissionType)](/apps-script/reference/drive/file#setSharing(Access,Permission)) throws an exception unless it is set in combination with [Access.ANYONE](/apps-script/reference/drive/access#ANYONE). |"]]