Drive Service

Drive

השירות הזה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive. למרות שקל יותר להשתמש בשירות Drive המובנה, יש לו כמה מגבלות. כדי ליהנות מהתכונות והתמיכה העדכניות ביותר, ולגשת לקבצים או לתיקיות באחסון שיתופי, צריך להשתמש בשירות 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 שמייצג את ההרשאות שניתנו למשתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
continueFileIterator(continuationToken)FileIteratorממשיך איטרציה של קובץ באמצעות אסימון המשך מאיטרטור קודם.
continueFolderIterator(continuationToken)FolderIteratorממשיך איטרציה של תיקייה באמצעות אסימון המשך מאיטרטור קודם.
createFile(blob)Fileיוצר קובץ בתיקיית הבסיס של המשתמש ב-Drive מתוך Blob נתון שרירותי.
createFile(name, content)Fileיוצר קובץ טקסט בשורש של Drive של המשתמש עם השם והתוכן שצוינו.
createFile(name, content, mimeType)Fileיוצר קובץ בשורש של 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הפונקציה מחזירה את הערך true אם נדרש מפתח משאב כדי לגשת ל-File כשמשתפים אותו באמצעות קישור, אחרת היא מחזירה את הערך false.
getSharingAccess()Accessהפונקציה מחזירה את סוג המשתמשים שיכולים לגשת אל File, בנוסף למשתמשים פרטיים שקיבלו גישה באופן מפורש.
getSharingPermission()Permissionמקבל את ההרשאה שניתנה למשתמשים שיכולים לגשת אל File, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש.
getSize()Integerהפונקציה מחזירה את מספר הבייטים שמשמשים לאחסון File ב-Drive.
getTargetId()Stringאם זהו קיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מצביע.
getTargetMimeType()Stringאם מדובר בקיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מצביע.
getTargetResourceKey()Stringאם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מצביע.
getThumbnail()Blob|nullמחזירה תמונה ממוזערת של הקובץ, או 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הפונקציה מחזירה את הערך true אם נדרש מפתח משאב כדי לגשת ל-Folder כשמשתפים אותו באמצעות קישור, אחרת היא מחזירה את הערך false.
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

מאפיינים

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

User

Methods

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