Class Folder

תיקייה

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

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

Methods

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

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

addEditor(emailAddress)

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

פרמטרים

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

חזרה

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

אישור

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

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

addEditor(user)

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

פרמטרים

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

חזרה

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

אישור

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

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

addEditors(emailAddresses)

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

פרמטרים

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

חזרה

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

אישור

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

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

addViewer(emailAddress)

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

פרמטרים

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

חזרה

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

אישור

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

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

addViewer(user)

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

פרמטרים

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

חזרה

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

אישור

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

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

addViewers(emailAddresses)

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

פרמטרים

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

חזרה

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

אישור

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

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

חזרה

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

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

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

חזרה

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

אישור

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

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

getSharingAccess()

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

חזרה

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

אישור

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

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

getSharingPermission()

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

חזרה

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

אישור

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

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

getSize()

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

חזרה

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

אישור

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

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

getUrl()

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

חזרה

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

אישור

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

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

getViewers()

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

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

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

חזרה

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

אישור

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

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

isShareableByEditors()

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

חזרה

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

אישור

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

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

isStarred()

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

חזרה

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

אישור

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

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

isTrashed()

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

חזרה

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

אישור

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

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

moveTo(destination)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

removeEditor(emailAddress)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

removeEditor(user)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

removeViewer(emailAddress)

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

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

פרמטרים

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

חזרה

Folder — Folder לשרשור.

אישור

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

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

removeViewer(user)

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

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

פרמטרים

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

חזרה

Folder — Folder לשרשור.

אישור

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

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

revokePermissions(emailAddress)

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

פרמטרים

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

חזרה

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

אישור

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

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

revokePermissions(user)

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

פרמטרים

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

חזרה

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

אישור

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

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

searchFiles(params)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setName(name)

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

פרמטרים

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

חזרה

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

אישור

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

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

setOwner(emailAddress)

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

פרמטרים

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

חזרה

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

אישור

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

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

setOwner(user)

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

פרמטרים

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

חזרה

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

אישור

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

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

setSecurityUpdateEnabled(enabled)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setShareableByEditors(shareable)

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

פרמטרים

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

חזרה

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

אישור

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

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

setSharing(accessType, permissionType)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setStarred(starred)

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

פרמטרים

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

חזרה

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

אישור

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

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

setTrashed(trashed)

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

פרמטרים

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

חזרה

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

אישור

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

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

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