Drive Service

Google 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יוצר קובץ בתיקיית השורש של ה-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

תכונות

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

User

שיטות

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