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הפונקציה מחזירה את הערך true אם נדרש מפתח משאב כדי לגשת ל-Folder כשמשתפים אותו באמצעות קישור, אחרת היא מחזירה את הערך false.
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 של המשתמש.

תיעוד מפורט

addEditor(emailAddress)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

addEditor(user)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

addEditors(emailAddresses)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

addViewer(emailAddress)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

addViewer(user)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

addViewers(emailAddresses)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

createFile(blob)

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

פרמטרים

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

חזרה

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!');

פרמטרים

שםסוגתיאור
nameStringהשם של הקובץ החדש.
contentStringהתוכן של הקובץ החדש.

חזרה

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

פרמטרים

שםסוגתיאור
nameStringהשם של הקובץ החדש.
contentStringהתוכן של הקובץ החדש.
mimeTypeStringסוג ה-MIME של הקובץ החדש.

חזרה

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

אישור

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

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

createFolder(name)

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

פרמטרים

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

חזרה

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

אישור

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

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

createShortcut(targetId)

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

אישור

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

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

getAccess(email)

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

פרמטרים

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

חזרה

Permission – ההרשאות שניתנו למשתמש.

אישור

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

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

getAccess(user)

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

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שההרשאות שלו צריכות להיבדק.

חזרה

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)

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

פרמטרים

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

חזרה

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

אישור

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

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

getFilesByType(mimeType)

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

פרמטרים

שםסוגתיאור
mimeTypeStringסוג ה-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)

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

פרמטרים

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

חזרה

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

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

חזרה

Booleantrue אם משתמשים עם הרשאת עריכה יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות; false אם לא

אישור

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

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

isStarred()

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

חזרה

Booleantrue אם Folder מסומן בכוכב ב-Drive של המשתמש; false אם לא

אישור

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

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

isTrashed()

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

חזרה

Booleantrue אם Folder נמצא באשפה של המשתמש ב-Drive; ‫false אם לא

אישור

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

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

moveTo(destination)

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

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

removeEditor(emailAddress)

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

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

removeEditor(user)

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

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

removeViewer(emailAddress)

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

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

פרמטרים

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

חזרה

Folder — This Folder for chaining.

אישור

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

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

removeViewer(user)

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

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

פרמטרים

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

חזרה

Folder — This Folder for chaining.

אישור

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

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

revokePermissions(emailAddress)

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

revokePermissions(user)

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

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שהגישה שלו צריכה להישלל.

חזרה

FolderFolder, לשרשור.

אישור

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

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

פרמטרים

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

פרמטרים

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

חזרה

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

אישור

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

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

setDescription(description)

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

פרמטרים

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

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

setName(name)

מגדיר את השם של Folder.

פרמטרים

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

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

setOwner(emailAddress)

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

ב-Drive אי אפשר לשנות את הבעלות על פריטים שנמצאים בבעלות של חשבונות gmail.com. האפשרות הזו נתמכת בחשבונות Workspace.

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

setOwner(user)

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

ב-Drive אי אפשר לשנות את הבעלות על פריטים שנמצאים בבעלות של חשבונות gmail.com. האפשרות הזו נתמכת בחשבונות Workspace.

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

setSecurityUpdateEnabled(enabled)

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

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

פרמטרים

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

חזרה

FolderFolder, לשרשור.

אישור

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

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

setShareableByEditors(shareable)

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

פרמטרים

שםסוגתיאור
shareableBooleantrue אם רוצים לאפשר למשתמשים עם הרשאת עריכה לשתף עם משתמשים אחרים או לשנות את ההרשאות; false אם לא רוצים לאפשר זאת

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

פרמטרים

שםסוגתיאור
accessTypeAccessלאיזו קבוצת משתמשים תהיה גישה ל-Folder
permissionTypePermissionההרשאות שצריך להעניק למשתמשים שיכולים לגשת אל Folder

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

setStarred(starred)

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

פרמטרים

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

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

setTrashed(trashed)

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

פרמטרים

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

חזרה

FolderFolder הזה, לשרשור

אישור

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

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

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