Skip to main content

Class PageProtection

Spark icon

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 "user@example.com" user to the list of users who can edit this sheet
constsheet=SpreadsheetApp.getActiveSheet();
constpermissions=sheet.getSheetProtection();
permissions.addUser('user@example.com');
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
constsheet=SpreadsheetApp.getActiveSheet();
constpermissions=sheet.getSheetProtection();
constisProtected=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 "user@example.com" user to the list of users who can edit this
// sheet
constsheet=SpreadsheetApp.getActiveSheet();
constpermissions=sheet.getSheetProtection();
permissions.removeUser('user@example.com');
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
constsheet=SpreadsheetApp.getActiveSheet();
constpermissions=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() (削除ここまで)

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 2025年08月12日 UTC.