Class Protection

Schutz

Auf geschützte Bereiche und Tabellenblätter zugreifen und sie ändern. Ein geschützter Bereich kann entweder ein statischer Zellenbereich oder ein benannter Bereich sein. Ein geschütztes Tabellenblatt kann ungeschützte Bereiche enthalten. Verwenden Sie für Tabellen, die mit der älteren Version von Google Tabellen erstellt wurden, stattdessen die Klasse PageProtection. 

// Protect range A1:B10, then remove all other users from the list of editors.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const protection = range.protect().setDescription('Sample protected range');

// 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}
// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Methoden

MethodeRückgabetypKurzbeschreibung
addEditor(emailAddress)ProtectionDer angegebene Nutzer wird der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich hinzugefügt.
addEditor(user)ProtectionDer angegebene Nutzer wird der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich hinzugefügt.
addEditors(emailAddresses)ProtectionFügen Sie der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich das angegebene Nutzerarray hinzu.
addTargetAudience(audienceId)ProtectionDie angegebene Zielgruppe wird als Bearbeiter des geschützten Bereichs hinzugefügt.
canDomainEdit()BooleanBestimmt, ob alle Nutzer in der Domain, der die Tabelle zugewiesen ist, die Berechtigung zum Bearbeiten des geschützten Bereichs oder der geschützten Tabelle haben.
canEdit()BooleanBestimmt, ob der Nutzer berechtigt ist, den geschützten Bereich oder das geschützte Tabellenblatt zu bearbeiten.
getDescription()StringRuft die Beschreibung des geschützten Bereichs oder Tabellenblatts ab.
getEditors()User[]Ruft die Liste der Mitbearbeiter für den geschützten Bereich oder das geschützte Tabellenblatt ab.
getProtectionType()ProtectionTypeDer Typ des Schutzgebiets, entweder RANGE oder SHEET.
getRange()RangeRuft den geschützten Bereich ab.
getRangeName()StringDer Name des geschützten Bereichs, falls er einem benannten Bereich zugeordnet ist.
getTargetAudiences()TargetAudience[]Gibt die IDs der Zielgruppen zurück, die den geschützten Bereich bearbeiten können.
getUnprotectedRanges()Range[]Hiermit wird ein Array von ungeschützten Bereichen in einem geschützten Tabellenblatt zurückgegeben.
isWarningOnly()BooleanGibt an, ob im geschützten Bereich ein „warnbasierter“ Schutz verwendet wird.
remove()voidHeben Sie den Schutz für den Bereich oder das Tabellenblatt auf.
removeEditor(emailAddress)ProtectionEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich.
removeEditor(user)ProtectionEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich.
removeEditors(emailAddresses)ProtectionEntfernt das angegebene Nutzerarray aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich.
removeTargetAudience(audienceId)ProtectionDie angegebene Zielgruppe wird als Bearbeiter des geschützten Bereichs entfernt.
setDescription(description)ProtectionHiermit wird die Beschreibung des geschützten Bereichs oder Tabellenblatts festgelegt.
setDomainEdit(editable)ProtectionHiermit wird festgelegt, ob alle Nutzer in der Domain, der die Tabelle zugewiesen ist, den geschützten Bereich oder das geschützte Tabellenblatt bearbeiten dürfen.
setNamedRange(namedRange)ProtectionDer geschützte Bereich wird mit einem vorhandenen benannten Bereich verknüpft.
setRange(range)ProtectionPasst den geschützten Bereich an.
setRangeName(rangeName)ProtectionDer geschützte Bereich wird mit einem vorhandenen benannten Bereich verknüpft.
setUnprotectedRanges(ranges)ProtectionHeben Sie den Schutz für das angegebene Array von Bereichen in einem geschützten Tabellenblatt auf.
setWarningOnly(warningOnly)ProtectionGibt an, ob für diesen geschützten Bereich ein „warnbasierter“ Schutz verwendet wird.

Detaillierte Dokumentation

addEditor(emailAddress)

Der angegebene Nutzer wird der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich hinzugefügt. Mit dieser Methode erhält der Nutzer nicht automatisch die Berechtigung, die Tabelle selbst zu bearbeiten. Rufen Sie dazu zusätzlich Spreadsheet.addEditor(emailAddress) auf. 

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

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addEditor(user)

Der angegebene Nutzer wird der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich hinzugefügt. Mit dieser Methode erhält der Nutzer nicht automatisch die Berechtigung, die Tabelle selbst zu bearbeiten. Rufen Sie dazu zusätzlich Spreadsheet.addEditor(user) auf. 

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addEditors(emailAddresses)

Fügen Sie der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich das angegebene Nutzerarray hinzu. Mit dieser Methode erhalten die Nutzer nicht automatisch die Berechtigung, die Tabelle selbst zu bearbeiten. Rufen Sie dazu zusätzlich Spreadsheet.addEditors(emailAddresses) auf. 

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

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit den E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addTargetAudience(audienceId)

Die angegebene Zielgruppe wird als Bearbeiter des geschützten Bereichs hinzugefügt.

Parameter

NameTypBeschreibung
audienceIdStringDie ID der hinzuzufügenden Zielgruppe.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

canDomainEdit()

Bestimmt, ob alle Nutzer in der Domain, der die Tabelle zugewiesen ist, die Berechtigung zum Bearbeiten des geschützten Bereichs oder der geschützten Tabelle haben. Es wird eine Ausnahme ausgelöst, wenn der Nutzer keine Berechtigung zum Bearbeiten des geschützten Bereichs oder Tabellenblatts hat. 

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

Rückflug

Boolean – true, wenn alle Nutzer in der Domain, der die Tabelle zugewiesen ist, berechtigt sind, den geschützten Bereich oder das geschützte Tabellenblatt zu bearbeiten; false, wenn dies nicht der Fall ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

canEdit()

Bestimmt, ob der Nutzer berechtigt ist, den geschützten Bereich oder das geschützte Tabellenblatt zu bearbeiten. Der Eigentümer der Tabelle kann geschützte Bereiche und Tabellenblätter jederzeit bearbeiten. 

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

Rückflug

Boolean – true, wenn der Nutzer berechtigt ist, den geschützten Bereich oder das geschützte Tabellenblatt zu bearbeiten; false, wenn nicht

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDescription()

Ruft die Beschreibung des geschützten Bereichs oder Tabellenblatts ab. Wenn keine Beschreibung festgelegt ist, gibt diese Methode einen leeren String zurück. 

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

Rückflug

String: Die Beschreibung des geschützten Bereichs oder Tabellenblatts oder ein leerer String, wenn keine Beschreibung festgelegt ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getEditors()

Ruft die Liste der Mitbearbeiter für den geschützten Bereich oder das geschützte Tabellenblatt ab. Es wird eine Ausnahme ausgelöst, wenn der Nutzer keine Berechtigung zum Bearbeiten des geschützten Bereichs oder Tabellenblatts hat. 

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Rückflug

User[]: ein Array von Nutzern, die berechtigt sind, den geschützten Bereich oder das geschützte Tabellenblatt zu bearbeiten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getProtectionType()

Der Typ des Schutzgebiets, entweder RANGE oder 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());

Rückflug

ProtectionType: Der Typ des Schutzgebiets, entweder RANGE oder SHEET.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange()

Ruft den geschützten Bereich ab. Wenn der Schutz auf das Tabellenblatt statt auf einen Bereich angewendet wird, gibt diese Methode einen Bereich zurück, der das gesamte Tabellenblatt umfasst. 

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

Rückflug

Range: Der geschützte Bereich.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRangeName()

Der Name des geschützten Bereichs, falls er einem benannten Bereich zugeordnet ist. Gibt null zurück, wenn der Schutz nicht mit einem benannten Bereich verknüpft ist. Hinweis: Scripts müssen setRangeName(rangeName) explizit aufrufen, um einen geschützten Bereich mit einem benannten Bereich zu verknüpfen. Wenn Sie Range.protect() aufrufen, um einen Schutz über eine Range zu erstellen, die zufällig ein benannter Bereich ist, ohne setRangeName(rangeName) aufzurufen, ist das nicht ausreichend, um eine Verknüpfung herzustellen. Wenn Sie jedoch in der Google Tabellen-Benutzeroberfläche einen geschützten Bereich aus einem benannten Bereich erstellen, werden sie automatisch verknüpft. 

// Protect a named range in a spreadsheet and log the name of the protected
// range.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.

Rückflug

String: Name des geschützten benannten Bereichs oder null, wenn der geschützte Bereich keinem benannten Bereich zugeordnet ist

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTargetAudiences()

Gibt die IDs der Zielgruppen zurück, die den geschützten Bereich bearbeiten können.

Rückflug

TargetAudience[]: Ein Array mit den IDs der Zielgruppen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getUnprotectedRanges()

Hiermit wird ein Array von ungeschützten Bereichen in einem geschützten Tabellenblatt zurückgegeben. Wenn das Protection-Objekt einem geschützten Bereich statt einem geschützten Tabellenblatt entspricht, gibt diese Methode ein leeres Array zurück. Wenn Sie die nicht geschützten Bereiche ändern möchten, verwenden Sie setUnprotectedRanges(ranges), um ein neues Array von Bereichen festzulegen. Wenn Sie das gesamte Tabellenblatt wieder schützen möchten, legen Sie ein leeres Array fest. 

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

Rückflug

Range[]: ein Array von ungeschützten Bereichen in einem geschützten Tabellenblatt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isWarningOnly()

Gibt an, ob im geschützten Bereich ein „warnbasierter“ Schutz verwendet wird. Beim warnungsbasierten Schutz können alle Nutzer Daten im Bereich bearbeiten. Bei der Bearbeitung wird jedoch eine Warnung angezeigt, in der der Nutzer aufgefordert wird, die Änderung zu bestätigen. Geschützte Bereiche oder Tabellen sind standardmäßig nicht warnungsbasiert. Verwenden Sie setWarningOnly(warningOnly), um zum Warnstatus zu wechseln. 

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

Rückflug

Boolean–true, wenn für den geschützten Bereich oder das geschützte Tabellenblatt nur ein warnbasierter Schutz verwendet wird.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

remove()

Heben Sie den Schutz für den Bereich oder das Tabellenblatt auf. 

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich. Wenn der Nutzer Mitglied einer Google-Gruppe mit Bearbeitungsberechtigung ist oder alle Nutzer in der Domain Bearbeitungsberechtigung haben, kann er den geschützten Bereich weiterhin bearbeiten. Weder der Inhaber der Tabelle noch der aktuelle Nutzer können entfernt werden. 

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

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich. Wenn der Nutzer Mitglied einer Google-Gruppe mit Bearbeitungsberechtigung ist oder alle Nutzer in der Domain Bearbeitungsberechtigung haben, kann er den geschützten Bereich auch bearbeiten. Weder der Inhaber der Tabelle noch der aktuelle Nutzer können entfernt werden. 

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Protection – das Objekt, das die Schutzeinstellungen darstellt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeEditors(emailAddresses)

Entfernt das angegebene Nutzerarray aus der Liste der Bearbeiter für das geschützte Tabellenblatt oder den geschützten Bereich. Wenn einer der Nutzer Mitglied einer Google-Gruppe mit Bearbeitungsberechtigung ist oder alle Nutzer in der Domain die Bearbeitungsberechtigung haben, können diese Nutzer den geschützten Bereich weiterhin bearbeiten. Weder der Inhaber der Tabelle noch der aktuelle Nutzer können entfernt werden. 

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Parameter

NameTypBeschreibung
emailAddressesString[]Eine Liste der E-Mail-Adressen der Nutzer, die entfernt werden sollen.

Rückflug

Protection – das Objekt, das die Schutzeinstellungen darstellt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeTargetAudience(audienceId)

Die angegebene Zielgruppe wird als Bearbeiter des geschützten Bereichs entfernt.

Parameter

NameTypBeschreibung
audienceIdStringDie ID der Zielgruppe, die entfernt werden soll.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setDescription(description)

Hiermit wird die Beschreibung des geschützten Bereichs oder Tabellenblatts festgelegt. 

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

Parameter

NameTypBeschreibung
descriptionStringDie Beschreibung des geschützten Bereichs oder Tabellenblatts.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setDomainEdit(editable)

Hiermit wird festgelegt, ob alle Nutzer in der Domain, der die Tabelle zugewiesen ist, den geschützten Bereich oder das geschützte Tabellenblatt bearbeiten dürfen. Hinweis: Alle Nutzer mit expliziter Bearbeitungsberechtigung können den geschützten Bereich unabhängig von dieser Einstellung bearbeiten. Es wird eine Ausnahme ausgelöst, wenn die Tabelle nicht zu einer Google Workspace-Domain gehört, d. h., wenn sie einem Gmail-Konto gehört.

Parameter

NameTypBeschreibung
editableBooleantrue, wenn alle Nutzer in der Domain, der die Tabelle zugewiesen ist, die Berechtigung zum Bearbeiten des geschützten Bereichs oder der geschützten Tabelle haben sollen, false andernfalls.

Rückflug

Protection – das Objekt, das die Schutzeinstellungen darstellt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setNamedRange(namedRange)

Der geschützte Bereich wird mit einem vorhandenen benannten Bereich verknüpft. Wenn der benannte Bereich einen anderen Bereich als der aktuell geschützte Bereich abdeckt, wird der Schutz mit dieser Methode auf den benannten Bereich verschoben. Der benannte Bereich muss sich auf demselben Tabellenblatt wie der aktuelle geschützte Bereich befinden. Hinweis: In Scripts muss diese Methode explizit aufgerufen werden, um einen geschützten Bereich mit einem benannten Bereich zu verknüpfen. Wenn Sie Range.protect() aufrufen, um einen Schutz von einem Range zu erstellen, der zufällig ein benannter Bereich ist, ohne setRangeName(rangeName) aufzurufen, reicht das nicht aus, um sie zu verknüpfen. Wenn Sie jedoch in der Google Tabellen-Benutzeroberfläche einen geschützten Bereich aus einem benannten Bereich erstellen, werden sie automatisch verknüpft. 

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

Parameter

NameTypBeschreibung
namedRangeNamedRangeDer vorhandene benannte Bereich, der dem geschützten Bereich zugeordnet werden soll.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRange(range)

Passt den geschützten Bereich an. Wenn der angegebene Bereich einen anderen Bereich als den derzeit geschützten Bereich abdeckt, wird der Schutz mit dieser Methode auf den neuen Bereich verschoben. 

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

Parameter

NameTypBeschreibung
rangeRangeDer neue Bereich, der vor Änderungen geschützt werden soll.

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRangeName(rangeName)

Der geschützte Bereich wird mit einem vorhandenen benannten Bereich verknüpft. Wenn der benannte Bereich einen anderen Bereich als der aktuell geschützte Bereich abdeckt, wird der Schutz mit dieser Methode auf den benannten Bereich verschoben. Der benannte Bereich muss sich auf demselben Tabellenblatt wie der aktuelle geschützte Bereich befinden. Hinweis: In Scripts muss diese Methode explizit aufgerufen werden, um einen geschützten Bereich mit einem benannten Bereich zu verknüpfen. Wenn Sie Range.protect() aufrufen, um einen Schutz von einem Range zu erstellen, der zufällig ein benannter Bereich ist, ohne setRangeName(rangeName) aufzurufen, reicht das nicht aus, um sie zu verknüpfen. Wenn Sie jedoch in der Google Tabellen-Benutzeroberfläche einen geschützten Bereich aus einem benannten Bereich erstellen, werden sie automatisch verknüpft. 

// Protect a named range in a spreadsheet and log the name of the protected
// range.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.

Parameter

NameTypBeschreibung
rangeNameStringDer Name des benannten Bereichs, der geschützt werden soll.

Rückflug

Protection – das Objekt, das die Schutzeinstellungen darstellt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setUnprotectedRanges(ranges)

Heben Sie den Schutz für das angegebene Array von Bereichen in einem geschützten Tabellenblatt auf. Es wird eine Ausnahme ausgelöst, wenn das Protection-Objekt einem geschützten Bereich statt einem geschützten Tabellenblatt entspricht oder einer der Bereiche sich nicht auf dem geschützten Tabellenblatt befindet. Wenn Sie die nicht geschützten Bereiche ändern möchten, legen Sie ein neues Array von Bereichen fest. Wenn Sie das gesamte Tabellenblatt wieder schützen möchten, legen Sie ein leeres Array fest. 

// Protect the active sheet except B2:C5, then remove all other users from the
// list of editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Parameter

NameTypBeschreibung
rangesRange[]Die Bereiche, die in einem geschützten Tabellenblatt nicht geschützt bleiben sollen.

Rückflug

Protection – das Objekt, das die Schutzeinstellungen darstellt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setWarningOnly(warningOnly)

Gibt an, ob für diesen geschützten Bereich ein „warnbasierter“ Schutz verwendet wird. Bei einem warnbasierten Schutz können alle Nutzer Daten in diesem Bereich bearbeiten. Bei der Bearbeitung wird jedoch eine Warnung angezeigt, in der der Nutzer aufgefordert wird, die Änderung zu bestätigen. Standardmäßig sind geschützte Bereiche oder Tabellen nicht warnungsbasiert. Verwenden Sie isWarningOnly(), um den Warnstatus zu prüfen. 

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

Parameter

NameTypBeschreibung
warningOnlyBoolean

Rückflug

Protection – Das Objekt, das die Schutzeinstellungen darstellt, zum Verketten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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