Drive Service

Drive

השירות הזה מאפשר ל-scripts ליצור, לאתר ולשנות קבצים ותיקיות ב-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());
}

שיעורים

שםתיאור קצר
Accessenum שמייצג כיתות של משתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
DriveAppמאפשרת לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive.
Fileקובץ ב-Google Drive.
FileIteratorמחזור (iterator) שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של קבצים.
Folderתיקייה ב-Google Drive.
FolderIteratorאובייקט שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של תיקיות.
Permissionenum שמייצג את ההרשאות שהוקצו למשתמשים שיש להם גישה לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
Userמשתמש שמשויך לקובץ ב-Google Drive.

Access

מאפיינים

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

DriveApp

מאפיינים

נכססוגתיאור
AccessAccessenum שמייצג כיתות של משתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.
PermissionPermissionenum שמייצג את ההרשאות שהוקצו למשתמשים שיש להם גישה לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.

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

מאפיינים

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

User

Methods

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