Drive Service

נהיגה

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

Access

נכסים

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

DriveApp

נכסים

מאפיין (property)סוגתיאור
AccessAccessטיפוסים מדומים (enum) הם סוגים של משתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת.
PermissionPermissionEnum, המייצג את ההרשאות שניתנות למשתמשים שיכולים לגשת לקובץ או לתיקייה, מלבד משתמשים ספציפיים שקיבלו גישה מפורשת.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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)סוגתיאור
VIEWEnumמשתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק להציג אותו או להעתיק אותו.
EDITEnumמשתמשים שיש להם גישה לקובץ או לתיקייה יכולים לערוך אותו.
COMMENTEnumמשתמשים שיכולים לגשת לקובץ או לתיקייה יכולים רק להציג אותו, להעתיק אותו או להגיב עליו.
OWNEREnumהמשתמש הוא הבעלים של הקובץ או התיקייה.
ORGANIZEREnumמשתמשים שיכולים לארגן קבצים ותיקיות באחסון שיתופי.
FILE_ORGANIZEREnumמשתמשים שיכולים לערוך, להעביר לאשפה ולהעביר תוכן בתוך אחסון שיתופי.
NONEEnumלמשתמש אין הרשאות עבור הקובץ או התיקייה.

User

שיטות

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