Class Protection

Adiciona o usuário à lista de editores da página ou do intervalo protegido. Esse método não dá automaticamente ao usuário permissão para editar a planilha. Para fazer isso, chame Spreadsheet.addEditor(emailAddress).

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds an editor to the spreadsheet using an email address.
// TODO(developer): Replace the email address with a valid email.
ss.addEditor('cloudysanfrancisco@gmail.com');

// Gets a sheet by its name and protects it.
const sheet = ss.getSheetByName('Sheet1');
const sampleProtectedSheet = sheet.protect();

// Adds an editor of the protected sheet using an email address.
// TODO(developer): Replace the email address with a valid email.
sampleProtectedSheet.addEditor('cloudysanfrancisco@gmail.com');

// Gets the editors of the protected sheet.
const editors = sampleProtectedSheet.getEditors();

// Logs the editors' email addresses to the console.
for (const editor of editors) {
  console.log(editor.getEmail());
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Adiciona o usuário à lista de editores da página ou do intervalo protegido. Esse método não dá automaticamente ao usuário permissão para editar a planilha. Para fazer isso, chame Spreadsheet.addEditor(user).

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Adds the active user as an editor of the protected sheet.
sampleProtectedSheet.addEditor(Session.getActiveUser());

// Gets the editors of the protected sheet.
const editors = sampleProtectedSheet.getEditors();

// Logs the editors' email addresses to the console.
for (const editor of editors) {
  console.log(editor.getEmail());
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Adiciona a matriz de usuários especificada à lista de editores para a página ou intervalo protegido. Esse método não dá automaticamente aos usuários permissão para editar a planilha. Para fazer isso, chame Spreadsheet.addEditors(emailAddresses).

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Creates variables for the email addresses to add as editors.
// TODO(developer): Replace the email addresses with valid ones.
const TEST_EMAIL_1 = 'cloudysanfrancisco@gmail.com';
const TEST_EMAIL_2 = 'baklavainthebalkans@gmail.com';

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Adds editors to the protected sheet using the email address variables.
sampleProtectedSheet.addEditors([TEST_EMAIL_1, TEST_EMAIL_2]);

// Gets the editors of the protected sheet.
const editors = sampleProtectedSheet.getEditors();

// Logs the editors' email addresses to the console.
for (const editor of editors) {
  console.log(editor.getEmail());
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Adiciona o público-alvo especificado como um editor do intervalo protegido.

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Determina se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegidos. Emite uma exceção se o usuário não tiver permissão para editar o intervalo ou a página protegidos.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Logs whether domain users have permission to edit the protected sheet to the console.
console.log(sampleProtectedSheet.canDomainEdit());

Retornar

Boolean: true se todos os usuários no domínio proprietário da planilha tiverem permissão para editar o intervalo ou a página protegida. false se não tiverem.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Determina se o usuário tem permissão para editar o intervalo ou a página protegida. O proprietário da planilha sempre pode editar intervalos e páginas protegidos.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Retornar

Boolean: true se o usuário tiver permissão para editar o intervalo ou a página protegida. false se não tiver

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Obtém a descrição do intervalo ou página protegido. Se nenhuma descrição for definida, esse método retornará uma string vazia.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet and sets the description.
const sampleProtectedSheet = sheet.protect().setDescription('Sample sheet is protected');

// Gets the description of the protected sheet and logs it to the console.
const sampleProtectedSheetDescription = sampleProtectedSheet.getDescription();
console.log(sampleProtectedSheetDescription);

Retornar

String: a descrição do intervalo ou da página protegida, ou uma string vazia se nenhuma descrição estiver definida.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Recebe a lista de editores do intervalo ou da página protegidos. Emite uma exceção se o usuário não tiver permissão para editar o intervalo ou a página protegidos.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Retornar

User[]: uma matriz de usuários com permissão para editar o intervalo ou página protegido

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Recebe o tipo da área protegida, RANGE ou SHEET.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Gets the type of the protected area.
const protectionType = sampleProtectedSheet.getProtectionType();

// Logs 'SHEET'to the console since the type of the protected area is a sheet.
console.log(protectionType.toString());

Retornar

ProtectionType: o tipo de área protegida, RANGE ou SHEET.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Obtém o intervalo que está sendo protegido. Se a proteção se aplicar à página em vez de um intervalo, esse método retornará um intervalo que abrange toda a página.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range 'A1:B10' of Sheet1.
const range = sheet.getRange('A1:B10');

// Makes cells A1:B10 a protected range.
const sampleProtectedRange = range.protect();

// Gets the protected ranges on the sheet.
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);

// Logs the A1 notation of the first protected range on the sheet.
console.log(protections[0].getRange().getA1Notation());

Retornar

Range: o intervalo que está sendo protegido.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Obtém o nome do intervalo protegido se ele estiver associado a um intervalo nomeado. Retorna null caso a proteção não esteja associada a um intervalo nomeado. Os scripts precisam chamar setRangeName(rangeName) explicitamente para associar um intervalo protegido a um intervalo nomeado. Chamar Range.protect() para criar uma proteção contra um Range que seja um intervalo nomeado, sem chamar setRangeName(rangeName), não é suficiente para associá-los. No entanto, a criação de um intervalo protegido a partir de um intervalo nomeado na IU do Planilhas Google o associa automaticamente.

// Protect a named range in a spreadsheet and log the name of the protected range.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect();
ss.setNamedRange('Test', range);       // Create a named range.
protection.setRangeName('Test');       // Associate the protection with the named range.
Logger.log(protection.getRangeName()); // Verify the name of the protected range.

Retornar

String: o nome do intervalo nomeado protegido, ou null se o intervalo protegido não estiver associado a um intervalo nomeado

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Retorna os códigos dos públicos-alvo que podem editar o intervalo protegido.

Retornar

TargetAudience[]: uma matriz dos IDs dos públicos-alvo.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Recebe uma matriz de intervalos não protegidos dentro de uma página protegida. Se o objeto Protection corresponder a um intervalo protegido em vez de uma página protegida, esse método retornará uma matriz vazia. Para alterar os intervalos desprotegidos, use setUnprotectedRanges(ranges) para definir uma nova matriz de intervalos. Para proteger novamente a página inteira, defina uma matriz vazia.

// Unprotect cells E2:F5 in addition to any other unprotected ranges in the protected sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect();
var unprotected = protection.getUnprotectedRanges();
unprotected.push(sheet.getRange('E2:F5'));
protection.setUnprotectedRanges(unprotected);

Retornar

Range[]: uma matriz de intervalos desprotegidos em uma página protegida

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Determina se a área protegida está usando a proteção "alertada". Isso significa que todos os usuários podem editar dados na área, exceto quando a edição solicita um aviso pedindo que o usuário confirme a edição. Por padrão, páginas ou intervalos protegidos não são baseados em avisos. Para mudar para o estado de aviso, use setWarningOnly(warningOnly).

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit')

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Sets the warning status for the protected sheet as true.
sampleProtectedSheet.setWarningOnly(true);

const protectedSheetWarningStatus = sampleProtectedSheet.isWarningOnly();

// Logs the warning status of the protected sheet to the console.
console.log(protectedSheetWarningStatus);

Retornar

Boolean: true se o intervalo ou a página protegidos usar somente a proteção baseada em avisos.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Desprotege o intervalo ou a página.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Remove o usuário da lista de editores da página ou intervalo protegido. Se o usuário for membro de um Grupo do Google com permissão para edição ou se todos os usuários no domínio tiverem permissão para edição, o usuário ainda poderá editar a área protegida. Não é possível remover o proprietário da planilha nem o usuário atual.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Creates a variable for an email address.
// TODO(developer): Replace the email address with a valid one.
const TEST_EMAIL = 'baklavainthebalkans@gmail.com';

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Adds an editor to the protected sheet using the email address variable.
sampleProtectedSheet.addEditor(TEST_EMAIL);

// Removes the editor from the protected sheet using the email address variable.
sampleProtectedSheet.removeEditor(TEST_EMAIL);

// Gets the editors of the protected sheet.
const editors = sampleProtectedSheet.getEditors();

// Logs the editors' email addresses to the console.
for (const editor of editors) {
  console.log(editor.getEmail());
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Remove o usuário da lista de editores da página ou intervalo protegido. Se o usuário for membro de um Grupo do Google com permissão para edição ou se todos os usuários no domínio tiverem permissão para edição, o usuário também poderá editar a área protegida. Não é possível remover o proprietário da planilha nem o usuário atual.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Removes the active user from the editors of the protected sheet.
sampleProtectedSheet.removeEditor(Session.getActiveUser());

// Gets the editors of the protected sheet.
const editors = sampleProtectedSheet.getEditors();

// Logs the editors' email addresses to the console.
for (const editor of editors) {
  console.log(editor.getEmail());
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Remove a matriz de usuários especificada da lista de editores para a página ou intervalo protegido. Se algum dos usuários for membro de um Grupo do Google com permissão para edição ou todos os usuários no domínio tiverem permissão para edição, esses usuários ainda poderão editar a área protegida. Não é possível remover o proprietário da planilha nem o usuário atual.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Remove o público-alvo especificado como um editor do intervalo protegido.

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Define a descrição do intervalo ou página protegidos.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the sheet 'Sheet1' by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet.
const sampleProtectedSheet = sheet.protect();

// Sets the sheet description to 'Sheet1 is protected.'
sampleProtectedSheet.setDescription('Sheet1 is protected');

// Gets the description of the protected sheet.
const sampleProtectedSheetDescription = sampleProtectedSheet.getDescription();

// Logs the description of the protected sheet to the console.
console.log(sampleProtectedSheetDescription);

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Define se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegidos. Todos os usuários com permissão explícita para edição podem editar a área protegida, independentemente dessa configuração. Gera uma exceção quando a planilha não pertence a um domínio do Google Workspace, ou seja, pertence a uma conta do gmail.com.

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Associa o intervalo protegido a um intervalo nomeado existente. Se o intervalo nomeado cobrir uma área diferente do intervalo protegido atual, esse método moverá a proteção para abranger o intervalo nomeado. O intervalo nomeado precisa estar na mesma página que o intervalo protegido atual. Os scripts precisam chamar explicitamente esse método para associar um intervalo protegido a um intervalo nomeado. Chamar Range.protect() para criar uma proteção contra um Range que seja um intervalo nomeado sem chamar setRangeName(rangeName) não é suficiente para associá-lo. No entanto, criar um intervalo protegido a partir de um intervalo nomeado na IU do Planilhas Google o associa automaticamente.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Protects cells A1:D10 on Sheet1.
const sheet = ss.getSheetByName('Sheet1');
const protectedRange = sheet.getRange('A1:D10').protect();

// Logs the current protected range, A1:D10.
console.log(protectedRange.getRange().getA1Notation());

// Creates a named range for cells E1:J10 called 'NewRange.'
const newRange = sheet.getRange('E1:J10');
ss.setNamedRange('NewRange', newRange);
const namedRange = ss.getNamedRanges()[0];

// Updates the protected range to the named range, 'NewRange.'
// This updates the protected range on Sheet1 from A1:D10 to E1:J10.
protectedRange.setNamedRange(namedRange);

// Logs the updated protected range to the console.
console.log(protectedRange.getRange().getA1Notation());

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Ajusta o intervalo que está sendo protegido. Se o intervalo fornecido cobrir uma área diferente do intervalo protegido atual, esse método moverá a proteção para abranger o novo intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Protects cells A1:D10 on Sheet1 of the spreadsheet.
const sheet = ss.getSheetByName('Sheet1');
const protectedRange = sheet.getRange('A1:D10').protect();

// Logs the original protected range, A1:D10, to the console.
console.log(protectedRange.getRange().getA1Notation());

// Gets the range E1:J10.
const newRange = sheet.getRange('E1:J10');

// Updates the protected range to E1:J10.
protectedRange.setRange(newRange);

// Logs the updated protected range to the console.
console.log(protectedRange.getRange().getA1Notation());

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Associa o intervalo protegido a um intervalo nomeado existente. Se o intervalo nomeado cobrir uma área diferente do intervalo protegido atual, esse método moverá a proteção para abranger o intervalo nomeado. O intervalo nomeado precisa estar na mesma página que o intervalo protegido atual. Os scripts precisam chamar explicitamente esse método para associar um intervalo protegido a um intervalo nomeado. Chamar Range.protect() para criar uma proteção contra um Range que seja um intervalo nomeado sem chamar setRangeName(rangeName) não é suficiente para associá-lo. No entanto, criar um intervalo protegido a partir de um intervalo nomeado na IU do Planilhas Google o associa automaticamente.

// Protect a named range in a spreadsheet and log the name of the protected range.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect();
ss.setNamedRange('Test', range);       // Create a named range.
protection.setRangeName('Test');       // Associate the protection with the named range.
Logger.log(protection.getRangeName()); // Verify the name of the protected range.

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Desprotege a matriz de intervalos fornecida dentro de uma página protegida. Emite uma exceção se o objeto Protection corresponder a um intervalo protegido em vez de uma página protegida ou se algum dos intervalos não estiver na página protegida. Para alterar os intervalos desprotegidos, defina uma nova matriz de intervalos. Para proteger novamente a página inteira, defina uma matriz vazia.

// Protect the active sheet except B2:C5, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');
var unprotected = sheet.getRange('B2:C5');
protection.setUnprotectedRanges([unprotected]);

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Define se este intervalo protegido está ou não usando a proteção "com base em aviso". Com a proteção baseada em avisos, todos os usuários podem editar dados na área, exceto quando a solicitação solicita um aviso para que eles confirmem a edição. Por padrão, as páginas ou os intervalos protegidos não são baseados em avisos. Para verificar o estado do aviso, use isWarningOnly().

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the sheet 'Sheet1' by its name.
const sheet = ss.getSheetByName('Sheet1');

// Protects the sheet and sets the protection to warning-based.
const sampleProtectedSheet = sheet.protect().setWarningOnly(true);

// Logs whether the protected sheet is warning-based to the console.
console.log(sampleProtectedSheet.isWarningOnly());

Parâmetros

Retornar

Protection: o objeto que representa as configurações de proteção para encadeamento.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets