השירות הזה מאפשר ל-scripts ליצור, לאתר ולשנות קבצים ותיקיות ב-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 | מחזור (iterator) שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של קבצים. |
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 שמייצג את ההרשאות שהוקצו למשתמשים שיש להם גישה לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | המשך של חזרה על קובץ באמצעות אסימון המשך ממחזור קודם. |
continueFolderIterator(continuationToken) | FolderIterator | המשך של חזרה על תיקיות באמצעות אסימון המשך ממחזור קודמים. |
createFile(blob) | File | יצירת קובץ ברמה הבסיסית (root) של Drive של המשתמש מ-Blob נתונים שרירותיים. |
createFile(name, content) | File | יצירת קובץ טקסט בספריית השורש של Drive של המשתמש עם השם והתוכן שצוינו. |
createFile(name, content, mimeType) | File | יצירת קובץ ברמה הבסיסית (root) של Drive של המשתמש עם השם, התוכן וסוג ה-MIME שצוינו. |
createFolder(name) | Folder | יצירת תיקייה ברמה הבסיסית של Drive של המשתמש עם השם שצוין. |
createShortcut(targetId) | File | יצירת קיצור דרך למזהה הפריט ב-Drive שצוין והחזרתו. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | יצירת קיצור דרך למזהה הפריט ומפתח המשאב שצוינו ב-Drive והחזרתו. |
enforceSingleParent(value) | void | הפעלה או השבתה של ההתנהגות enforceSingleParent לכל הקריאות שמשפיעות על הורים של פריטים. |
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 | הפונקציה מקבלת את התיקייה ברמה הבסיסית של Drive של המשתמש. |
getStorageLimit() | Integer | הפונקציה מקבלת את מספר הבייטים שהמשתמש רשאי לאחסן ב-Drive. |
getStorageUsed() | Integer | הפונקציה מקבלת את מספר הבייטים שהמשתמש מאחסן כרגע ב-Drive. |
getTrashedFiles() | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שנמצאים באשפה ב-Drive של המשתמש. |
getTrashedFolders() | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות שנמצאות בפח האשפה ב-Drive של המשתמש. |
searchFiles(params) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים ב-Drive של המשתמש שתואמים לקריטריוני החיפוש שצוינו. |
searchFolders(params) | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות ב-Drive של המשתמש שתואמות לקריטריונים נתונים לחיפוש. |
File
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
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
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getContinuationToken() | String | מקבלת אסימון שאפשר להשתמש בו כדי להמשיך את המחזור הזה במועד מאוחר יותר. |
hasNext() | Boolean | הפונקציה קובעת אם קריאה ל-next() תחזיר פריט. |
next() | File | הפונקציה מקבלת את הפריט הבא באוסף הקבצים או התיקיות. |
Folder
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addEditor(emailAddress) | Folder | הוספת המשתמש הנתון לרשימת העורכים של Folder . |
addEditor(user) | Folder | הוספת המשתמש הנתון לרשימת העורכים של Folder . |
addEditors(emailAddresses) | Folder | הוספת מערך המשתמשים הנתון לרשימת העורכים של Folder . |
addViewer(emailAddress) | Folder | הוספת המשתמש הנתון לרשימת הצופים ב-Folder . |
addViewer(user) | Folder | הוספת המשתמש הנתון לרשימת הצופים ב-Folder . |
addViewers(emailAddresses) | Folder | הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים ב-Folder . |
createFile(blob) | File | יצירת קובץ בתיקייה הנוכחית מ-Blob נתונים שרירותיים. |
createFile(name, content) | File | יצירת קובץ טקסט בתיקייה הנוכחית עם השם והתוכן שצוינו. |
createFile(name, content, mimeType) | File | יצירת קובץ בתיקייה הנוכחית עם השם, התוכן וסוג ה-MIME שצוינו. |
createFolder(name) | Folder | יצירת תיקייה בתיקייה הנוכחית עם השם שצוין. |
createShortcut(targetId) | File | יצירת קיצור דרך למזהה הפריט ב-Drive שצוין והחזרתו. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | יצירת קיצור דרך למזהה הפריט ומפתח המשאב שצוינו ב-Drive והחזרתו. |
getAccess(email) | Permission | הפונקציה מקבלת את ההרשאה שהוענקה למשתמש ספציפי. |
getAccess(user) | Permission | הפונקציה מקבלת את ההרשאה שהוענקה למשתמש ספציפי. |
getDateCreated() | Date | הפונקציה מקבלת את התאריך שבו ה-Folder נוצר. |
getDescription() | String | הפונקציה מקבלת את התיאור של ה-Folder . |
getEditors() | User[] | הפונקציה מקבלת את רשימת העורכים של Folder הזה. |
getFiles() | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית. |
getFilesByName(name) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את השם שצוין. |
getFilesByType(mimeType) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את סוג ה-MIME שצוין. |
getFolders() | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית. |
getFoldersByName(name) | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ויש להן את השם שצוין. |
getId() | String | הפונקציה מקבלת את המזהה של ה-Folder . |
getLastUpdated() | Date | הפונקציה מקבלת את התאריך שבו Folder עודכן לאחרונה. |
getName() | String | הפונקציה מקבלת את השם של ה-Folder . |
getOwner() | User | הפונקציה מקבלת את הבעלים של ה-Folder הזה. |
getParents() | FolderIterator | הפונקציה מקבלת אוסף של תיקיות שהן תיקיות הורה מיידיות של Folder . |
getResourceKey() | String | הפונקציה מקבלת את מפתח המשאב של Folder שנדרש כדי לגשת לפריטים ששותפו באמצעות קישור. |
getSecurityUpdateEligible() | Boolean | הפונקציה קובעת אם ה-Folder הזה עומד בדרישות להחלה של עדכון האבטחה, שמחייב קוד גישה כדי לגשת אליו כשמשתפים אותו באמצעות קישור. |
getSecurityUpdateEnabled() | Boolean | הפונקציה מקבלת את הערך שמציין אם Folder הזה מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. |
getSharingAccess() | Access | הפונקציה מקבלת את סוג המשתמשים שיכולים לגשת ל-Folder , מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
getSharingPermission() | Permission | הפונקציה מקבלת את ההרשאה שהוענקה למשתמשים שיכולים לגשת ל-Folder , מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
getSize() | Integer | הפונקציה מקבלת את מספר הבייטים ששימשו לאחסון ה-Folder ב-Drive. |
getUrl() | String | הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את Folder באפליקציית Google כמו Drive או Docs. |
getViewers() | User[] | הפונקציה מקבלת את רשימת הצופים והמגיבים ב-Folder הזה. |
isShareableByEditors() | Boolean | ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
isStarred() | Boolean | קובעת אם ה-Folder סומן בכוכב ב-Drive של המשתמש. |
isTrashed() | Boolean | קובעת אם ה-Folder נמצא באשפה ב-Drive של המשתמש. |
moveTo(destination) | Folder | העברת הפריט הזה לתיקיית היעד שצוינה. |
removeEditor(emailAddress) | Folder | הסרת המשתמש הנתון מרשימת העורכים של Folder . |
removeEditor(user) | Folder | הסרת המשתמש הנתון מרשימת העורכים של Folder . |
removeViewer(emailAddress) | Folder | הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Folder . |
removeViewer(user) | Folder | הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Folder . |
revokePermissions(emailAddress) | Folder | ביטול הגישה ל-Folder שהוקצה למשתמש הנתון. |
revokePermissions(user) | Folder | ביטול הגישה ל-Folder שהוקצה למשתמש הנתון. |
searchFiles(params) | FileIterator | הפונקציה מקבלת אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ותואמים לקריטריוני החיפוש שצוינו. |
searchFolders(params) | FolderIterator | הפונקציה מקבלת אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ותואמות לקריטריוני החיפוש שצוינו. |
setDescription(description) | Folder | הגדרת התיאור של Folder . |
setName(name) | Folder | הגדרת השם של Folder . |
setOwner(emailAddress) | Folder | שינוי הבעלים של Folder . |
setOwner(user) | Folder | שינוי הבעלים של Folder . |
setSecurityUpdateEnabled(enabled) | Folder | ההגדרה קובעת אם Folder מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. |
setShareableByEditors(shareable) | Folder | ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder מורשים לשתף את הקובץ עם משתמשים אחרים או לשנות את ההרשאות. |
setSharing(accessType, permissionType) | Folder | מגדיר לאילו משתמשים תהיה גישה ל-Folder ואילו הרשאות יוענקו להם, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
setStarred(starred) | Folder | מגדיר אם ה-Folder מסומן בכוכב ב-Drive של המשתמש. |
setTrashed(trashed) | Folder | מגדיר אם ה-Folder נמצא באשפה ב-Drive של המשתמש. |
FolderIterator
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getContinuationToken() | String | מקבלת אסימון שאפשר להשתמש בו כדי להמשיך את המחזור הזה במועד מאוחר יותר. |
hasNext() | Boolean | הפונקציה קובעת אם קריאה ל-next() תחזיר פריט. |
next() | Folder | הפונקציה מקבלת את הפריט הבא באוסף הקבצים או התיקיות. |
Permission
מאפיינים
נכס | סוג | תיאור |
---|---|---|
VIEW | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק להציג אותם או להעתיק אותם. |
EDIT | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים לערוך אותם. |
COMMENT | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק להציג אותם, להעתיק אותם או להגיב עליהם. |
OWNER | Enum | הקובץ או התיקייה הם בבעלות המשתמש. |
ORGANIZER | Enum | משתמשים שיכולים לארגן קבצים ותיקיות באחסון שיתופי. |
FILE_ORGANIZER | Enum | משתמשים שיכולים לערוך, להעביר ולשלוח תוכן לאשפה בתוך אחסון שיתופי. |
NONE | Enum | למשתמש אין הרשאות לקובץ או לתיקייה. |
User
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getDomain() | String | הפונקציה מקבלת את שם הדומיין שמשויך לחשבון המשתמש. |
getEmail() | String | הפונקציה מקבלת את כתובת האימייל של המשתמש. |
getName() | String | הפונקציה מקבלת את שם המשתמש. |
getPhotoUrl() | String | הפונקציה מקבלת את כתובת ה-URL של התמונה של המשתמש. |