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

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

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

חזרה

Folder – ה-Folder הזה לשרשור.

אישור

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

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

`removeViewer(user)`

הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Folder. הזה ל-method אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת למשתמשים לגשת אל 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. בודקים את השדה ההבדלים בין גרסה 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.""
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. בודקים את השדה ההבדלים בין גרסה 2 ל-3.

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