קובץ ב-Google Drive. אפשר לגשת לקבצים או ליצור אותם באמצעות Drive.
// Trash every untitled spreadsheet that hasn't been updated in a week. const files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { const file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | File | הוספת המשתמש לרשימת המגיבים של File. |
add | File | הוספת המשתמש לרשימת המגיבים של File. |
add | File | הוספת מערך המשתמשים שצוין לרשימת המגיבים של File. |
add | File | הוספת המשתמש שצוין לרשימת העורכים של File. |
add | File | הוספת המשתמש שצוין לרשימת העורכים של File. |
add | File | מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של File. |
add | File | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של File. |
add | File | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של File. |
add | File | הפונקציה מוסיפה את מערך המשתמשים שצוין לרשימת הצופים של File. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Blob | החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין. |
get | Blob | החזרת הנתונים בתוך האובייקט הזה כ-blob. |
get | Date | הפונקציה מחזירה את התאריך שבו נוצר File. |
get | String | הפונקציה מחזירה את התיאור של File. |
get | String | מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי להוריד את הקובץ. |
get | User[] | מחזירה את רשימת העורכים של ה-File הזה. |
get | String | הפונקציה מחזירה את המזהה של File. |
get | Date | מחזירה את התאריך שבו File עודכן לאחרונה. |
get | String | מקבל את סוג ה-MIME של הקובץ. |
get | String | הפונקציה מחזירה את השם של File. |
get | User | מקבל את הבעלים של הקובץ. |
get | Folder | מקבלים אוסף של תיקיות שהן תיקיות אב מיידיות של File. |
get | String | מחזירה את מפתח המשאב של File שנדרש לגישה לפריטים ששותפו באמצעות קישור. |
get | Boolean | מחזירה אם אפשר להחיל על File את עדכון האבטחה שדורש קוד גישה כדי לגשת אליו כשמשתפים אותו באמצעות קישור. |
get | Boolean | הפונקציה מחזירה את הערך שקובע אם נדרש מפתח משאב כדי לגשת אל File כשמשתפים אותו באמצעות קישור. |
get | Access | מחזירה את סוג המשתמשים שיכולים לגשת אל File, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש. |
get | Permission | מקבל את ההרשאה שניתנה למשתמשים שיש להם גישה ל-File, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש. |
get | Integer | הפונקציה מחזירה את מספר הבייטים שמשמשים לאחסון File ב-Drive. |
get | String|null | אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מצביע. |
get | String|null | אם זהו קיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מצביע. |
get | String|null | אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מצביע. |
get | Blob|null | מחזירה תמונה ממוזערת של הקובץ, או null אם לא קיימת תמונה ממוזערת. |
get | String | מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את File באפליקציית Google כמו Drive או Docs. |
get | User[] | הפונקציה מחזירה את רשימת הצופים והמגיבים של ה-File הזה. |
is | Boolean | ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-File יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
is | Boolean | ההגדרה קובעת אם File קיבל כוכב ב-Drive של המשתמש. |
is | Boolean | ההגדרה קובעת אם הקובץ File נמצא באשפה ב-Drive של המשתמש. |
make | File | יצירת עותק של הקובץ. |
make | File | יוצר עותק של הקובץ בספריית היעד. |
make | File | יוצר עותק של הקובץ ונותן לו את השם שצוין. |
make | File | יוצר עותק של הקובץ בספריית היעד ונותן לו את השם שצוין. |
move | File | העברת הפריט לתיקיית היעד שצוינה. |
remove | File | הפונקציה מסירה את המשתמש שצוין מרשימת המגיבים של File. |
remove | File | הפונקציה מסירה את המשתמש שצוין מרשימת המגיבים של File. |
remove | File | מסיר את המשתמש שצוין מרשימת העורכים של File. |
remove | File | מסיר את המשתמש שצוין מרשימת העורכים של File. |
remove | File | הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של File. |
remove | File | הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של File. |
revoke | File | מבטל את הגישה אל File שהוענקה למשתמש מסוים. |
revoke | File | מבטל את הגישה אל File שהוענקה למשתמש מסוים. |
set | File | התוכן של הקובץ נכתב מחדש עם התוכן החדש. |
set | File | מגדירה את התיאור של File. |
set | File | מגדיר את השם של File. |
set | File | שינוי הבעלים של File. |
set | File | שינוי הבעלים של File. |
set | File | מגדירה אם File דורש מפתח משאב לגישה כשהוא משותף באמצעות קישור. |
set | File | ההגדרה קובעת אם משתמשים עם הרשאת עריכה ב-File יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
set | File | ההגדרה הזו קובעת לאיזו קבוצת משתמשים תהיה גישה ל-File ואילו הרשאות יקבלו המשתמשים האלה, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש. |
set | File | הגדרה של סימון File בכוכב ב-Drive של המשתמש. |
set | File | ההגדרה קובעת אם הקובץ File נמצא באשפה ב-Drive של המשתמש. |
תיעוד מפורט
add Commenter(emailAddress)
הוספת המשתמש לרשימת המגיבים של File. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מוציאה את המשתמש מרשימת הצופים.
const files = DriveApp.getFilesByName('Test'); // Loops through the files while (files.hasNext()) { const file = files.next(); file.addCommenter('hello@example.com'); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Commenter(user)
הוספת המשתמש לרשימת המגיבים של File. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מוציאה את המשתמש מרשימת הצופים.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Commenters(emailAddresses)
הוספת מערך המשתמשים שצוין לרשימת המגיבים של File. אם חלק מהמשתמשים כבר היו ברשימת הצופים, השיטה הזו תסיר אותם מרשימת הצופים.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as // commenters. const emails = [ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]; console.log(file.addCommenters(emails)); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String[] | מערך של כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Editor(emailAddress)
הוספת המשתמש שצוין לרשימת העורכים של File. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מוציאה את המשתמש מרשימת הצופים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Editor(user)
add Editors(emailAddresses)
מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של File. אם חלק מהמשתמשים כבר היו ברשימת הצופים, השיטה הזו תוציא אותם מרשימת הצופים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String[] | מערך של כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Viewer(emailAddress)
הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של File. אם המשתמש כבר נמצא ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
add Viewer(user)
add Viewers(emailAddresses)
הפונקציה מוסיפה את מערך המשתמשים שצוין לרשימת הצופים של File. אם חלק מהמשתמשים כבר היו ברשימת העורכים, השיטה הזו לא תשפיע עליהם.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String[] | מערך של כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
get Access(email)
מקבל את ההרשאה שניתנה למשתמש ספציפי. השיטה לא תומכת בהחזרת הרשאות לקבוצת Google או בהרשאות שמתקבלות בירושה דרך קבוצות Google.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שההרשאות שלו צריכות להיבדק. אין תמיכה ב-Google Groups. |
חזרה
Permission – ההרשאות שניתנו למשתמש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Access(user)
מקבל את ההרשאה שניתנה למשתמש ספציפי. השיטה לא תומכת בהחזרת הרשאות לקבוצת Google או בהרשאות שמתקבלות בירושה דרך קבוצות Google.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שההרשאות שלו צריכות להיבדק. |
חזרה
Permission – ההרשאות שניתנו למשתמש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get As(contentType)
החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין. בשיטה הזו, הסיומת המתאימה מתווספת לשם הקובץ – לדוגמה, 'myfile.pdf'. עם זאת, המערכת מניחה שחלק משם הקובץ שאחרי הנקודה האחרונה (אם יש כזו) הוא סיומת קיימת שצריך להחליף. לכן, 'ShoppingList.12.25.2014' הופך ל-'ShoppingList.12.25.pdf'.
כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר בנושא מכסות לשירותי Google. יכול להיות שדומיינים חדשים שנוצרו ב-Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
content | String | סוג ה-MIME שאליו רוצים להמיר. ברוב ה-blob, 'application/pdf' היא האפשרות התקפה היחידה. אם התמונות בפורמט BMP, GIF, JPEG או PNG, אפשר להשתמש גם באחד מהערכים 'image/bmp', 'image/gif', 'image/jpeg' או 'image/png'. במסמך Google Docs, הערך 'text/markdown' תקף גם כן. |
חזרה
Blob — הנתונים כ-blob.
get Blob()
get Date Created()
get Description()
get Download Url()
מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי להוריד את הקובץ. רק משתמשים שיש להם הרשאה לפתוח את הקובץ ב-Google Drive יכולים לגשת לכתובת ה-URL. אפשר להשתמש בכתובת ה-URL הזו בדפדפן כדי להוריד את הקובץ, אבל אי אפשר להשתמש בה כדי לאחזר את הקובץ באמצעות Url. אם רוצים שהתוכן של הקובץ יופיע בתסריט, משתמשים ב-get.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
חזרה
String — כתובת ה-URL שאפשר להשתמש בה כדי להוריד את הקובץ.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Editors()
מחזירה את רשימת העורכים של ה-File הזה. אם למשתמש שמריץ את הסקריפט אין גישת עריכה ל-File, השיטה הזו מחזירה מערך ריק.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors([ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
חזרה
User[] — אם למשתמש יש הרשאת עריכה ל-File הזה, הפונקציה מחזירה את רשימת בעלי הרשאת העריכה. אם למשתמש אין גישת עריכה, הפונקציה מחזירה מערך ריק.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Id()
get Last Updated()
get Mime Type()
מקבל את סוג ה-MIME של הקובץ.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
חזרה
String — סוג ה-MIME של הקובץ.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Name()
get Owner()
מקבל את הבעלים של הקובץ.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
חזרה
User – הבעלים של הקובץ.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Parents()
מקבל אוסף של תיקיות שהן תיקיות אב מיידיות של File.
חזרה
Folder – אוסף של תיקיות שהן תיקיות האב המיידיות של File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Resource Key()
get Security Update Eligible()
מחזירה אם אפשר להחיל על File את עדכון האבטחה שדורש קוד גישה כדי לגשת אליו כשמשתפים אותו באמצעות קישור.
כדי לגשת לקבצים או לתיקיות מסוימים ששותפו באמצעות קישור, צריך מפתח משאב ב-Drive. השינוי הזה הוא חלק מעדכון אבטחה. העדכון מופעל כברירת מחדל לקבצים ולתיקיות שעומדים בדרישות. כדי להפעיל או להשבית את הדרישה למפתח משאב בקבצים שעומדים בדרישות, משתמשים ב-set.
מידע נוסף על עדכון האבטחה ל-Google Drive
חזרה
Boolean – האם אפשר להחיל את הדרישה למפתח משאב על File.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Security Update Enabled()
הפונקציה מחזירה את הערך שקובע אם נדרש מפתח משאב כדי לגשת אל File כשמשתפים אותו באמצעות קישור. הדרישה הזו מופעלת כברירת מחדל לגבי קבצים ותיקיות שעומדים בדרישות.
כדי להפעיל או להשבית את הדרישה למפתח משאב בקבצים שעומדים בדרישות, משתמשים ב-
setSecurityUpdateEnabled.
מידע נוסף על עדכון האבטחה ל-Google Drive
חזרה
Boolean – האם הדרישה למפתח משאב מופעלת עבור File הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Access()
מחזירה את סוג המשתמשים שיכולים לגשת אל File, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש.
חזרה
Access — איזו קבוצת משתמשים יכולה לגשת ל-File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Permission()
מקבל את ההרשאה שניתנה למשתמשים שיש להם גישה ל-File, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש.
חזרה
Permission – ההרשאות שניתנות למשתמשים שיכולים לגשת ל-File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Size()
הפונקציה מחזירה את מספר הבייטים שמשמשים לאחסון File ב-Drive. שימו לב: קבצים של אפליקציות Google Workspace לא נכללים במגבלות האחסון ב-Drive, ולכן מחזירים 0 בייטים.
חזרה
Integer – מספר הבייטים שמשמשים לאחסון File ב-Drive
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Target Id()
אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מצביע.
אחרת, הפונקציה מחזירה את הערך null.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
חזרה
String|null – מזהה פריט היעד, או null אם הקובץ הוא לא קיצור דרך.
get Target Mime Type()
אם זהו קיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מצביע.
אחרת, הפונקציה מחזירה את הערך null.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
חזרה
String|null — סוג ה-MIME של פריט היעד או null אם הקובץ הוא לא קיצור דרך.
get Target Resource Key()
אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מצביע. מפתח משאב הוא פרמטר נוסף שצריך להעביר כדי לגשת לקבצים ששותפו באמצעות קישור.
אם הקובץ הוא לא קיצור דרך, הפונקציה מחזירה null.
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it // points to. console.log(file.getTargetResourceKey());
חזרה
String|null – מפתח המשאב של פריט היעד או null אם הקובץ הוא לא קיצור דרך.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Thumbnail()
מחזירה תמונה ממוזערת של הקובץ, או null אם לא קיימת תמונה ממוזערת.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
חזרה
Blob|null – התמונה הממוזערת של הקובץ.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Url()
מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את File באפליקציית Google כמו Drive או Docs.
חזרה
String — כתובת ה-URL שאפשר להשתמש בה כדי להציג את File באפליקציית Google כמו Drive או Docs
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Viewers()
הפונקציה מחזירה את רשימת הצופים והמגיבים של ה-File הזה. אם למשתמש שמריץ את הסקריפט אין גישת עריכה ל-File, השיטה הזו מחזירה מערך ריק.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (const viewer of viewers) { console.log(viewer.getEmail()); } }
חזרה
User[] — אם למשתמש יש גישת עריכה ל-File הזה, הפונקציה מחזירה את רשימת הצופים והמגיבים. אם למשתמש אין גישת עריכה, הפונקציה מחזירה מערך ריק.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
is Starred()
is Trashed()
make Copy()
יצירת עותק של הקובץ.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
חזרה
File — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
make Copy(destination)
יוצר עותק של הקובץ בספריית היעד.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Folder | הספרייה שאליה רוצים להעתיק את הקובץ. |
חזרה
File — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
make Copy(name)
יוצר עותק של הקובץ ונותן לו את השם שצוין.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
name | String | שם הקובץ שיוחל על העותק החדש. |
חזרה
File — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
make Copy(name, destination)
יוצר עותק של הקובץ בספריית היעד ונותן לו את השם שצוין.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
name | String | שם הקובץ שיוחל על העותק החדש. |
destination | Folder | הספרייה שאליה רוצים להעתיק את הקובץ. |
חזרה
File — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
move To(destination)
העברת הפריט לתיקיית היעד שצוינה.
כדי להעביר פריט לתיקיית היעד, המשתמש הנוכחי צריך להיות הבעלים של הקובץ או שתהיה לו לפחות הרשאת עריכה בתיקיית ההורה הנוכחית של הפריט.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Folder | התיקייה שתהפוך לתיקיית האב החדשה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Commenter(emailAddress)
הפונקציה מסירה את המשתמש שצוין מרשימת המגיבים של File. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to // remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Commenter(user)
הפונקציה מסירה את המשתמש שצוין מרשימת המגיבים של File. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Editor(emailAddress)
מסיר את המשתמש שצוין מרשימת העורכים של File. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לסוג משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש, או אם File נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Editor(user)
מסיר את המשתמש שצוין מרשימת העורכים של File. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לסוג משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש, או אם File נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Viewer(emailAddress)
הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של File. לשיטה הזו אין השפעה אם המשתמש הוא עורך, ולא צופה או מגיב. השיטה הזו גם לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לסוג משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש, או אם File נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
File — This File for chaining.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
remove Viewer(user)
הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של File. לשיטה הזו אין השפעה אם המשתמש הוא עורך ולא צופה. בנוסף, השיטה הזו לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File משותף עם כל הדומיין של המשתמש, או אם ה-File נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שרוצים להסיר. |
חזרה
File — This File for chaining.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
revoke Permissions(emailAddress)
מבטל את הגישה אל File שהוענקה למשתמש מסוים. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים לבטל את הגישה שלו. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
revoke Permissions(user)
מבטל את הגישה אל File שהוענקה למשתמש מסוים. השיטה הזו לא חוסמת את הגישה של משתמשים אל File אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם File משותף עם כל הדומיין של המשתמש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
user | User | ייצוג של המשתמש שהגישה שלו צריכה להתבטל. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
set Content(content)
התוכן של הקובץ נכתב מחדש עם התוכן החדש. הפונקציה מחזירה חריגה אם content גדול מ-10MB.
// Creates a text file with the content 'Hello, world!' const file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!'); // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
content | String | התוכן החדש של הקובץ. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
set Description(description)
set Name(name)
set Owner(emailAddress)
set Owner(user)
set Security Update Enabled(enabled)
מגדירה אם File דורש מפתח משאב לגישה כשהוא משותף באמצעות קישור. קבצים ותיקיות שעומדים בדרישות מופעלים כברירת מחדל.
מידע נוסף על עדכון האבטחה ל-Google Drive
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
enabled | Boolean | האם להפעיל את הדרישה למפתח משאב עבור File. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
set Sharing(accessType, permissionType)
ההגדרה הזו קובעת לאיזה סוג של משתמשים תהיה גישה ל-File ואילו הרשאות יקבלו המשתמשים האלה, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש.
// 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);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
access | Access | לאיזו קבוצת משתמשים צריכה להיות גישה אל File |
permission | Permission | ההרשאות שצריך להעניק למשתמשים שיכולים לגשת אל File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
set Starred(starred)
הגדרה של סימון File בכוכב ב-Drive של המשתמש. ערך ברירת המחדל של File חדשים הוא false.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
starred | Boolean | true אם צריך לסמן בכוכב את File ב-Drive של המשתמש, false אם לא |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive
set Trashed(trashed)
ההגדרה קובעת אם הקובץ File נמצא באשפה ב-Drive של המשתמש. רק הבעלים יכול להעביר את File לאשפה. ברירת המחדל של File חדשים היא false.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
trashed | Boolean | true אם צריך להעביר את File לאשפה ב-Drive של המשתמש, false אם לא |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/drive