שירות זה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב- Google Drive.
אם הסקריפט משתמש פרויקט רגיל ב-Cloud במקום לפרויקט ברירת מחדל ב-Cloud, צריך להפעיל ידנית את Drive API. בפרויקט הרגיל ב-Cloud, מפעילים את Drive API:
דוגמת הקוד הבאה מראה איך לתעד את השמות של כל קובץ בקובץ של המשתמש תיקיית 'האחסון שלי':// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
var file = files.next();
console.log(file.getName());
}
שיעורים
שם | תיאור קצר |
---|---|
Access | טיפוסים בני מנייה (enum) שמייצגים סיווגים של משתמשים שיש להם גישה לקובץ או לתיקייה, מלבד כל אדם פרטי משתמשים שקיבלו גישה מפורשת. |
DriveApp | התכונה מאפשרת לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive. |
File | קובץ ב-Google Drive. |
FileIterator | איטרטור שמאפשר לסקריפטים לבצע איטרציה על פני אוסף קבצים שעשוי להיות גדול. |
Folder | תיקייה ב-Google Drive. |
FolderIterator | אובייקט שמאפשר לסקריפטים לבצע איטרציה באוסף תיקיות גדול שעשוי להיות גדול. |
Permission | טיפוסים בני מנייה (enum) שמייצג את ההרשאות שהוענקו למשתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף כל משתמש בודד שקיבל גישה מפורשת. |
User | משתמש שמשויך לקובץ ב-Google Drive. |
Access
מאפיינים
נכס | סוג | תיאור |
---|---|---|
ANYONE | Enum | כל אחד באינטרנט יכול למצוא את הפריט ולקבל גישה אליו. |
ANYONE_WITH_LINK | Enum | כל מי שיש לו את הקישור יכול לגשת. |
DOMAIN | Enum | אנשים בדומיין שלך יכולים למצוא את הפריט ולגשת אליו. |
DOMAIN_WITH_LINK | Enum | אנשים בדומיין שלך שיש להם את הקישור יכולים לגשת אליו. |
PRIVATE | Enum | רק אנשים שקיבלו הרשאה מפורשת יכולים לקבל גישה. |
DriveApp
מאפיינים
נכס | סוג | תיאור |
---|---|---|
Access | Access | טיפוסים בני מנייה (enum) שמייצגים סיווגים של משתמשים שיש להם גישה לקובץ או לתיקייה, מלבד כל אדם פרטי משתמשים שקיבלו גישה מפורשת. |
Permission | Permission | טיפוסים בני מנייה (enum) שמייצג את ההרשאות שהוענקו למשתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף כל משתמש בודד שקיבל גישה מפורשת. |
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | חזרה על איטרציה של קובץ באמצעות אסימון המשך מאיטרטור קודם. |
continueFolderIterator(continuationToken) | FolderIterator | חזרה על איטרציה של תיקייה באמצעות אסימון המשך מאיטרטור קודם. |
createFile(blob) | File | יוצר קובץ ברמה הבסיסית (root) ב-Drive של המשתמש מ-Blob נתון של נתונים שרירותיים. |
createFile(name, content) | File | יוצר קובץ טקסט ברמה הבסיסית (root) של Drive של המשתמש עם השם והתוכן הרשומים. |
createFile(name, content, mimeType) | File | יצירת קובץ ברמה הבסיסית (root) ב-Drive של המשתמש עם השם, התוכן וסוג ה-MIME שצוינו. |
createFolder(name) | Folder | יוצרת תיקייה ברמה הבסיסית (root) ב-Drive של המשתמש, עם השם שניתן. |
createShortcut(targetId) | File | יוצר קיצור דרך למזהה הפריט ב-Drive שסופק ומחזיר אותו. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | יוצרת קיצור דרך למזהה הפריט ולמפתח המשאב ב-Drive שסופקו ומחזירה אותו. |
enforceSingleParent(value) | void | המדיניות הזו מפעילה או משביתה את האפשרות לאכוף התנהגות של הורה יחידה לכל הקריאות שמשפיעות על תבניות הורה. |
getFileById(id) | File | הפונקציה מקבלת את הקובץ עם המזהה הנתון. |
getFileByIdAndResourceKey(id, resourceKey) | File | הפונקציה מקבלת את הקובץ עם המזהה ומפתח המשאב הנתונים. |
getFiles() | FileIterator | מקבל אוסף של כל הקבצים ב-Drive של המשתמש. |
getFilesByName(name) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים ב-Drive של המשתמש עם השם הפרטי. |
getFilesByType(mimeType) | FileIterator | מקבל אוסף של כל הקבצים ב-Drive של המשתמש עם סוג MIME הנתון. |
getFolderById(id) | Folder | הפונקציה מקבלת את התיקייה עם המזהה הנתון. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | הפונקציה מקבלת את התיקייה עם המזהה ומפתח המשאב הנתונים. |
getFolders() | FolderIterator | מקבל אוסף של כל התיקיות ב-Drive של המשתמש. |
getFoldersByName(name) | FolderIterator | מקבל אוסף של כל התיקיות ב-Drive של המשתמש שיש להן את השם הפרטי. |
getRootFolder() | Folder | מקבל את התיקייה ברמה הבסיסית (root) ב-Drive של המשתמש. |
getStorageLimit() | Integer | הפונקציה מקבלת את מספר הבייטים שהמשתמש מורשה לאחסן ב-Drive. |
getStorageUsed() | Integer | הפונקציה מקבלת את מספר הבייטים שהמשתמש מאחסן כרגע ב-Drive. |
getTrashedFiles() | FileIterator | מקבל אוסף של כל הקבצים באשפה ב-Drive של המשתמש. |
getTrashedFolders() | FolderIterator | מקבל אוסף של כל התיקיות באשפה ב-Drive של המשתמש. |
searchFiles(params) | FileIterator | מקבל אוסף של כל הקבצים ב-Drive של המשתמש שתואמים לחיפוש הנתון קריטריונים. |
searchFolders(params) | FolderIterator | מקבל אוסף של כל התיקיות ב-Drive של המשתמש שתואמות לחיפוש הנתון קריטריונים. |
File
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
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 של המשתמש. |
FileIterator
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getContinuationToken() | String | הוא מקבל אסימון שיכול לשמש כדי להמשיך את האיטרציה הזו במועד מאוחר יותר. |
hasNext() | Boolean | המדיניות הזו קובעת אם שיחה אל next() תחזיר פריט. |
next() | File | מקבל את הפריט הבא באוסף הקבצים או התיקיות. |
Folder
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addEditor(emailAddress) | Folder | הוספה של המשתמש הנתון לרשימת העורכים של Folder . |
addEditor(user) | Folder | הוספה של המשתמש הנתון לרשימת העורכים של Folder . |
addEditors(emailAddresses) | Folder | הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת העורכים של Folder . |
addViewer(emailAddress) | Folder | הוספה של המשתמש הנתון לרשימת הצופים ב-Folder . |
addViewer(user) | Folder | הוספה של המשתמש הנתון לרשימת הצופים ב-Folder . |
addViewers(emailAddresses) | Folder | הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים של Folder . |
createFile(blob) | File | יצירת קובץ בתיקייה הנוכחית מ-Blob נתונים שרירותיים נתונים. |
createFile(name, content) | File | יצירת קובץ טקסט בתיקייה הנוכחית עם השם והתוכן הנתונים. |
createFile(name, content, mimeType) | File | יצירת קובץ בתיקייה הנוכחית עם השם, התוכן וסוג ה-MIME שצוינו. |
createFolder(name) | Folder | יוצרת תיקייה בתיקייה הנוכחית עם השם הנתון. |
createShortcut(targetId) | File | יוצר קיצור דרך למזהה הפריט ב-Drive שסופק ומחזיר אותו. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | יוצרת קיצור דרך למזהה הפריט ולמפתח המשאב ב-Drive שסופקו ומחזירה אותו. |
getAccess(email) | Permission | מקבל את ההרשאה שהוענקה למשתמש הנתון. |
getAccess(user) | Permission | מקבל את ההרשאה שהוענקה למשתמש הנתון. |
getDateCreated() | Date | הפונקציה מקבלת את התאריך שבו נוצר ה-Folder . |
getDescription() | String | קבלת התיאור של Folder . |
getEditors() | User[] | קבלת רשימת העורכים של Folder . |
getFiles() | FileIterator | מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית. |
getFilesByName(name) | FileIterator | מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית שיש להם את השם הנתון. |
getFilesByType(mimeType) | FileIterator | מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית בעלי סוג MIME הנתון. |
getFolders() | FolderIterator | מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית. |
getFoldersByName(name) | FolderIterator | מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ושיש להן את השם הנתון. |
getId() | String | הפונקציה מקבלת את המזהה של Folder . |
getLastUpdated() | Date | הפונקציה מקבלת את התאריך שבו בוצע העדכון האחרון של Folder . |
getName() | String | הפונקציה מקבלת את השם של Folder . |
getOwner() | User | קבלת הבעלים של הFolder . |
getParents() | FolderIterator | קבלת אוסף של תיקיות שהן ההורים המיידיים של Folder . |
getResourceKey() | String | הפונקציה מקבלת את מפתח המשאב של Folder שנדרש כדי לגשת לפריטים
שותפו באמצעות קישור. |
getSecurityUpdateEligible() | Boolean | הפונקציה מקבלת אם הFolder הזה עומד בדרישות להחיל את עדכון האבטחה
נדרש מפתח משאב לגישה כשהוא משותף באמצעות קישור. |
getSecurityUpdateEnabled() | Boolean | הפונקציה קובעת אם Folder דורש מפתח משאב כדי לקבל גישה כשהוא
שותף באמצעות קישור. |
getSharingAccess() | Access | מקבלת את רמת הגישה של המשתמשים שיש להם גישה אל Folder , מלבד כל אדם פרטי
משתמשים שקיבלו גישה מפורשת. |
getSharingPermission() | Permission | מקבל את ההרשאה שהוענקה למשתמשים שיכולים לגשת אל Folder ,
מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
getSize() | Integer | הפונקציה מקבלת את מספר הבייטים ששימש לאחסון של Folder ב-Drive. |
getUrl() | String | הפונקציה מקבלת את כתובת ה-URL שניתן להשתמש בה כדי לפתוח את Folder באפליקציית Google כמו
Drive או Docs. |
getViewers() | User[] | הפונקציה מקבלת את רשימת הצופים והמגיבים של הFolder הזה. |
isShareableByEditors() | Boolean | המדיניות קובעת אם משתמשים עם הרשאות עריכה ב-Folder יכולים
לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
isStarred() | Boolean | המדיניות קובעת אם הקובץ Folder סומן בכוכב ב-Drive של המשתמש. |
isTrashed() | Boolean | המדיניות קובעת אם ה-Folder נמצא באשפה ב-Drive של המשתמש. |
moveTo(destination) | Folder | הפריט הזה יועבר לתיקיית היעד שצוינה. |
removeEditor(emailAddress) | Folder | הסרה של המשתמש הנתון מרשימת העורכים של Folder . |
removeEditor(user) | Folder | הסרה של המשתמש הנתון מרשימת העורכים של Folder . |
removeViewer(emailAddress) | Folder | הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Folder . |
removeViewer(user) | Folder | הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Folder . |
revokePermissions(emailAddress) | Folder | ביטול הגישה אל Folder שהוענקה למשתמש הנתון. |
revokePermissions(user) | Folder | ביטול הגישה אל Folder שהוענקה למשתמש הנתון. |
searchFiles(params) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית שתואמים לחיפוש הנתון. קריטריונים. |
searchFolders(params) | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית שתואמות לחיפוש הנתון. קריטריונים. |
setDescription(description) | Folder | הגדרת התיאור של Folder . |
setName(name) | Folder | מגדיר את השם של Folder . |
setOwner(emailAddress) | Folder | שינוי הבעלים של Folder . |
setOwner(user) | Folder | שינוי הבעלים של Folder . |
setSecurityUpdateEnabled(enabled) | Folder | המדיניות קובעת אם Folder דורש מפתח משאב כדי לגשת כשהוא
שותף באמצעות קישור. |
setShareableByEditors(shareable) | Folder | הגדרה זו קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף
עם משתמשים אחרים או לשנות את ההרשאות. |
setSharing(accessType, permissionType) | Folder | המדיניות הזו קובעת איזו קבוצת משתמשים יכולה לגשת אל Folder ואילו הרשאות
משתמשים אלה קיבלו גישה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
setStarred(starred) | Folder | המדיניות קובעת אם Folder יסומן בכוכב ב-Drive של המשתמש. |
setTrashed(trashed) | Folder | המדיניות קובעת אם ה-Folder יהיה באשפה ב-Drive של המשתמש. |
FolderIterator
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getContinuationToken() | String | הוא מקבל אסימון שיכול לשמש כדי להמשיך את האיטרציה הזו במועד מאוחר יותר. |
hasNext() | Boolean | המדיניות הזו קובעת אם שיחה אל next() תחזיר פריט. |
next() | Folder | מקבל את הפריט הבא באוסף הקבצים או התיקיות. |
Permission
מאפיינים
נכס | סוג | תיאור |
---|---|---|
VIEW | Enum | משתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק לצפות בהם או להעתיק אותם. |
EDIT | Enum | משתמשים שיכולים לגשת לקובץ או לתיקייה יכולים לערוך אותם. |
COMMENT | Enum | משתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק לצפות בהם, להעתיק אותם או להגיב עליהם. |
OWNER | Enum | המשתמש הוא הבעלים של הקובץ או התיקייה. |
ORGANIZER | Enum | משתמשים שיכולים לארגן קבצים ותיקיות בתוך אחסון שיתופי |
FILE_ORGANIZER | Enum | משתמשים שיכולים לערוך את התוכן, להעביר אותו לאשפה ולהעביר אותו באחסון שיתופי. |
NONE | Enum | למשתמש אין הרשאות בקובץ או בתיקייה. |
User
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getDomain() | String | הפונקציה מקבלת את שם הדומיין שמשויך לחשבון של המשתמש. |
getEmail() | String | מקבל את כתובת האימייל של המשתמש. |
getName() | String | הפונקציה מקבלת את שם המשתמש. |
getPhotoUrl() | String | הפונקציה מקבלת את כתובת ה-URL של התמונה של המשתמש. |