Class Folder

תיקייה

תיקייה ב-Google Drive. אפשר לגשת לתיקיות או ליצור אותן דרך DriveApp.

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addEditor(emailAddress)	Folder	הוספת המשתמש הנתון לרשימת העורכים של Folder.
addEditor(user)	Folder	הוספת המשתמש הנתון לרשימת העורכים של Folder.
addEditors(emailAddresses)	Folder	הוספת מערך המשתמשים הנתון לרשימת העורכים של Folder.
addViewer(emailAddress)	Folder	הוספת המשתמש הנתון לרשימת הצופים ב-Folder.
addViewer(user)	Folder	הוספת המשתמש הנתון לרשימת הצופים ב-Folder.
addViewers(emailAddresses)	Folder	הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים ב-Folder.
createFile(blob)	File	יצירת קובץ בתיקייה הנוכחית מ-Blob נתונים שרירותיים.
createFile(name, content)	File	יצירת קובץ טקסט בתיקייה הנוכחית עם השם והתוכן שצוינו.
createFile(name, content, mimeType)	File	יצירת קובץ בתיקייה הנוכחית עם השם, התוכן וסוג ה-MIME שצוינו.
createFolder(name)	Folder	יצירת תיקייה בתיקייה הנוכחית עם השם שצוין.
createShortcut(targetId)	File	יצירת קיצור דרך למזהה הפריט ב-Drive שצוין והחזרתו.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)	File	יצירת קיצור דרך למזהה הפריט ומפתח המשאב שצוינו ב-Drive והחזרתו.
getAccess(email)	Permission	הפונקציה מקבלת את ההרשאה שהוענקה למשתמש ספציפי.
getAccess(user)	Permission	הפונקציה מקבלת את ההרשאה שהוענקה למשתמש ספציפי.
getDateCreated()	Date	הפונקציה מקבלת את התאריך שבו ה-Folder נוצר.
getDescription()	String	הפונקציה מקבלת את התיאור של ה-Folder.
getEditors()	User[]	הפונקציה מקבלת את רשימת העורכים של Folder הזה.
getFiles()	FileIterator	הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית.
getFilesByName(name)	FileIterator	הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את השם שצוין.
getFilesByType(mimeType)	FileIterator	הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את סוג ה-MIME שצוין.
getFolders()	FolderIterator	הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית.
getFoldersByName(name)	FolderIterator	הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ויש להן את השם שצוין.
getId()	String	הפונקציה מקבלת את המזהה של ה-Folder.
getLastUpdated()	Date	הפונקציה מקבלת את התאריך שבו Folder עודכן לאחרונה.
getName()	String	הפונקציה מקבלת את השם של ה-Folder.
getOwner()	User	הפונקציה מקבלת את הבעלים של ה-Folder הזה.
getParents()	FolderIterator	הפונקציה מקבלת אוסף של תיקיות שהן תיקיות הורה מיידיות של Folder.
getResourceKey()	String	הפונקציה מקבלת את מפתח המשאב של Folder שנדרש כדי לגשת לפריטים ששותפו באמצעות קישור.
getSecurityUpdateEligible()	Boolean	הפונקציה קובעת אם החשבון Folder עומד בדרישות להחלה של עדכון האבטחה, שמחייב קוד גישה כדי לגשת לקבצים כשהם משותפים באמצעות קישור.
getSecurityUpdateEnabled()	Boolean	הפונקציה מקבלת את הערך שמציין אם Folder הזה מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור.
getSharingAccess()	Access	הפונקציה מקבלת את סוג המשתמשים שיכולים לגשת ל-Folder, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
getSharingPermission()	Permission	הפונקציה מקבלת את ההרשאה שהוענקה למשתמשים שיכולים לגשת ל-Folder, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
getSize()	Integer	הפונקציה מקבלת את מספר הבייטים ששימשו לאחסון ה-Folder ב-Drive.
getUrl()	String	הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את Folder באפליקציית Google כמו Drive או Docs.
getViewers()	User[]	הפונקציה מקבלת את רשימת הצופים והמגיבים ב-Folder הזה.
isShareableByEditors()	Boolean	ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף עם משתמשים אחרים או לשנות את ההרשאות.
isStarred()	Boolean	קובעת אם ה-Folder סומן בכוכב ב-Drive של המשתמש.
isTrashed()	Boolean	קובעת אם הקובץ Folder נמצא באשפה ב-Drive של המשתמש.
moveTo(destination)	Folder	העברת הפריט הזה לתיקיית היעד שצוינה.
removeEditor(emailAddress)	Folder	הסרת המשתמש הנתון מרשימת העורכים של Folder.
removeEditor(user)	Folder	הסרת המשתמש הנתון מרשימת העורכים של Folder.
removeViewer(emailAddress)	Folder	הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Folder.
removeViewer(user)	Folder	הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Folder.
revokePermissions(emailAddress)	Folder	ביטול הגישה ל-Folder שהוקצה למשתמש הנתון.
revokePermissions(user)	Folder	ביטול הגישה ל-Folder שהוקצה למשתמש הנתון.
searchFiles(params)	FileIterator	הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ותואמים לקריטריוני החיפוש שצוינו.
searchFolders(params)	FolderIterator	הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ותואמות לקריטריוני החיפוש שצוינו.
setDescription(description)	Folder	הגדרת התיאור של Folder.
setName(name)	Folder	הגדרת השם של Folder.
setOwner(emailAddress)	Folder	שינוי הבעלים של Folder.
setOwner(user)	Folder	שינוי הבעלים של Folder.
setSecurityUpdateEnabled(enabled)	Folder	מגדיר אם Folder מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור.
setShareableByEditors(shareable)	Folder	ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף את הקובץ עם משתמשים אחרים או לשנות את ההרשאות.
setSharing(accessType, permissionType)	Folder	מגדיר לאילו משתמשים תהיה גישה ל-Folder ואילו הרשאות יוענקו להם, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
setStarred(starred)	Folder	מגדיר אם ה-Folder מסומן בכוכב ב-Drive של המשתמש.
setTrashed(trashed)	Folder	מגדיר אם ה-Folder נמצא באשפה ב-Drive של המשתמש.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
addFile(child)	Folder	הוספת הקובץ הנתון לתיקייה הנוכחית.
addFolder(child)	Folder	הוספת התיקייה הנתונה לתיקייה הנוכחית.
removeFile(child)	Folder	הסרת הקובץ הנתון מהתיקייה הנוכחית.
removeFolder(child)	Folder	הסרת התיקייה הנתונה מהתיקייה הנוכחית.

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

addEditor(emailAddress)

הוספת המשתמש הנתון לרשימת העורכים של Folder. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

addEditor(user)

הוספת המשתמש הנתון לרשימת העורכים של Folder. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

addEditors(emailAddresses)

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

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

addViewer(emailAddress)

הוספת המשתמש הנתון לרשימת הצופים ב-Folder. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

addViewer(user)

הוספת המשתמש הנתון לרשימת הצופים ב-Folder. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

addViewers(emailAddresses)

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

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

createFile(blob)

יצירת קובץ בתיקייה הנוכחית מ-Blob נתונים שרירותיים.

פרמטרים

שם	סוג	תיאור
blob	BlobSource	הנתונים של הקובץ החדש.

חזרה

File – הקובץ החדש.

אישור

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

• https://www.googleapis.com/auth/drive

---

createFile(name, content)

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

// Create a text file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');

פרמטרים

שם	סוג	תיאור
name	String	השם של הקובץ החדש.
content	String	התוכן של הקובץ החדש.

חזרה

File – הקובץ החדש.

אישור

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

• https://www.googleapis.com/auth/drive

---

createFile(name, content, mimeType)

יצירת קובץ בתיקייה הנוכחית עם השם, התוכן וסוג ה-MIME שצוינו. אם content גדול מ-10MB, מתרחשת זריקה של חריגה.

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

פרמטרים

שם	סוג	תיאור
name	String	השם של הקובץ החדש.
content	String	התוכן של הקובץ החדש.
mimeType	String	סוג ה-MIME של הקובץ החדש.

חזרה

File – הקובץ החדש.

אישור

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

• https://www.googleapis.com/auth/drive

---

createFolder(name)

יצירת תיקייה בתיקייה הנוכחית עם השם שצוין.

פרמטרים

שם	סוג	תיאור
name	String	השם של התיקייה החדשה.

חזרה

Folder — התיקייה החדשה.

אישור

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

• https://www.googleapis.com/auth/drive

---

createShortcut(targetId)

יצירת קיצור דרך למזהה הפריט ב-Drive שצוין והחזרתו.

פרמטרים

שם	סוג	תיאור
targetId	String	מזהה הקובץ של קובץ היעד או תיקיית היעד.

חזרה

File — קיצור הדרך החדש.

אישור

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

• https://www.googleapis.com/auth/drive

---

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

יצירת קיצור דרך למזהה הפריט ומפתח המשאב שצוינו ב-Drive והחזרתו. מפתח משאב הוא פרמטר נוסף שצריך להעביר כדי לגשת לקובץ או לתיקיית היעד ששותפו באמצעות קישור.

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

פרמטרים

שם	סוג	תיאור
targetId	String	המזהה של הקובץ או התיקייה של היעד.
targetResourceKey	String	מפתח המשאב של קובץ היעד או תיקיית היעד.

חזרה

File — קיצור הדרך החדש.

אישור

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

• https://www.googleapis.com/auth/drive

---

getAccess(email)

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

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של המשתמש שרוצים לבדוק את ההרשאות שלו. אין תמיכה בקבוצות Google.

חזרה

Permission – ההרשאות שהוקצו למשתמש.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getAccess(user)

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

פרמטרים

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

חזרה

Permission – ההרשאות שהוקצו למשתמש.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getDateCreated()

הפונקציה מקבלת את התאריך שבו ה-Folder נוצר.

חזרה

Date – התאריך שבו נוצר ה-Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getDescription()

הפונקציה מקבלת את התיאור של ה-Folder.

חזרה

String – התיאור של Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getEditors()

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

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

חזרה

User[] — רשימת העורכים של Folder הזה, אם למשתמש יש הרשאת עריכה, או מערך ריק במקרה אחר.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getFiles()

הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית.

חזרה

FileIterator – אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getFilesByName(name)

הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את השם שצוין.

פרמטרים

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

חזרה

FileIterator — אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ויש להם את השם הנתון.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getFilesByType(mimeType)

הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את סוג ה-MIME שצוין.

פרמטרים

שם	סוג	תיאור
mimeType	String	סוג ה-MIME של הקבצים שרוצים למצוא.

חזרה

FileIterator — אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את סוג ה-MIME הנתון.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getFolders()

הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית.

חזרה

FolderIterator – אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getFoldersByName(name)

הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ויש להן את השם שצוין.

פרמטרים

שם	סוג	תיאור
name	String	השם של התיקיות שרוצים למצוא.

חזרה

FolderIterator — אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ויש להן את השם הנתון.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getId()

הפונקציה מקבלת את המזהה של ה-Folder.

חזרה

String – המזהה של Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getLastUpdated()

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

חזרה

Date – התאריך שבו Folder עודכן לאחרונה

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getName()

הפונקציה מקבלת את השם של ה-Folder.

חזרה

String – השם של Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getOwner()

הפונקציה מקבלת את הבעלים של ה-Folder הזה.

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

חזרה

User – הבעלים של Folder הזה.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getParents()

הפונקציה מקבלת אוסף של תיקיות שהן תיקיות הורה מיידיות של Folder.

חזרה

FolderIterator – אוסף של תיקיות שהן הורים מיידיים של Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getResourceKey()

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

חזרה

String – מפתח המשאב של Folder.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getSecurityUpdateEligible()

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

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

מידע נוסף על עדכון האבטחה ל-Google Drive

חזרה

Boolean – האם ניתן להחיל את הדרישה למפתח המשאב על Folder.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getSecurityUpdateEnabled()

הפונקציה מקבלת את הערך שמציין אם Folder הזה מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. הדרישה הזו מופעלת כברירת מחדל בקבצים ובתיקיות שעומדים בדרישות. כדי להפעיל או להשבית את הדרישה למפתח משאב בקבצים שעומדים בדרישות, משתמשים ב- setSecurityUpdateEnabled.

מידע נוסף על עדכון האבטחה ל-Google Drive

חזרה

Boolean – האם הדרישה למפתח משאב מופעלת עבור Folder הזה.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getSharingAccess()

הפונקציה מקבלת את סוג המשתמשים שיכולים לגשת ל-Folder, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.

חזרה

Access – קבוצת המשתמשים שיכולה לגשת ל-Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getSharingPermission()

הפונקציה מקבלת את ההרשאה שהוענקה למשתמשים שיכולים לגשת ל-Folder, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.

חזרה

Permission – ההרשאות שהוקצו למשתמשים שיש להם גישה ל-Folder

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getSize()

הפונקציה מקבלת את מספר הבייטים ששימשו לאחסון ה-Folder ב-Drive. חשוב לזכור שקבצים של אפליקציות Google Workspace לא נכללים במגבלות האחסון ב-Drive, ולכן המערכת מחזירה 0 בייטים.

חזרה

Integer – מספר הבייטים ששימשו לאחסון ה-Folder ב-Drive

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getUrl()

הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את Folder באפליקציית Google כמו Drive או Docs.

חזרה

String – כתובת ה-URL שבאמצעותה אפשר להציג את Folder באפליקציית Google כמו Drive או Docs

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

getViewers()

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

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

חזרה

User[] — רשימת הצופים והמגיבים ב-Folder הזה, אם למשתמש יש הרשאת עריכה, או מערך ריק אחרת.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

isShareableByEditors()

ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף עם משתמשים אחרים או לשנות את ההרשאות.

חזרה

Boolean — true אם משתמשים עם הרשאת עריכה מורשים לשתף עם משתמשים אחרים או לשנות את ההרשאות, false אם לא

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

isStarred()

קובעת אם ה-Folder סומן בכוכב ב-Drive של המשתמש.

חזרה

Boolean — true אם ה-Folder מסומן בכוכב ב-Drive של המשתמש, false אם לא

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

isTrashed()

קובעת אם הקובץ Folder נמצא באשפה ב-Drive של המשתמש.

חזרה

Boolean — true אם ה-Folder נמצא באשפה של Drive של המשתמש, false אם לא

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

moveTo(destination)

העברת הפריט הזה לתיקיית היעד שצוינה.

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

פרמטרים

שם	סוג	תיאור
destination	Folder	התיקייה שתהפוך לתיקיית האב החדשה.

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeEditor(emailAddress)

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeEditor(user)

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeViewer(emailAddress)

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

בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.

פרמטרים

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

חזרה

Folder — Folder לשרשור.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeViewer(user)

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

בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.

פרמטרים

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

חזרה

Folder — Folder לשרשור.

אישור

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

• https://www.googleapis.com/auth/drive

---

revokePermissions(emailAddress)

ביטול הגישה ל-Folder שהוקצה למשתמש הנתון. השיטה הזו לא מונעת ממשתמשים לגשת ל-Folder אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Folder משותף עם כל הדומיין של המשתמש.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

revokePermissions(user)

ביטול הגישה ל-Folder שהוקצה למשתמש הנתון. השיטה הזו לא מונעת ממשתמשים לגשת ל-Folder אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Folder משותף עם כל הדומיין של המשתמש.

פרמטרים

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

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

searchFiles(params)

הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ותואמים לקריטריוני החיפוש שצוינו. הקריטריונים לחיפוש מפורטים במסמכי התיעוד של Google Drive SDK. חשוב לזכור ששירות Drive משתמש בגרסה 2 של Drive API, וששדות מסוימים של שאילתות שונים מגרסה 3. הבדלים בין השדות של גרסה 2 לגרסה 3

הארגומנט params הוא מחרוזת שאילתה שיכולה להכיל ערכים של מחרוזות, לכן חשוב להקפיד להשתמש במרכאות כפולות בצורה נכונה (לדוגמה "title contains 'Gulliver\\'s Travels'" או 'title contains "Gulliver\'s Travels"').

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

פרמטרים

שם	סוג	תיאור
params	String	קריטריונים לחיפוש, כפי שמפורטים במסמכי התיעוד של Google Drive SDK.

חזרה

FileIterator – אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ותואמים לקריטריונים לחיפוש.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

searchFolders(params)

הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ותואמות לקריטריוני החיפוש שצוינו. הקריטריונים לחיפוש מפורטים במסמכי התיעוד של Google Drive SDK. חשוב לזכור ששירות Drive משתמש בגרסה 2 של Drive API, וששדות מסוימים של שאילתות שונים מגרסה 3. הבדלים בין השדות של גרסה 2 לגרסה 3

הארגומנט params הוא מחרוזת שאילתה שיכולה להכיל ערכים של מחרוזות, לכן חשוב להקפיד להשתמש במרכאות כפולות בצורה נכונה (לדוגמה "title contains 'Gulliver\\'s Travels'" או 'title contains "Gulliver\'s Travels"').

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

פרמטרים

שם	סוג	תיאור
params	String	קריטריונים לחיפוש, כפי שמפורטים במסמכי התיעוד של Google Drive SDK.

חזרה

FolderIterator – אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ותואמות לקריטריונים לחיפוש.

אישור

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

• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive

---

setDescription(description)

הגדרת התיאור של Folder.

פרמטרים

שם	סוג	תיאור
description	String	התיאור החדש של Folder

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setName(name)

הגדרת השם של Folder.

פרמטרים

שם	סוג	תיאור
name	String	השם החדש של Folder

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setOwner(emailAddress)

שינוי הבעלים של Folder. השיטה הזו גם מעניקה לבעלים הקודם הרשאת עריכה מפורשת ב-Folder.

פרמטרים

שם	סוג	תיאור
emailAddress	String	כתובת האימייל של המשתמש שצריך להפוך לבעלים החדש

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setOwner(user)

שינוי הבעלים של Folder. השיטה הזו גם מעניקה לבעלים הקודם הרשאת עריכה מפורשת ב-Folder.

פרמטרים

שם	סוג	תיאור
user	User	ייצוג של המשתמש שצריך להפוך לבעלים החדש

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setSecurityUpdateEnabled(enabled)

מגדיר אם Folder מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. קבצים ותיקיות שעומדים בדרישות מופעלים כברירת מחדל.

מידע נוסף על עדכון האבטחה ל-Google Drive

פרמטרים

שם	סוג	תיאור
enabled	Boolean	האם להפעיל את הדרישה למפתח משאב עבור Folder.

חזרה

Folder — השדה Folder, לצורך קישור.

אישור

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

• https://www.googleapis.com/auth/drive

---

setShareableByEditors(shareable)

ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף את הקובץ עם משתמשים אחרים או לשנות את ההרשאות. ערך ברירת המחדל של Folder חדש הוא true.

פרמטרים

שם	סוג	תיאור
shareable	Boolean	true אם משתמשים עם הרשאת עריכה יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות, false אם לא

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setSharing(accessType, permissionType)

מגדיר לאילו משתמשים תהיה גישה ל-Folder ואילו הרשאות יוענקו להם, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

פרמטרים

שם	סוג	תיאור
accessType	Access	לאילו משתמשים צריכה להיות גישה ל-Folder
permissionType	Permission	ההרשאות שצריך להקצות למשתמשים שיש להם גישה ל-Folder

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setStarred(starred)

מגדיר אם ה-Folder מסומן בכוכב ב-Drive של המשתמש. ערך ברירת המחדל של Folder חדש הוא false.

פרמטרים

שם	סוג	תיאור
starred	Boolean	true אם צריך לסמן את Folder בכוכב ב-Drive של המשתמש, false אם לא

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

---

setTrashed(trashed)

מגדיר אם ה-Folder נמצא באשפה ב-Drive של המשתמש. רק הבעלים יכול להעביר את Folder לאשפה. ערך ברירת המחדל של Folder חדשים הוא false.

פרמטרים

שם	סוג	תיאור
trashed	Boolean	true אם צריך להעביר את Folder לאשפה ב-Drive של המשתמש, false אם לא

חזרה

Folder — ה-Folder הזה, לשרשור

אישור

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

• https://www.googleapis.com/auth/drive

שיטות שהוצאו משימוש

addFile(child)

הוצא משימוש. במקום זאת, צריך להשתמש ב-File.moveTo(destination) או ב-createShortcut(targetId).

הוספת הקובץ הנתון לתיקייה הנוכחית. השיטה הזו לא מעבירה את הקובץ מתיקיית האב הקיימת שלו. לקובץ יכולות להיות כמה תיקיות אם בו-זמנית.

פרמטרים

שם	סוג	תיאור
child	File	קובץ הצאצא שרוצים להוסיף.

חזרה

Folder – ההורה החדש של הקובץ שנוסף כצאצא.

אישור

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

• https://www.googleapis.com/auth/drive

---

addFolder(child)

הוצא משימוש. במקום זאת, צריך להשתמש ב-moveTo(destination) או ב-createShortcut(targetId).

הוספת התיקייה הנתונה לתיקייה הנוכחית. השיטה הזו לא מעבירה את התיקייה מתיקיית ההורה הקיימת שלה. לתיקייה יכולה להיות יותר מתיקיית הורה אחת בו-זמנית.

פרמטרים

שם	סוג	תיאור
child	Folder	תיקיית הצאצא שרוצים להוסיף.

חזרה

Folder – ההורה החדש של התיקייה שנוספה כצאצא.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeFile(child)

הוצא משימוש. במקום זאת, צריך להשתמש ב-File.moveTo(destination).

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

פרמטרים

שם	סוג	תיאור
child	File	קובץ הצאצא שרוצים להסיר.

חזרה

Folder – ההורה הקודם של הילד או הילדה.

אישור

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

• https://www.googleapis.com/auth/drive

---

removeFolder(child)

הוצא משימוש. במקום זאת, צריך להשתמש ב-moveTo(destination).

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

פרמטרים

שם	סוג	תיאור
child	Folder	התיקייה הצאצאית שרוצים להסיר.

חזרה

Folder – ההורה הקודם של הילד או הילדה.

אישור

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

• https://www.googleapis.com/auth/drive