Class PageProtection

Proteção da página

Obsoleto. Para planilhas criadas na versão mais recente das Planilhas Google, use a classe Protection mais poderosa. Embora essa classe tenha sido descontinuada, ela ainda está disponível para compatibilidade com a versão mais antiga das Planilhas.

Acessar e modificar páginas protegidas na versão mais antiga das Planilhas Google.

MétodoTipo de retornoBreve descrição
addUser(email)voidAdiciona um usuário à lista de usuários que podem editar a planilha, se ela estiver protegida.
getUsers()String[]Retorna uma lista dos endereços de e-mail dos usuários que podem editar essa planilha.
isProtected()BooleanIndica se a proteção da página está ativada ou não.
removeUser(user)voidRemove um usuário da lista de usuários que podem editar a planilha.
setProtected(protection)voidDefine o status de proteção da página.

Métodos obsoletos

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Adiciona um usuário à lista de usuários que podem editar a planilha, se ela estiver protegida.

// Add the "user@example.com" user to the list of users who can edit this sheet
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
permissions.addUser('user@example.com');
permissions.setProtected(true);
sheet.setSheetProtection(permissions);

Parâmetros

NomeTipoDescrição
emailStringO e-mail do usuário a ser adicionado.

Consulte também


Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Retorna uma lista dos endereços de e-mail dos usuários que podem editar essa planilha.

Se a proteção de planilha estiver desativada, o valor retornado por essa chamada não terá sentido.

Retornar

String[]: uma matriz de endereços de e-mail dos usuários que podem editar a planilha


Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Indica se a proteção da página está ativada ou não.

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

Retornar

Boolean: indica se a proteção da página está ativada ou não.

Consulte também


Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Remove um usuário da lista de usuários que podem editar a planilha.

// Remove the "user@example.com" user to the list of users who can edit this
// sheet
const sheet = SpreadsheetApp.getActiveSheet();
const permissions = sheet.getSheetProtection();
permissions.removeUser('user@example.com');
permissions.setProtected(true);
sheet.setSheetProtection(permissions);

Parâmetros

NomeTipoDescrição
userStringO endereço de e-mail do usuário a ser removido.

Consulte também


Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o status de proteção da página.

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

Parâmetros

NomeTipoDescrição
protectionBooleantrue para ativar a proteção de página e false para desativar a proteção de página.

Consulte também