Class PageProtection

AI-generated Key Takeaways

• The PageProtection class is deprecated and should not be used in new scripts for spreadsheets created in the newer version of Google Sheets.

• Use the Protection class instead for newer Google Sheets for more powerful sheet protection features.

• PageProtection provides methods to manage access and modifications to protected sheets in the older version of Google Sheets.

• Despite being deprecated, PageProtection remains available for compatibility with older Google Sheets.

• Key methods include adding/removing users with edit access, checking protection status, and setting protection status.

PageProtection

Deprecated. For spreadsheets created in the newer version of Google Sheets, use the more powerful Protection class instead. Although this class is deprecated, it remains available for compatibility with the older version of Sheets.

Access and modify protected sheets in the older version of Google Sheets.

Deprecated methods

Method	Return type	Brief description
addUser(email)	void	Adds a user to the list of users who can edit the sheet, if it is protected.
getUsers()	String[]	Returns a list of the email addresses of the users who can edit this sheet.
isProtected()	Boolean	Indicates whether the sheet has sheet protection enabled or not.
removeUser(user)	void	Removes a user from the list of users who can edit the sheet.
setProtected(protection)	void	Sets the protection status for the sheet.

Deprecated methods

addUser(email)

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a user to the list of users who can edit the sheet, if it is protected.

// Add the "[e-mail]" user to the list of users who can edit this sheet
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
permissions.addUser('[e-mail]');
permissions.setProtected(true);
sheet.setSheetProtection(permissions);

Parameters

Name	Type	Description
email	String	The email of the user to add.

See also

• removeUser(user)

---

getUsers()

Deprecated. This function is deprecated and should not be used in new scripts.

Returns a list of the email addresses of the users who can edit this sheet.

If sheet protection is disabled, the value returned by this call is meaningless.

Return

String[] — An array of email addresses of users who can edit this sheet.

---

isProtected()

Deprecated. This function is deprecated and should not be used in new scripts.

Indicates whether the sheet has sheet protection enabled or not.

// Determine whether or not sheet protection is enabled
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
const isProtected = permissions.isProtected();

Return

Boolean — Whether the sheet has sheet protection enabled or not.

See also

• setProtected(protection)

---

removeUser(user)

Deprecated. This function is deprecated and should not be used in new scripts.

Removes a user from the list of users who can edit the sheet.

// Remove the "[e-mail]" user to the list of users who can edit this
// sheet
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
permissions.removeUser('[e-mail]');
permissions.setProtected(true);
sheet.setSheetProtection(permissions);

Parameters

Name	Type	Description
user	String	The email address of the user to remove.

See also

• addUser(email)

---

setProtected(protection)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the protection status for the sheet.

// Enables sheet protection for  this sheet
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
permissions.setProtected(true);
sheet.setSheetProtection(permissions);

Parameters

Name	Type	Description
protection	Boolean	true to enable sheet protection, false to disable sheet protection.

See also

• isProtected()