קובץ ב-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 | אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מפנה. |
get | String | אם מדובר בקיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מפנה. |
get | String | אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מפנה. |
get | Blob | הפונקציה מקבלת תמונה ממוזערת של הקובץ, או את הערך 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 | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | ייצוג של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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[] | מערך של כתובות האימייל של המשתמשים שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Editor(emailAddress)
הוספת המשתמש הנתון לרשימת העורכים של File
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Editor(user)
הוספת המשתמש הנתון לרשימת העורכים של File
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Editors(emailAddresses)
הוספת מערך המשתמשים הנתון לרשימת העורכים של File
. אם אחד מהמשתמשים כבר נכלל ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String[] | מערך של כתובות האימייל של המשתמשים שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Viewer(emailAddress)
הוספת המשתמש הנתון לרשימת הצופים ב-File
. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Viewer(user)
הוספת המשתמש הנתון לרשימת הצופים ב-File
. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
add Viewers(emailAddresses)
הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים ב-File
. אם אחד מהמשתמשים כבר היה ברשימת העורכים, השיטה הזו לא תשפיע עליו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String[] | מערך של כתובות האימייל של המשתמשים שרוצים להוסיף. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
get Access(email)
הפונקציה מקבלת את ההרשאה שהוענקה למשתמש ספציפי. השיטה לא תומכת בהחזרת הרשאות של קבוצת Google או הרשאות שעברו בירושה דרך קבוצות Google.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים לבדוק את ההרשאות שלו. אין תמיכה בקבוצות Google. |
חזרה
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 שאליו רוצים להמיר. ברוב ה-blobs, '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()
הפונקציה מקבלת את התאריך שבו ה-File
נוצר.
חזרה
Date
– התאריך שבו נוצר ה-File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
get Description()
הפונקציה מקבלת את התיאור של ה-File
.
חזרה
String
– התיאור של File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
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()
הפונקציה מקבלת את המזהה של ה-File
.
חזרה
String
– המזהה של File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
get Last Updated()
הפונקציה מקבלת את התאריך שבו File
עודכן לאחרונה.
חזרה
Date
– התאריך שבו File
עודכן לאחרונה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
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()
הפונקציה מקבלת את השם של ה-File
.
חזרה
String
– השם של File
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
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()
הפונקציה מקבלת את מפתח המשאב של File
שנדרש כדי לגשת לפריטים ששותפו באמצעות קישור.
חזרה
String
– מפתח המשאב של File
.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
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
– מזהה הפריט היעד.
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
– סוג ה-MIME של פריט היעד.
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
אם הקובץ הוא לא קיצור דרך.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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
— התמונה הממוזערת של הקובץ.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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()
קובעת אם ה-File
סומן בכוכב ב-Drive של המשתמש.
חזרה
Boolean
— true
אם ה-File
מסומן בכוכב ב-Drive של המשתמש, false
אם לא
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
is Trashed()
קובעת אם הקובץ File
נמצא באשפה ב-Drive של המשתמש.
חזרה
Boolean
— true
אם ה-File
נמצא באשפה של Drive של המשתמש,
false
אם לא
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
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 | התיקייה שתהפוך לתיקיית האב החדשה. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | ייצוג של המשתמש שרוצים להסיר. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
remove Editor(emailAddress)
הסרת המשתמש הנתון מרשימת העורכים של File
. השיטה הזו לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש, או אם ה-File
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
remove Editor(user)
הסרת המשתמש הנתון מרשימת העורכים של File
. השיטה הזו לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש, או אם ה-File
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שרוצים להסיר. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
remove Viewer(emailAddress)
הסרת המשתמש הרלוונטי מרשימת הצופים והמגיבים ב-File
. השיטה הזו לא משפיעה אם המשתמש הוא עורך, ולא צופה או מגיב. בנוסף, השיטה הזו לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש, או אם ה-File
נמצא בתיקיית אחסון שיתופי שהמשתמש יכול לגשת אליה.
בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
remove Viewer(user)
הסרת המשתמש הרלוונטי מרשימת הצופים והמגיבים ב-File
. השיטה הזו לא משפיעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש, או אם ה-File
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שרוצים להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
revoke Permissions(emailAddress)
ביטול הגישה ל-File
שהוקצה למשתמש הנתון. השיטה הזו לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שרוצים לבטל את הגישה שלו. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
revoke Permissions(user)
ביטול הגישה ל-File
שהוקצה למשתמש הנתון. השיטה הזו לא מונעת ממשתמשים לגשת ל-File
אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך לבטל את הגישה שלו. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | התוכן החדש של הקובץ. |
חזרה
File
— השדה File
, לצורך קישור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
set Description(description)
הגדרת התיאור של File
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
description | String | התיאור החדש של File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
set Name(name)
הגדרת השם של File
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | השם החדש של File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
set Owner(emailAddress)
שינוי הבעלים של File
. השיטה הזו גם מעניקה לבעלים הקודם הרשאת עריכה מפורשת ב-File
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שצריך להפוך לבעלים החדש |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/drive
set Owner(user)
set Security Update Enabled(enabled)
מגדיר אם File
מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. קבצים ותיקיות שעומדים בדרישות מופעלים כברירת מחדל.
מידע נוסף על עדכון האבטחה ל-Google Drive
פרמטרים
שם | סוג | תיאור |
---|---|---|
enabled | Boolean | האם להפעיל את הדרישה למפתח משאב עבור File . |
חזרה
File
— השדה 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