Class Protection

הגנה

גישה לגיליונות ולטווחים מוגנים ושינוי שלהם. טווח מוגן יכול להגן על טווח סטטי של תאים או על טווח בעל שם. גיליון מוגן יכול לכלול אזורים לא מוגנים. לגיליונות אלקטרוניים שנוצרו בגרסה הישנה של Google Sheets, צריך להשתמש במקום זאת בכיתה 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);
}

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addEditor(emailAddress)	Protection	הוספת המשתמש הנתון לרשימת העורכים של הגיליון או הטווח המוגנים.
addEditor(user)	Protection	הוספת המשתמש הנתון לרשימת העורכים של הגיליון או הטווח המוגנים.
addEditors(emailAddresses)	Protection	הוספת מערך המשתמשים הנתון לרשימת העורכים של הגיליון או הטווח המוגנים.
addTargetAudience(audienceId)	Protection	הוספת קהל היעד שצוין כעורך של הטווח המוגן.
canDomainEdit()	Boolean	ההגדרה קובעת אם לכל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני יש הרשאה לערוך את הטווח או הגיליון המוגנים.
canEdit()	Boolean	קובעת אם למשתמש יש הרשאה לערוך את הטווח או את הגיליון המוגנים.
getDescription()	String	הפונקציה מקבלת את התיאור של הטווח או הגיליון המוגן.
getEditors()	User[]	הפונקציה מקבלת את רשימת העורכים של הטווח או הגיליון המוגנים.
getProtectionType()	ProtectionType	הפונקציה מקבלת את הסוג של האזור המוגן, RANGE או SHEET.
getRange()	Range	הפונקציה מקבלת את הטווח המוגן.
getRangeName()	String	הפונקציה מקבלת את השם של הטווח המוגן אם הוא משויך לטווח בעל שם.
getTargetAudiences()	TargetAudience[]	הפונקציה מחזירה את המזהים של קהלים היעד שיכולים לערוך את הטווח המוגן.
getUnprotectedRanges()	Range[]	הפונקציה מקבלת מערך של טווחים לא מוגנים בתוך גיליון מוגן.
isWarningOnly()	Boolean	קובע אם באזור המוגן מופעלת הגנה 'מבוססת אזהרה'.
remove()	void	הסרת ההגנה מהטווח או מהגיליון.
removeEditor(emailAddress)	Protection	הסרת המשתמש מהרשימה של עורכי הגיליון או הטווח המוגנים.
removeEditor(user)	Protection	הסרת המשתמש מהרשימה של עורכי הגיליון או הטווח המוגנים.
removeEditors(emailAddresses)	Protection	הפונקציה מסירה את מערך המשתמשים הנתון מרשימת העורכים של הגיליון או הטווח המוגנים.
removeTargetAudience(audienceId)	Protection	מסיר את קהל היעד שצוין כבעלים של הרשאת עריכה בטווח המוגן.
setDescription(description)	Protection	הגדרת התיאור של הטווח או הגיליון המוגנים.
setDomainEdit(editable)	Protection	ההגדרה קובעת אם לכל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני תהיה הרשאה לערוך את הטווח או הגיליון המוגנים.
setNamedRange(namedRange)	Protection	שיוך של טווח המוגן לטווח בעל שם קיים.
setRange(range)	Protection	שינוי הטווח המוגן.
setRangeName(rangeName)	Protection	שיוך של טווח המוגן לטווח בעל שם קיים.
setUnprotectedRanges(ranges)	Protection	ביטול ההגנה על מערך נתון של טווחים בתוך גיליון מוגן.
setWarningOnly(warningOnly)	Protection	ההגדרה קובעת אם בטווח המוגן הזה נעשה שימוש בהגנה 'מבוססת אזהרה'.

מסמכים מפורטים

addEditor(emailAddress)

הוספת המשתמש הנתון לרשימת העורכים של הגיליון או הטווח המוגנים. השיטה הזו לא מעניקה למשתמש הרשאה לערוך את הגיליון האלקטרוני עצמו באופן אוטומטי. כדי לעשות זאת, צריך גם לבצע קריאה ל-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('[e-mail]');

// 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('[e-mail]');

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

פרמטרים

שם	סוג	תיאור
emailAddress	String	כתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

addEditor(user)

הוספת המשתמש הנתון לרשימת העורכים של הגיליון או הטווח המוגנים. השיטה הזו לא מעניקה למשתמש הרשאה לערוך את הגיליון האלקטרוני עצמו באופן אוטומטי. כדי לעשות זאת, צריך גם לבצע קריאה ל-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());
}

פרמטרים

שם	סוג	תיאור
user	User	ייצוג של המשתמש שרוצים להוסיף.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

addEditors(emailAddresses)

הוספת מערך המשתמשים הנתון לרשימת העורכים של הגיליון או הטווח המוגנים. השיטה הזו לא מעניקה למשתמשים הרשאה לערוך את הגיליון האלקטרוני עצמו באופן אוטומטי. כדי לעשות זאת, צריך להפעיל גם את 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 = '[e-mail]';
const TEST_EMAIL_2 = '[e-mail]';

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

פרמטרים

שם	סוג	תיאור
emailAddresses	String[]	מערך של כתובות האימייל של המשתמשים שרוצים להוסיף.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

addTargetAudience(audienceId)

הוספת קהל היעד שצוין כעורך של הטווח המוגן.

פרמטרים

שם	סוג	תיאור
audienceId	String	המזהה של קהל היעד שרוצים להוסיף.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

canDomainEdit()

ההגדרה קובעת אם לכל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני יש הרשאה לערוך את הטווח או הגיליון המוגנים. הפונקציה מפעילה חריגה אם למשתמש אין הרשאה לערוך את הטווח או את הגיליון המוגנים.

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

חזרה

Boolean — true אם לכל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני יש הרשאה לערוך את הטווח או הגיליון המוגנים, false אם אין להם.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

canEdit()

קובעת אם למשתמש יש הרשאה לערוך את הטווח או את הגיליון המוגנים. הבעלים של הגיליון האלקטרוני תמיד יכול לערוך גיליונות וטווחים מוגנים.

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

חזרה

Boolean — true אם למשתמש יש הרשאה לערוך את הטווח או הגיליון המוגנים, false אם לא

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getDescription()

הפונקציה מקבלת את התיאור של הטווח או הגיליון המוגן. אם לא מגדירים תיאור, השיטה מחזירה מחרוזת ריקה.

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

חזרה

String – התיאור של הטווח או הגיליון המוגנים, או מחרוזת ריקה אם לא מוגדר תיאור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getEditors()

הפונקציה מקבלת את רשימת העורכים של הטווח או הגיליון המוגנים. הפונקציה מפעילה חריגה אם למשתמש אין הרשאה לערוך את הטווח או את הגיליון המוגנים.

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

חזרה

User[] – מערך של משתמשים שיש להם הרשאה לערוך את הטווח או את הגיליון המוגן

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getProtectionType()

הפונקציה מקבלת את הסוג של האזור המוגן, RANGE או 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());

חזרה

ProtectionType – סוג האזור המוגן, RANGE או SHEET.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getRange()

הפונקציה מקבלת את הטווח המוגן. אם ההגנה חלה על הגיליון במקום על טווח, ה-method מחזיר טווח שמשתרע על כל הגיליון.

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

חזרה

Range – הטווח המוגן.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getRangeName()

הפונקציה מקבלת את השם של הטווח המוגן אם הוא משויך לטווח בעל שם. הפונקציה מחזירה את הערך null אם ההגנה לא משויכת לטווח בעל שם. חשוב לזכור שצריך להפעיל את הפונקציה setRangeName(rangeName) באופן מפורש כדי לשייך טווח מוגן לטווח בעל שם. קריאה לפונקציה Range.protect() כדי ליצור הגנה מ-Range שהוא במקרה טווח בעל שם, בלי להפעיל את הפונקציה setRangeName(rangeName), לא מספיקה כדי לשייך אותם. עם זאת, יצירת טווח מוגן מטווח בעל שם בממשק המשתמש של Google Sheets גורמת לשיוך אוטומטי שלהם.

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

חזרה

String – השם של הטווח המוגן בעל השם, או null אם הטווח המוגן לא משויך לטווח בעל שם

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getTargetAudiences()

הפונקציה מחזירה את המזהים של קהלים היעד שיכולים לערוך את הטווח המוגן.

חזרה

TargetAudience[] – מערך של המזהים של משתמשי היעד.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

getUnprotectedRanges()

הפונקציה מקבלת מערך של טווחים לא מוגנים בתוך גיליון מוגן. אם האובייקט Protection תואם לטווח מוגן במקום לגיליון מוגן, השיטה מחזירה מערך ריק. כדי לשנות את הטווחים הלא מוגנים, משתמשים ב-setUnprotectedRanges(ranges) כדי להגדיר מערך חדש של טווחים. כדי להגן מחדש על כל הגיליון, מגדירים מערך ריק.

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

חזרה

Range[] – מערך של טווחים לא מוגנים בתוך גיליון מוגן

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

isWarningOnly()

קובע אם באזור המוגן מופעלת הגנה 'מבוססת אזהרה'. הגנה מבוססת-אזהרה פירושה שכל משתמש יכול לערוך את הנתונים באזור, אבל לפני ביצוע העריכה מופיעה אזהרה שמבקשת מהמשתמש לאשר את העריכה. כברירת מחדל, טווחים או גיליונות מוגנים לא מבוססים על אזהרות. כדי לעבור למצב אזהרה, משתמשים ב-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);

חזרה

Boolean — true אם בטווח או בגיליון המוגן מוגדרת רק הגנה מבוססת-אזהרה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

remove()

הסרת ההגנה מהטווח או מהגיליון.

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

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

removeEditor(emailAddress)

הסרת המשתמש מהרשימה של עורכי הגיליון או הטווח המוגנים. שימו לב: אם המשתמש חבר בקבוצת Google שיש לה הרשאת עריכה, או אם לכל המשתמשים בדומיין יש הרשאת עריכה, המשתמש עדיין יוכל לערוך את האזור המוגן. אי אפשר להסיר את הבעלים של הגיליון האלקטרוני או את המשתמש הנוכחי.

// 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 = '[e-mail]';

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

פרמטרים

שם	סוג	תיאור
emailAddress	String	כתובת האימייל של המשתמש שרוצים להסיר.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

removeEditor(user)

הסרת המשתמש מהרשימה של עורכי הגיליון או הטווח המוגנים. שימו לב: אם המשתמש חבר בקבוצת Google שיש לה הרשאת עריכה, או אם לכל המשתמשים בדומיין יש הרשאת עריכה, המשתמש עדיין יוכל לערוך את האזור המוגן. אי אפשר להסיר את הבעלים של הגיליון האלקטרוני או את המשתמש הנוכחי.

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

פרמטרים

שם	סוג	תיאור
user	User	ייצוג של המשתמש שרוצים להסיר.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

removeEditors(emailAddresses)

הפונקציה מסירה את מערך המשתמשים הנתון מרשימת העורכים של הגיליון או הטווח המוגנים. חשוב לזכור: אם אחד מהמשתמשים הוא חבר בקבוצת Google שיש לה הרשאת עריכה, או אם לכל המשתמשים בדומיין יש הרשאת עריכה, הם עדיין יוכלו לערוך את האזור המוגן. אי אפשר להסיר את הבעלים של הגיליון האלקטרוני או את המשתמש הנוכחי.

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

פרמטרים

שם	סוג	תיאור
emailAddresses	String[]	מערך של כתובות האימייל של המשתמשים שרוצים להסיר.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

removeTargetAudience(audienceId)

מסיר את קהל היעד שצוין כבעלים של הרשאת עריכה בטווח המוגן.

פרמטרים

שם	סוג	תיאור
audienceId	String	המזהה של קהל היעד שרוצים להסיר.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setDescription(description)

הגדרת התיאור של הטווח או הגיליון המוגנים.

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

פרמטרים

שם	סוג	תיאור
description	String	התיאור של הטווח או הגיליון המוגנים.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setDomainEdit(editable)

ההגדרה קובעת אם לכל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני תהיה הרשאה לערוך את הטווח או הגיליון המוגנים. חשוב לזכור שכל משתמש שיש לו הרשאת עריכה מפורשת יכול לערוך את האזור המוגן, ללא קשר להגדרה הזו. הפונקציה מפעילה חריגה אם הגיליון האלקטרוני לא שייך לדומיין של Google Workspace (כלומר, אם הוא בבעלות של חשבון gmail.com).

פרמטרים

שם	סוג	תיאור
editable	Boolean	true אם כל המשתמשים בדומיין שבבעלותו הגיליון האלקטרוני צריכים לקבל הרשאה לערוך את הטווח או את הגיליון המוגנים, false אם לא.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setNamedRange(namedRange)

שיוך של טווח המוגן לטווח בעל שם קיים. אם הטווח בעל השם מכסה אזור שונה מהטווח המוגן הנוכחי, השיטה הזו מעבירה את ההגנה כך שתכלול את הטווח בעל השם במקום זאת. טווח השם חייב להיות באותו גיליון שבו נמצא טווח ההגנה הנוכחי. שימו לב שצריך להפעיל את השיטה הזו באופן מפורש בסקריפטים כדי לשייך טווח מוגן לטווח בעל שם. קריאה ל-Range.protect() כדי ליצור הגנה מ-Range שהוא במקרה טווח בעל שם, בלי להפעיל את setRangeName(rangeName), לא מספיקה כדי לשייך ביניהם. עם זאת, יצירת טווח מוגן מטווח בעל שם בממשק המשתמש של Google Sheets גורמת לשיוך אוטומטי שלהם.

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

פרמטרים

שם	סוג	תיאור
namedRange	NamedRange	טווח התאים המוגן הקיים שרוצים לשייך לטווח המוגן.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setRange(range)

שינוי הטווח המוגן. אם הטווח שצוין מכסה אזור שונה מהטווח המוגן הנוכחי, השיטה הזו מעבירה את ההגנה כך שתכלול את הטווח החדש במקום זאת.

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

פרמטרים

שם	סוג	תיאור
range	Range	הטווח החדש שרוצים להגן עליו מפני עריכות.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setRangeName(rangeName)

שיוך של טווח המוגן לטווח בעל שם קיים. אם הטווח בעל השם מכסה אזור שונה מהטווח המוגן הנוכחי, השיטה הזו מעבירה את ההגנה כך שתכלול את הטווח בעל השם במקום זאת. טווח השם חייב להיות באותו גיליון שבו נמצא טווח ההגנה הנוכחי. שימו לב שצריך להפעיל את השיטה הזו באופן מפורש בסקריפטים כדי לשייך טווח מוגן לטווח בעל שם. קריאה ל-Range.protect() כדי ליצור הגנה מ-Range שהוא במקרה טווח בעל שם, בלי להפעיל את setRangeName(rangeName), לא מספיקה כדי לשייך ביניהם. עם זאת, יצירת טווח מוגן מטווח בעל שם בממשק המשתמש של Google Sheets גורמת לשיוך אוטומטי שלהם.

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

פרמטרים

שם	סוג	תיאור
rangeName	String	השם של טווח התאים המוגן.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setUnprotectedRanges(ranges)

ביטול ההגנה על מערך נתון של טווחים בתוך גיליון מוגן. הפונקציה מפעילה חריגה אם האובייקט Protection תואם לטווח מוגן במקום לגיליון מוגן, או אם אחד מהטווחים לא נמצא בגיליון המוגן. כדי לשנות את הטווח הלא מוגן, מגדירים מערך חדש של טווחים. כדי להגן מחדש על כל הגיליון, מגדירים מערך ריק.

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

פרמטרים

שם	סוג	תיאור
ranges	Range[]	מערך הטווחים שרוצים להשאיר לא מוגנים בתוך גיליון מוגן.

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

---

setWarningOnly(warningOnly)

ההגדרה קובעת אם בטווח המוגן הזה נעשה שימוש בהגנה 'מבוססת אזהרה'. הגנה מבוססת-אזהרה פירושה שכל משתמש יכול לערוך נתונים באזור, אבל לפני ביצוע העריכה מופיעה אזהרה שמבקשת מהמשתמש לאשר את העריכה. כברירת מחדל, טווחים או גיליונות מוגנים לא מבוססים על אזהרות. כדי לבדוק את מצב האזהרה, משתמשים ב-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());

פרמטרים

שם	סוג	תיאור
warningOnly	Boolean

חזרה

Protection – האובייקט שמייצג את הגדרות ההגנה, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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