קובץ ב-Google Drive. אפשר לגשת לקבצים או ליצור אותם דרך DriveApp
.
// Trash every untitled spreadsheet that hasn't been updated in a week. var files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { var file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addCommenter(emailAddress) | File | הוספת המשתמש הנתון לרשימת המגיבים ב-File . |
addCommenter(user) | File | הוספת המשתמש הנתון לרשימת המגיבים ב-File . |
addCommenters(emailAddresses) | File | צריך להוסיף את מערך המשתמשים הנתון לרשימת המגיבים עבור File . |
addEditor(emailAddress) | File | הוספה של המשתמש הנתון לרשימת העורכים של File . |
addEditor(user) | File | הוספה של המשתמש הנתון לרשימת העורכים של File . |
addEditors(emailAddresses) | File | הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת העורכים של File . |
addViewer(emailAddress) | File | הוספה של המשתמש הנתון לרשימת הצופים ב-File . |
addViewer(user) | File | הוספה של המשתמש הנתון לרשימת הצופים ב-File . |
addViewers(emailAddresses) | File | הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים של File . |
getAccess(email) | Permission | מקבל את ההרשאה שהוענקה למשתמש הנתון. |
getAccess(user) | Permission | מקבל את ההרשאה שהוענקה למשתמש הנתון. |
getAs(contentType) | Blob | החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. |
getBlob() | Blob | החזרת הנתונים שבתוך האובייקט הזה כ-blob. |
getDateCreated() | Date | הפונקציה מקבלת את התאריך שבו נוצר ה-File . |
getDescription() | String | קבלת התיאור של File . |
getDownloadUrl() | String | הפונקציה מקבלת את כתובת ה-URL שדרכה אפשר להוריד את הקובץ. |
getEditors() | User[] | קבלת רשימת העורכים של File . |
getId() | String | הפונקציה מקבלת את המזהה של File . |
getLastUpdated() | Date | הפונקציה מקבלת את התאריך שבו בוצע העדכון האחרון של File . |
getMimeType() | String | הפונקציה מקבלת את סוג ה-MIME של הקובץ. |
getName() | String | הפונקציה מקבלת את השם של File . |
getOwner() | User | מקבל את הבעלים של הקובץ. |
getParents() | FolderIterator | קבלת אוסף של תיקיות שהן ההורים המיידיים של File . |
getResourceKey() | String | הפונקציה מקבלת את מפתח המשאב של File שנדרש כדי לגשת לפריטים
שותפו באמצעות קישור. |
getSecurityUpdateEligible() | Boolean | הפונקציה מקבלת אם הFile הזה עומד בדרישות להחיל את עדכון האבטחה
נדרש מפתח משאב לגישה כשהוא משותף באמצעות קישור. |
getSecurityUpdateEnabled() | Boolean | הפונקציה קובעת אם File דורש מפתח משאב כדי לקבל גישה כשהוא
שותף באמצעות קישור. |
getSharingAccess() | Access | מקבלת את רמת הגישה של המשתמשים שיש להם גישה אל File , מלבד כל אדם פרטי
משתמשים שקיבלו גישה מפורשת. |
getSharingPermission() | Permission | מקבל את ההרשאה שהוענקה למשתמשים שיכולים לגשת אל File ,
מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
getSize() | Integer | הפונקציה מקבלת את מספר הבייטים ששימש לאחסון של File ב-Drive. |
getTargetId() | String | אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מפנה. |
getTargetMimeType() | String | אם מדובר במקש קיצור, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מפנה. |
getTargetResourceKey() | String | אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מפנה. |
getThumbnail() | Blob | הפונקציה מקבלת תמונה ממוזערת של הקובץ, או null אם אין תמונה ממוזערת. |
getUrl() | String | הפונקציה מקבלת את כתובת ה-URL שניתן להשתמש בה כדי לפתוח את File באפליקציית Google כמו
Drive או Docs. |
getViewers() | User[] | הפונקציה מקבלת את רשימת הצופים והמגיבים של הFile הזה. |
isShareableByEditors() | Boolean | המדיניות קובעת אם משתמשים עם הרשאות עריכה ב-File יכולים
לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
isStarred() | Boolean | המדיניות קובעת אם הקובץ File סומן בכוכב ב-Drive של המשתמש. |
isTrashed() | Boolean | המדיניות קובעת אם ה-File נמצא באשפה ב-Drive של המשתמש. |
makeCopy() | File | ייווצר עותק של הקובץ. |
makeCopy(destination) | File | יוצר עותק של הקובץ בספריית היעד. |
makeCopy(name) | File | ייווצר עותק של הקובץ ותן לו שם עם השם שניתן. |
makeCopy(name, destination) | File | יוצר עותק של הקובץ בספריית היעד ונותן לו שם עם השם שצוין. |
moveTo(destination) | File | הפריט הזה יועבר לתיקיית היעד שצוינה. |
removeCommenter(emailAddress) | File | הסרה של המשתמש הנתון מרשימת המגיבים ב-File . |
removeCommenter(user) | File | הסרה של המשתמש הנתון מרשימת המגיבים ב-File . |
removeEditor(emailAddress) | File | הסרה של המשתמש הנתון מרשימת העורכים של File . |
removeEditor(user) | File | הסרה של המשתמש הנתון מרשימת העורכים של File . |
removeViewer(emailAddress) | File | הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של File . |
removeViewer(user) | File | הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של File . |
revokePermissions(emailAddress) | File | ביטול הגישה אל File שהוענקה למשתמש הנתון. |
revokePermissions(user) | File | ביטול הגישה אל File שהוענקה למשתמש הנתון. |
setContent(content) | File | מחליף את תוכן הקובץ בהחלפה נתונה. |
setDescription(description) | File | הגדרת התיאור של File . |
setName(name) | File | מגדיר את השם של File . |
setOwner(emailAddress) | File | שינוי הבעלים של File . |
setOwner(user) | File | שינוי הבעלים של File . |
setSecurityUpdateEnabled(enabled) | File | המדיניות קובעת אם File דורש מפתח משאב כדי לגשת כשהוא
שותף באמצעות קישור. |
setShareableByEditors(shareable) | File | הגדרה זו קובעת אם משתמשים עם הרשאות עריכה ב-File מורשים לשתף
עם משתמשים אחרים או לשנות את ההרשאות. |
setSharing(accessType, permissionType) | File | המדיניות הזו קובעת איזו קבוצת משתמשים יכולה לגשת אל File ואילו הרשאות
משתמשים אלה קיבלו גישה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
setStarred(starred) | File | המדיניות קובעת אם File יסומן בכוכב ב-Drive של המשתמש. |
setTrashed(trashed) | File | המדיניות קובעת אם ה-File יהיה באשפה ב-Drive של המשתמש. |
מסמכי תיעוד מפורטים
addCommenter(emailAddress)
הוספת המשתמש הנתון לרשימת המגיבים ב-File
. אם המשתמש היה
כבר ברשימת הצופים, השיטה הזו מקדמת את המשתמש מתוך רשימת הצופים.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you // want to add as a commenter. while (files.hasNext()) { const file = files.next(); email = 'cloudysanfrancisco@gmail.com'; console.log(file.addCommenter(email)); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להוספה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addCommenter(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
addCommenters(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)); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddresses | String[] | מערך כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
הוספה של המשתמש הנתון לרשימת העורכים של File
. אם המשתמש כבר
ברשימת הצופים, שיטה זו מקדמת את המשתמש מתוך רשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להוספה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addEditor(user)
הוספה של המשתמש הנתון לרשימת העורכים של File
. אם המשתמש כבר
ברשימת הצופים, שיטה זו מקדמת את המשתמש מתוך רשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת העורכים של File
. אם אחת מהאפשרויות
המשתמשים כבר היו ברשימת הצופים, השיטה הזו מקדמת אותם מתוך רשימת הצופים
צופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddresses | String[] | מערך כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
הוספה של המשתמש הנתון לרשימת הצופים ב-File
. אם המשתמש כבר
ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להוספה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addViewer(user)
הוספה של המשתמש הנתון לרשימת הצופים ב-File
. אם המשתמש כבר
ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים של File
. אם אחת מהאפשרויות
משתמשים כבר היו ברשימת העורכים, לשיטה הזו אין השפעה עליהם.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddresses | String[] | מערך כתובות אימייל של המשתמשים שרוצים להוסיף. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
getAccess(email)
מקבל את ההרשאה שהוענקה למשתמש הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של המשתמש שיש לבדוק את ההרשאות שלו |
חזרה
Permission
– ההרשאות שהוענקו למשתמש
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
מקבל את ההרשאה שהוענקה למשתמש הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שיש לבדוק את ההרשאות שלו |
חזרה
Permission
– ההרשאות שהוענקו למשתמש
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. הזה method מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, "myfile.pdf". עם זאת, מניח שהחלק של שם הקובץ שמופיע אחרי התקופה האחרונה (אם יש) הוא קיים שצריך להחליף. כתוצאה מכך, "ShoppingList.12.25.2014" הופך ל- "ShoppingList.12.25.pdf".
כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר מכסות ל-Google שירותים. יכול להיות שבאופן זמני יוטלו מגבלות מחמירות יותר על דומיינים חדשים ב-Google Workspace שייווצרו. במכסות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
contentType | String | סוג ה-MIME שאליו צריך להמיר. לרוב ה-blobs, 'application/pdf' הוא
האפשרות החוקית היחידה. בשביל תמונות בפורמט BMP, GIF, JPEG או PNG, כל אחד מהקריטריונים של 'image/bmp' , 'image/gif' , 'image/jpeg' או 'image/png' צריך להיות תואם גם
תקין. במסמך של Google Docs, גם 'text/markdown' תקף. |
חזרה
Blob
– הנתונים כ-blob.
getBlob()
getDateCreated()
הפונקציה מקבלת את התאריך שבו נוצר ה-File
.
חזרה
Date
– התאריך שבו נוצר File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDescription()
קבלת התיאור של File
.
חזרה
String
– התיאור של File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDownloadUrl()
הפונקציה מקבלת את כתובת ה-URL שדרכה אפשר להוריד את הקובץ. רק משתמשים שיש להם הרשאה לפתוח את הקובץ
ב-Google Drive יכולים לגשת לכתובת ה-URL. אפשר להשתמש בכתובת ה-URL הזו בדפדפן כדי להוריד את הקובץ, אבל
שאי אפשר להשתמש בהם כדי לאחזר את הקובץ באמצעות UrlFetchApp
. אם רוצים לקבל את התוכן
בסקריפט, צריך להשתמש ב-getBlob()
.
// 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
getEditors()
קבלת רשימת העורכים של 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
getId()
הפונקציה מקבלת את המזהה של File
.
חזרה
String
– המזהה של File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getLastUpdated()
הפונקציה מקבלת את התאריך שבו בוצע העדכון האחרון של File
.
חזרה
Date
– התאריך שבו File
עודכן לאחרונה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getMimeType()
הפונקציה מקבלת את סוג ה-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
getName()
הפונקציה מקבלת את השם של File
.
חזרה
String
— השם של File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getOwner()
מקבל את הבעלים של הקובץ.
// 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
getParents()
קבלת אוסף של תיקיות שהן ההורים המיידיים של File
.
חזרה
FolderIterator
– אוסף של תיקיות שהן ההורה המיידי של File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
הפונקציה מקבלת את מפתח המשאב של File
שנדרש כדי לגשת לפריטים
שותפו באמצעות קישור.
חזרה
String
– מפתח המשאב של File
.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
הפונקציה מקבלת אם הFile
הזה עומד בדרישות להחיל את עדכון האבטחה
נדרש מפתח משאב לגישה כשהוא משותף באמצעות קישור.
כדי לגשת לתיקיות או לקבצים ששותפו ב-Drive, צריך שיהיה להם מפתח משאב
קישור. השינוי הזה הוא חלק מעדכון אבטחה. העדכון מופעל כברירת מחדל למשתמשים שעומדים בדרישות
קבצים ותיקיות. כדי להפעיל או להשבית את הדרישה למפתח המשאב לקבצים שעומדים בדרישות, משתמשים:
setSecurityUpdateEnabled
מידע נוסף על עדכון האבטחה ל-Google Drive
חזרה
Boolean
– אפשר להחיל את הדרישה למפתח המשאב עבור File
.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
הפונקציה קובעת אם File
דורש מפתח משאב כדי לקבל גישה כשהוא
שותף באמצעות קישור. הדרישה הזו מופעלת כברירת מחדל לגבי תיקיות וקבצים שעומדים בדרישות.
כדי להפעיל או להשבית את הדרישה למפתח משאב לקבצים שעומדים בדרישות, יש להשתמש ב-
setSecurityUpdateEnabled
.
מידע נוסף על עדכון האבטחה ל-Google Drive
חזרה
Boolean
– האם הדרישה למפתח משאב מופעלת עבור File
.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
מקבלת את רמת הגישה של המשתמשים שיש להם גישה אל File
, מלבד כל אדם פרטי
משתמשים שקיבלו גישה מפורשת.
חזרה
Access
– איזו קבוצת משתמשים יכולה לגשת אל File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
מקבל את ההרשאה שהוענקה למשתמשים שיכולים לגשת אל File
,
מלבד משתמשים ספציפיים שקיבלו גישה מפורשת.
חזרה
Permission
– ההרשאות שהוענקו למשתמשים שיכולים לגשת אל File
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
הפונקציה מקבלת את מספר הבייטים ששימש לאחסון של File
ב-Drive. שימו לב
קבצים של אפליקציות Google Workspace לא נחשבים כחלק ממגבלות האחסון ב-Drive ולכן הם מוחזרים
0
בייט.
חזרה
Integer
– מספר הבייטים שמשמשים לשמירת הקובץ File
ב-Drive
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTargetId()
אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מפנה.
אחרת, היא מחזירה 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
– מזהה פריט היעד.
getTargetMimeType()
אם מדובר במקש קיצור, הפונקציה מחזירה את סוג ה-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 של פריט היעד.
getTargetResourceKey()
אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מפנה. מפתח משאב הוא פרמטר נוסף שצריך להעביר כדי לגשת לקבצים ששותפו באמצעות קישור.
אם הקובץ הוא לא קיצור דרך, הוא יחזיר 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
getThumbnail()
הפונקציה מקבלת תמונה ממוזערת של הקובץ, או 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
getUrl()
הפונקציה מקבלת את כתובת ה-URL שניתן להשתמש בה כדי לפתוח את File
באפליקציית Google כמו
Drive או Docs.
חזרה
String
— כתובת ה-URL שאפשר להשתמש בה כדי להציג את File
באפליקציית Google כמו
Drive או Docs
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
הפונקציה מקבלת את רשימת הצופים והמגיבים של הFile
הזה. אם המשתמש
מפעיל את הסקריפט שאין לו גישת עריכה ב-File
, ל-method הזה
מחזירה מערך ריק.
// 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 (viewer of viewers) { console.log(viewer.getEmail()); } }
חזרה
User[]
— אם למשתמש יש גישת עריכה עבור File
, הפונקציה מחזירה את הרשימה של
צופים ומגיבים. אם למשתמש אין גישת עריכה, הפונקציה מחזירה מערך ריק.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
המדיניות קובעת אם הקובץ File
סומן בכוכב ב-Drive של המשתמש.
חזרה
Boolean
– true
אם השדה File
מסומן בכוכב ב-Drive של המשתמש; false
אם לא
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
המדיניות קובעת אם ה-File
נמצא באשפה ב-Drive של המשתמש.
חזרה
Boolean
– true
אם File
נמצא באשפה ב-Drive של המשתמש;
false
אם לא
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
makeCopy()
ייווצר עותק של הקובץ.
// 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
makeCopy(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
makeCopy(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
makeCopy(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
moveTo(destination)
הפריט הזה יועבר לתיקיית היעד שצוינה.
המשתמש הנוכחי חייב להיות הבעלים של הקובץ או עם גישת עריכה לפריט תיקיית ההורה הנוכחית כדי להעביר את הפריט לתיקיית היעד.
פרמטרים
שם | סוג | תיאור |
---|---|---|
destination | Folder | התיקייה שהופכת להורה החדש. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
removeCommenter(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'); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להסרה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
removeCommenter(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
removeEditor(emailAddress)
הסרה של המשתמש הנתון מרשימת העורכים של File
. בשיטה הזאת לא ניתן
חסימת הגישה של משתמשים אל File
אם הם שייכים לקטגוריה של משתמשים
גישה כללית – לדוגמה, אם ה-File
משותף עם כל המשתמשים
בדומיין, או אם File
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להסרה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
הסרה של המשתמש הנתון מרשימת העורכים של File
. בשיטה הזאת לא ניתן
חסימת הגישה של משתמשים אל File
אם הם שייכים לקטגוריה של משתמשים
גישה כללית – לדוגמה, אם ה-File
משותף עם כל המשתמשים
בדומיין, או אם File
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של File
. הזה
ל-method אין השפעה אם המשתמש הוא עורך, לא צופה או מגיב. השיטה הזאת גם
לא חוסמת את הגישה של משתמשים אל File
אם הם שייכים לקטגוריה של משתמשים
יש גישה כללית – לדוגמה, אם ה-File
משותף עם המשתמש
בכל הדומיין, או אם הקובץ File
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש להסרה. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של File
. הזה
ל-method אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת
למשתמשים לגשת אל File
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה - לדוגמה, אם ה-File
משותף עם כל הדומיין של המשתמש, או
אם הקובץ File
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך להסיר. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
ביטול הגישה אל File
שהוענקה למשתמש הנתון. בשיטה הזאת לא ניתן
לחסום את הגישה של משתמשים אל File
אם הם שייכים לקטגוריה של משתמשים
יש להם גישה כללית — לדוגמה, אם ה-File
משותף עם
את כל הדומיין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שצריך לבטל את הגישה שלו. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
ביטול הגישה אל File
שהוענקה למשתמש הנתון. בשיטה הזאת לא ניתן
לחסום את הגישה של משתמשים אל File
אם הם שייכים לקטגוריה של משתמשים
יש להם גישה כללית — לדוגמה, אם ה-File
משותף עם
את כל הדומיין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שצריך לבטל את הגישה שלו. |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setContent(content)
מחליף את תוכן הקובץ בהחלפה נתונה. הפעולה הזאת גורמת לחריגה אם content
גדול מ-10MB.
// Creates a text file with the content 'Hello, world!' 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
setDescription(description)
הגדרת התיאור של File
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
description | String | התיאור החדש של File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setName(name)
מגדיר את השם של File
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | השם החדש של File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setOwner(emailAddress)
שינוי הבעלים של File
. השיטה הזו גם נותנת לבעלים הקודם
גישת עריכה מפורשת לFile
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שאמור להיות הבעלים החדש |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setOwner(user)
setSecurityUpdateEnabled(enabled)
המדיניות קובעת אם File
דורש מפתח משאב כדי לגשת כשהוא
שותף באמצעות קישור. כברירת מחדל, התיקיות והקבצים שעומדים בדרישות מופעלים.
מידע נוסף על עדכון האבטחה ל-Google Drive
פרמטרים
שם | סוג | תיאור |
---|---|---|
enabled | Boolean | הגדרה שקובעת אם להפעיל את הדרישה למפתחות המשאבים של File . |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setSharing(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.) var folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
פרמטרים
שם | סוג | תיאור |
---|---|---|
accessType | Access | איזו קבוצת משתמשים צריכה לקבל גישה אל File |
permissionType | Permission | ההרשאות שצריך להעניק למשתמשים שיכולים לגשת אל File |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
המדיניות קובעת אם File
יסומן בכוכב ב-Drive של המשתמש. ברירת המחדל עבור
File
החדש false
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
starred | Boolean | true אם רוצים לסמן את File בחשבון של המשתמש
Drive; false אם לא |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
המדיניות קובעת אם ה-File
יהיה באשפה ב-Drive של המשתמש. רק
הבעלים יכולים להעביר לאשפה את File
. ברירת המחדל לנכסים חדשים מסוג File
היא false
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
trashed | Boolean | true אם צריך להעביר את File לאשפה של
ב-Drive של המשתמש. false אם לא |
חזרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/drive