השירות הזה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-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 | יוצר קובץ בתיקיית השורש של ה-Drive של המשתמש מתוך Blob של נתונים שרירותיים. |
createFile(name, content) | File | יצירת קובץ טקסט ברמה הבסיסית (root) של Drive של המשתמש עם השם והתוכן שצוינו. |
createFile(name, content, mimeType) | File | יוצר קובץ בשורש ה-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 של תמונת המשתמש. |