דף זה תורגם על ידי Cloud Translation API.

Class Folder

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

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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)`

פרמטרים

שם	תיאור	התיאור
`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 נתון של נתונים שרירותיים.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(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)`

הפונקציה מקבלת את ההרשאה שהוענקה למשתמש הנתון.

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש לבדוק את ההרשאות שלו

החזרות

Permission – ההרשאות שהוענקו למשתמש

הרשאות

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

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

`getAccess(user)`

הפונקציה מקבלת את ההרשאה שהוענקה למשתמש הנתון.

פרמטרים

שם	תיאור	התיאור
`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 (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, ה-method הזה מחזיר מערך ריק.

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

בקובצי 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)`

פרמטרים

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

החזרות

Folder – Folder, לשרשור.

הרשאות

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

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

`searchFiles(params)`

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

הארגומנט 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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var 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, וחלק משדות השאילתה שונים מ-v3. בודקים את ההבדלים בשדות בין v2 ל-v3.

// Logs the name of every folder that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var 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.)
var 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