Drive Service

Drive

שירות זה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב- Google Drive.

אם הסקריפט משתמש פרויקט רגיל ב-Cloud במקום לפרויקט ברירת מחדל ב-Cloud, צריך להפעיל ידנית את Drive API. בפרויקט הרגיל ב-Cloud, מפעילים את Drive API:

הפעלת 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

מאפיינים

נכססוגתיאור
ANYONEEnumכל אחד באינטרנט יכול למצוא את הפריט ולקבל גישה אליו.
ANYONE_WITH_LINKEnumכל מי שיש לו את הקישור יכול לגשת.
DOMAINEnumאנשים בדומיין שלך יכולים למצוא את הפריט ולגשת אליו.
DOMAIN_WITH_LINKEnumאנשים בדומיין שלך שיש להם את הקישור יכולים לגשת אליו.
PRIVATEEnumרק אנשים שקיבלו הרשאה מפורשת יכולים לקבל גישה.

DriveApp

מאפיינים

נכססוגתיאור
AccessAccessטיפוסים בני מנייה (enum) שמייצגים סיווגים של משתמשים שיש להם גישה לקובץ או לתיקייה, מלבד כל אדם פרטי משתמשים שקיבלו גישה מפורשת.
PermissionPermissionטיפוסים בני מנייה (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

מאפיינים

נכססוגתיאור
VIEWEnumמשתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק לצפות בהם או להעתיק אותם.
EDITEnumמשתמשים שיכולים לגשת לקובץ או לתיקייה יכולים לערוך אותם.
COMMENTEnumמשתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק לצפות בהם, להעתיק אותם או להגיב עליהם.
OWNEREnumהמשתמש הוא הבעלים של הקובץ או התיקייה.
ORGANIZEREnumמשתמשים שיכולים לארגן קבצים ותיקיות בתוך אחסון שיתופי
FILE_ORGANIZEREnumמשתמשים שיכולים לערוך את התוכן, להעביר אותו לאשפה ולהעביר אותו באחסון שיתופי.
NONEEnumלמשתמש אין הרשאות בקובץ או בתיקייה.

User

שיטות

שיטהסוג הערך המוחזרתיאור קצר
getDomain()Stringהפונקציה מקבלת את שם הדומיין שמשויך לחשבון של המשתמש.
getEmail()Stringמקבל את כתובת האימייל של המשתמש.
getName()Stringהפונקציה מקבלת את שם המשתמש.
getPhotoUrl()Stringהפונקציה מקבלת את כתובת ה-URL של התמונה של המשתמש.