Class Protection

Agrega el usuario determinado a la lista de editores para la hoja o el rango protegidos. Este método no le otorga automáticamente permiso al usuario para editar la hoja de cálculo; para hacerlo, llama a Spreadsheet.addEditor(emailAddress).

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Agrega el usuario determinado a la lista de editores para la hoja o el rango protegidos. Este método no le otorga automáticamente permiso al usuario para editar la hoja de cálculo; para hacerlo, llama a Spreadsheet.addEditor(user).

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Agrega el arreglo de usuarios determinado a la lista de editores para la hoja o el rango protegidos. Este método no otorga automáticamente permiso a los usuarios para editar la hoja de cálculo; para eso, además, llama a Spreadsheet.addEditors(emailAddresses).

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Agrega el público objetivo especificado como editor del rango protegido.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Determina si todos los usuarios del dominio al que pertenece la hoja de cálculo tienen permiso para editar el rango o la hoja protegidos. Muestra una excepción si el usuario no tiene permiso para editar el rango o la hoja protegidos.

Volver

Boolean: true si todos los usuarios del dominio al que pertenece la hoja de cálculo tienen permiso para editar el rango o la hoja protegidos; false si no lo tienen

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Determina si el usuario tiene permiso para editar el rango o la hoja protegidos. El propietario de la hoja de cálculo siempre puede editar rangos y hojas 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();
  }
}

Volver

Boolean: true si el usuario tiene permiso para editar el rango o la hoja protegidos; false si no es así

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene la descripción del rango o la hoja protegidos. Si no se configura ninguna descripción, este método muestra una string vacía.

Volver

String: Es la descripción del rango o la hoja protegidos, o una string vacía si no se establece ninguna descripción

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene la lista de editores para el rango o la hoja protegidos. Muestra una excepción si el usuario no tiene permiso para editar el rango o la hoja 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);
}

Volver

User[]: Es un array de usuarios con permiso para editar el rango o la hoja protegidos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene el tipo del área protegida, ya sea RANGE o SHEET.

Volver

ProtectionType: Es el tipo de área protegida, ya sea RANGE o SHEET.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene el rango que se protege. Si la protección se aplica a la hoja en lugar de a un rango, este método muestra un rango que abarca toda la hoja.

Volver

Range: El rango que se protege

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene el nombre del rango protegido si está asociado a un rango con nombre. Muestra null si la protección no está asociada con un rango con nombre. Ten en cuenta que las secuencias de comandos deben llamar de forma explícita a setRangeName(rangeName) a fin de asociar un rango protegido a un rango con nombre. Llamar a Range.protect() para crear una protección desde un Range que es un rango con nombre, sin llamar a setRangeName(rangeName), no es suficiente para asociarlos. Sin embargo, crear un rango protegido a partir de un rango con nombre en la IU de Hojas de cálculo de Google los asocia automáticamente.

// 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.

Volver

String: Es el nombre del rango protegido con nombre o null si el rango protegido no está asociado con un rango con nombre.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Muestra los ID de los públicos objetivo que pueden editar el rango protegido.

Volver

TargetAudience[]: Es un arreglo de los ID de públicos objetivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Obtiene un arreglo de rangos sin protección dentro de una hoja protegida. Si el objeto Protection corresponde a un rango protegido en lugar de a una hoja protegida, este método muestra un arreglo vacío. Para cambiar los rangos sin protección, usa setUnprotectedRanges(ranges) a fin de establecer un nuevo arreglo de rangos. Para volver a proteger toda la hoja, configura un arreglo vacío.

// 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);

Volver

Range[]: Es un arreglo de rangos sin protección dentro de una hoja protegida.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Determina si el área protegida usa protección basada en advertencias. La protección basada en advertencias significa que todos los usuarios pueden editar datos en el área, excepto que la edición genera una advertencia que le pide al usuario que confirme la edición. De forma predeterminada, las hojas o los rangos protegidos no se basan en advertencias. Para cambiar al estado de advertencia, usa setWarningOnly(warningOnly).

Volver

Boolean: true si el rango o la hoja protegidos solo usan protección basada en advertencias

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Desprotege el rango o la hoja.

// 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();
}

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Quita al usuario determinado de la lista de editores para la hoja o el rango protegidos. Ten en cuenta que, si el usuario es miembro de un Grupo de Google que tiene permiso de edición o si todos los usuarios del dominio tienen permiso de edición, aún podrá editar el área protegida. No se puede quitar al propietario de la hoja de cálculo ni al usuario actual.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Quita al usuario determinado de la lista de editores para la hoja o el rango protegidos. Ten en cuenta que, si el usuario es miembro de un Grupo de Google que tiene permiso de edición o si todos los usuarios del dominio tienen permiso de edición, también podrá editar el área protegida. No se puede quitar al propietario de la hoja de cálculo ni al usuario actual.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Quita el arreglo de usuarios determinado de la lista de editores para la hoja o el rango protegidos. Ten en cuenta que si alguno de los usuarios es miembro de un Grupo de Google que tiene permiso de edición o si todos los usuarios del dominio tienen permiso de edición, esos usuarios podrán editar el área protegida. No se puede quitar al propietario de la hoja de cálculo ni al usuario actual.

// 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

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Quita el público objetivo especificado como editor del rango protegido.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Establece la descripción del rango o la hoja protegidos.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Establece si todos los usuarios del dominio al que pertenece la hoja de cálculo tienen permiso para editar el rango o la hoja protegidos. Ten en cuenta que los usuarios que tengan permiso de edición explícito pueden editar el área protegida, sin importar esta configuración. Muestra una excepción si la hoja de cálculo no pertenece a un dominio de Google Workspace (es decir, si es propiedad de una cuenta de gmail.com).

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Asocia el rango protegido con un rango con nombre existente. Si el rango con nombre abarca un área diferente del rango protegido actual, este método mueve la protección para cubrir el rango con nombre en su lugar. El rango con nombre debe estar en la misma hoja que el rango protegido actual. Ten en cuenta que las secuencias de comandos deben llamar de forma explícita a este método para asociar un rango protegido con un rango con nombre. Llamar a Range.protect() a fin de crear una protección desde un Range que sea un rango con nombre, sin llamar a setRangeName(rangeName), no es suficiente para asociarlos. Sin embargo, crear un rango protegido a partir de un rango con nombre en la IU de Hojas de cálculo de Google los asocia automáticamente.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Ajusta el rango que se protege. Si el rango dado cubre un área diferente del rango protegido actual, este método mueve la protección para cubrir el rango nuevo.

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Asocia el rango protegido con un rango con nombre existente. Si el rango con nombre abarca un área diferente del rango protegido actual, este método mueve la protección para cubrir el rango con nombre en su lugar. El rango con nombre debe estar en la misma hoja que el rango protegido actual. Ten en cuenta que las secuencias de comandos deben llamar de forma explícita a este método para asociar un rango protegido con un rango con nombre. Llamar a Range.protect() a fin de crear una protección desde un Range que sea un rango con nombre, sin llamar a setRangeName(rangeName), no es suficiente para asociarlos. Sin embargo, crear un rango protegido a partir de un rango con nombre en la IU de Hojas de cálculo de Google los asocia automáticamente.

// 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

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Desprotege el arreglo de rangos dado dentro de una hoja protegida. Muestra una excepción si el objeto Protection corresponde a un rango protegido en lugar de a una hoja protegida o si alguno de los rangos no está en la hoja protegida. Para cambiar los rangos sin protección, configura un arreglo nuevo de rangos; para volver a proteger toda la hoja, configura un arreglo vacío.

// 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

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Establece si este rango protegido utiliza protección basada en advertencias. La protección basada en advertencias significa que todos los usuarios pueden editar datos en el área, excepto que la edición genera una advertencia en la que se le solicita al usuario que confirme la edición. Según la configuración predeterminada, las hojas o los rangos protegidos no se basan en advertencias. Para verificar el estado de la advertencia, usa isWarningOnly().

Parámetros

Volver

Protection: Es el objeto que representa la configuración de protección para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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