השירות הזה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive.
// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
var file = files.next();
Logger.log(file.getName());
}
שיעורים
שם | תיאור קצר |
---|---|
Access | טיפוסים מדומים (enum) הם סוגים של משתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
DriveApp | מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive. |
File | קובץ ב-Google Drive. |
FileIterator | איטרטור שמאפשר לסקריפטים לחזור על אוסף קבצים שעשוי להיות גדול. |
Folder | תיקייה ב-Google Drive. |
FolderIterator | אובייקט שמאפשר לסקריפטים לחזור שוב על אוסף גדול של תיקיות. |
Permission | Enum, המייצג את ההרשאות שניתנות למשתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
User | משתמש המשויך לקובץ ב-Google Drive. |
Access
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
ANYONE | Enum | כל אחד באינטרנט יכול למצוא את הפריט ולקבל גישה אליו. |
ANYONE_WITH_LINK | Enum | כל מי שיש לו את הקישור יכול לגשת. |
DOMAIN | Enum | אנשים בדומיין שלך יכולים למצוא ולקבל גישה. |
DOMAIN_WITH_LINK | Enum | אנשים בדומיין שלך שיש להם את הקישור יכולים לגשת אליו. |
PRIVATE | Enum | רק אנשים שקיבלו הרשאה מפורשת יכולים לקבל גישה. |
DriveApp
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
Access | Access | טיפוסים מדומים (enum) הם סוגים של משתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
Permission | Permission | Enum, המייצג את ההרשאות שניתנות למשתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת. |
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | המשך איטרציה של קובץ באמצעות אסימון המשך של איטרציה קודמת. |
continueFolderIterator(continuationToken) | FolderIterator | המשך חזרה על תיקייה באמצעות אסימון המשך של איטרציה קודמת. |
createFile(blob) | File | יצירת קובץ לרמה הבסיסית (root) של Drive ב-Drive של משתמש מתוך Blob נתונים שרירותיים. |
createFile(name, content) | File | יוצר קובץ טקסט לרמה הבסיסית (root) של Drive ב-Drive של המשתמש, עם השם והתוכן שלו. |
createFile(name, content, mimeType) | File | יוצר קובץ ב-Drive של המשתמש בשורש, עם השם, התוכן וסוג ה-MIME שלו. |
createFolder(name) | Folder | יוצר תיקייה ב-Drive של המשתמש ב-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 | מקבלת את התיקייה בבסיס ה-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 | מקבל את כתובת האתר שבאמצעותה ניתן להוריד את הקובץ. |
getEditors() | User[] | קבלת רשימה של עורכים עבור File זה. |
getId() | String | מזהה של File . |
getLastUpdated() | Date | קבלת התאריך שבו עודכן ה-File לאחרונה. |
getMimeType() | String | הורדת סוג MIME של הקובץ. |
getName() | String | מקבל את השם של File . |
getOwner() | User | קבלת הבעלים של File . |
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(user) | 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(user) | 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
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
VIEW | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק להציג אותו או להעתיק אותו. |
EDIT | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים לערוך אותו. |
COMMENT | Enum | משתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק להציג אותו, להעתיק אותו או להגיב עליו. |
OWNER | Enum | המשתמש הוא הבעלים של הקובץ או התיקייה. |
ORGANIZER | Enum | משתמשים שיכולים לארגן קבצים ותיקיות באחסון שיתופי. |
FILE_ORGANIZER | Enum | משתמשים שיכולים לערוך, להעביר לאשפה ולהעביר תוכן בתוך אחסון שיתופי. |
NONE | Enum | למשתמש אין הרשאות עבור הקובץ או התיקייה. |
User
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getDomain() | String | מקבל את שם הדומיין המשויך לחשבון המשתמש. |
getEmail() | String | מקבל את כתובת האימייל של המשתמש. |
getName() | String | מקבל את שם המשתמש. |
getPhotoUrl() | String | מקבל את כתובת האתר של תמונת המשתמש. |