השירות הזה מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive. למרות שקל יותר להשתמש בשירות Drive המובנה, יש לו כמה מגבלות. כדי ליהנות מהתכונות והתמיכה העדכניות ביותר, ולגשת לקבצים או לתיקיות באחסון שיתופי, צריך להשתמש בשירות Drive המתקדם.
אם הסקריפט משתמש בפרויקט Cloud רגיל במקום בפרויקט Cloud שמוגדר כברירת מחדל, צריך להפעיל את Drive API באופן ידני. בפרויקט הרגיל של Cloud, מפעילים את 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 שמייצג סוגי משתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף למשתמשים פרטיים שקיבלו גישה באופן מפורש. |
Drive | מאפשר לסקריפטים ליצור, למצוא ולשנות קבצים ותיקיות ב-Google Drive. |
File | קובץ ב-Google Drive. |
File | איטרטור שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של קבצים. |
Folder | תיקייה ב-Google Drive. |
Folder | אובייקט שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של תיקיות. |
Permission | סוג enum שמייצג את ההרשאות שניתנו למשתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש. |
User | משתמש שמקושר לקובץ ב-Google Drive. |
Access
מאפיינים
| נכס | סוג | תיאור |
|---|---|---|
ANYONE | Enum | כל מי שגולש באינטרנט יכול למצוא ולקבל גישה. |
ANYONE_WITH_LINK | Enum | כל מי שיש לו את הקישור יכול לגשת. |
DOMAIN | Enum | אנשים בדומיין שלכם יכולים למצוא ולקבל גישה. |
DOMAIN_WITH_LINK | Enum | אנשים בדומיין שלכם שיש להם את הקישור יכולים לגשת. |
PRIVATE | Enum | רק אנשים שקיבלו הרשאה מפורשת יכולים לקבל גישה. |
Drive App
מאפיינים
| נכס | סוג | תיאור |
|---|---|---|
Access | Access | סוג enum שמייצג סוגי משתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף למשתמשים פרטיים שקיבלו גישה באופן מפורש. |
Permission | Permission | סוג enum שמייצג את ההרשאות שניתנו למשתמשים שיכולים לגשת לקובץ או לתיקייה, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש. |
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
continue | File | ממשיך איטרציה של קובץ באמצעות אסימון המשך מאיטרטור קודם. |
continue | Folder | ממשיך איטרציה של תיקייה באמצעות אסימון המשך מאיטרטור קודם. |
create | File | יוצר קובץ בתיקיית הבסיס של המשתמש ב-Drive מתוך Blob נתון שרירותי. |
create | File | יוצר קובץ טקסט בשורש של Drive של המשתמש עם השם והתוכן שצוינו. |
create | File | יוצר קובץ בשורש של Drive של המשתמש עם השם, התוכן וסוג ה-MIME שצוינו. |
create | Folder | יוצר תיקייה בשורש של Drive של המשתמש עם השם שצוין. |
create | File | יוצר קיצור דרך למזהה הפריט ב-Drive שצוין ומחזיר אותו. |
create | File | יוצר קיצור דרך למזהה הפריט ולמפתח המשאב שצוינו ב-Drive ומחזיר אותו. |
enforce | void | הגדרה שמאפשרת או משביתה את ההתנהגות של enforceSingleParent לכל השיחות שמשפיעות על פריטי הורה. |
get | File | מקבל את הקובץ עם המזהה שצוין. |
get | File | מקבל את הקובץ עם המזהה וקוד הגישה שצוינו. |
get | File | מקבלים אוסף של כל הקבצים ב-Drive של המשתמש. |
get | File | מקבל אוסף של כל הקבצים ב-Drive של המשתמש עם השם שצוין. |
get | File | מקבל אוסף של כל הקבצים ב-Drive של המשתמש שיש להם את סוג ה-MIME שצוין. |
get | Folder | הפונקציה מחזירה את התיקייה עם המזהה הנתון. |
get | Folder | מקבל את התיקייה עם המזהה ומפתח המשאב שצוינו. |
get | Folder | קבלת אוסף של כל התיקיות ב-Drive של המשתמש. |
get | Folder | מקבל אוסף של כל התיקיות ב-Drive של המשתמש עם השם שצוין. |
get | Folder | מקבל את התיקייה בבסיס של Drive של המשתמש. |
get | Integer | מחזירה את מספר הבייטים שהמשתמש יכול לאחסן ב-Drive. |
get | Integer | מחזירה את מספר הבייטים שהמשתמש מאחסן כרגע ב-Drive. |
get | File | מקבלים אוסף של כל הקבצים באשפה של המשתמש ב-Drive. |
get | Folder | מקבלים אוסף של כל התיקיות באשפה של המשתמש ב-Drive. |
search | File | מחזירה אוסף של כל הקבצים ב-Drive של המשתמש שתואמים לקריטריוני החיפוש שצוינו. |
search | Folder | מקבל אוסף של כל התיקיות ב-Drive של המשתמש שתואמות לקריטריוני החיפוש שצוינו. |
File
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | File | הוספת המשתמש שצוין לרשימת המגיבים של File. |
add | File | הוספת המשתמש שצוין לרשימת המגיבים של File. |
add | File | הוספת מערך המשתמשים שצוין לרשימת המגיבים של File. |
add | File | הוספת המשתמש שצוין לרשימת העורכים של File. |
add | File | הוספת המשתמש שצוין לרשימת העורכים של File. |
add | File | מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של File. |
add | File | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של File. |
add | File | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של File. |
add | File | הפונקציה מוסיפה את מערך המשתמשים שצוין לרשימת הצופים של File. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Blob | החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין. |
get | Blob | החזרת הנתונים בתוך האובייקט הזה כ-blob. |
get | Date | הפונקציה מחזירה את התאריך שבו נוצר File. |
get | String | מחזירה את התיאור של File. |
get | String | מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי להוריד את הקובץ. |
get | User[] | מקבל את רשימת העורכים של File. |
get | String | הפונקציה מחזירה את המזהה של File. |
get | Date | מחזירה את התאריך שבו File עודכן לאחרונה. |
get | String | מחזירה את סוג ה-MIME של הקובץ. |
get | String | הפונקציה מקבלת את השם של File. |
get | User | מחזירה את הבעלים של הקובץ. |
get | Folder | מקבל אוסף של תיקיות שהן תיקיות אב ישירות של File. |
get | String | מקבל את מפתח המשאב של File שנדרש לגישה לפריטים ששותפו באמצעות קישור. |
get | Boolean | מחזירה אם אפשר להחיל על File את עדכון האבטחה שדורש קוד גישה כדי לגשת אליו כשמשתפים אותו באמצעות קישור. |
get | Boolean | הפונקציה מחזירה את הערך true אם נדרש מפתח משאב כדי לגשת ל-File כשמשתפים אותו באמצעות קישור, אחרת היא מחזירה את הערך false. |
get | Access | הפונקציה מחזירה את סוג המשתמשים שיכולים לגשת אל File, בנוסף למשתמשים פרטיים שקיבלו גישה באופן מפורש. |
get | Permission | מקבל את ההרשאה שניתנה למשתמשים שיכולים לגשת אל File, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש. |
get | Integer | הפונקציה מחזירה את מספר הבייטים שמשמשים לאחסון File ב-Drive. |
get | String | אם זהו קיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מצביע. |
get | String | אם מדובר בקיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מצביע. |
get | String | אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מצביע. |
get | Blob|null | מחזירה תמונה ממוזערת של הקובץ, או null אם לא קיימת תמונה ממוזערת. |
get | String | מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את File באפליקציית Google כמו Drive או Docs. |
get | User[] | מחזירה את רשימת הצופים והמגיבים של File. |
is | Boolean | ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-File יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
is | Boolean | ההגדרה קובעת אם File סומן בכוכב ב-Drive של המשתמש. |
is | Boolean | ההגדרה קובעת אם הקובץ File נמצא באשפה ב-Drive של המשתמש. |
make | File | יצירת עותק של הקובץ. |
make | File | יוצר עותק של הקובץ בספריית היעד. |
make | File | יוצר עותק של הקובץ ונותן לו את השם שצוין. |
make | File | יוצר עותק של הקובץ בספריית היעד ונותן לו את השם שצוין. |
move | File | העברת הפריט לתיקיית היעד שצוינה. |
remove | File | מסיר את המשתמש שצוין מרשימת המגיבים של File. |
remove | File | מסיר את המשתמש שצוין מרשימת המגיבים של File. |
remove | File | מסיר את המשתמש שצוין מרשימת העורכים של File. |
remove | File | מסיר את המשתמש שצוין מרשימת העורכים של File. |
remove | File | הסרת המשתמש שצוין מרשימת הצופים והמגיבים של File. |
remove | File | הסרת המשתמש שצוין מרשימת הצופים והמגיבים של File. |
revoke | File | מבטלת את הגישה אל File שהוענקה למשתמש מסוים. |
revoke | File | מבטלת את הגישה אל File שהוענקה למשתמש מסוים. |
set | File | התוכן של הקובץ נכתב מחדש עם ההחלפה שצוינה. |
set | File | מגדיר את התיאור של File. |
set | File | מגדיר את השם של File. |
set | File | שינוי הבעלים של File. |
set | File | שינוי הבעלים של File. |
set | File | ההגדרה קובעת אם נדרש מפתח משאב כדי לגשת ל-File כשמשתפים אותו באמצעות קישור. |
set | File | ההגדרה קובעת אם משתמשים עם הרשאת עריכה ב-File יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
set | File | ההגדרה הזו קובעת לאיזה סוג של משתמשים תהיה גישה ל-File ואילו הרשאות יקבלו המשתמשים האלה, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש. |
set | File | הגדרה של סימון File בכוכב ב-Drive של המשתמש. |
set | File | קובעת אם File נמצא באשפה ב-Drive של המשתמש. |
File Iterator
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
get | String | מקבלים טוקן שאפשר להשתמש בו כדי להמשיך את האיטרציה הזו במועד מאוחר יותר. |
has | Boolean | קובעת אם קריאה ל-next() תחזיר פריט. |
next() | File | מחזירה את הפריט הבא באוסף הקבצים או התיקיות. |
Folder
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | Folder | הוספת המשתמש שצוין לרשימת העורכים של Folder. |
add | Folder | הוספת המשתמש שצוין לרשימת העורכים של Folder. |
add | Folder | מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של Folder. |
add | Folder | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של Folder. |
add | Folder | הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של Folder. |
add | Folder | הפונקציה מוסיפה את מערך המשתמשים שצוין לרשימת הצופים של Folder. |
create | File | יוצר קובץ בתיקייה הנוכחית מתוך Blob נתונים שרירותיים. |
create | File | יוצר קובץ טקסט בתיקייה הנוכחית עם השם והתוכן שצוינו. |
create | File | יוצרת קובץ בתיקייה הנוכחית עם השם, התוכן וסוג ה-MIME שצוינו. |
create | Folder | יוצר תיקייה בתיקייה הנוכחית עם השם שצוין. |
create | File | יוצר קיצור דרך למזהה הפריט ב-Drive שצוין ומחזיר אותו. |
create | File | יוצר קיצור דרך למזהה הפריט ולמפתח המשאב שצוינו ב-Drive ומחזיר אותו. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Permission | מקבל את ההרשאה שניתנה למשתמש ספציפי. |
get | Date | הפונקציה מחזירה את התאריך שבו נוצר Folder. |
get | String | מחזירה את התיאור של Folder. |
get | User[] | מקבל את רשימת העורכים של Folder. |
get | File | מחזירה אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית. |
get | File | מחזירה אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ויש להם את השם שצוין. |
get | File | מחזירה אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ושיש להם את סוג ה-MIME שצוין. |
get | Folder | מחזירה אוסף של כל התיקיות שהן צאצא של התיקייה הנוכחית. |
get | Folder | מחזירה אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ויש להן את השם שצוין. |
get | String | הפונקציה מחזירה את המזהה של Folder. |
get | Date | מחזירה את התאריך שבו Folder עודכן לאחרונה. |
get | String | הפונקציה מקבלת את השם של Folder. |
get | User | הפונקציה מחזירה את הבעלים של Folder. |
get | Folder | מקבל אוסף של תיקיות שהן תיקיות אב ישירות של Folder. |
get | String | מקבל את מפתח המשאב של Folder שנדרש לגישה לפריטים ששותפו באמצעות קישור. |
get | Boolean | מחזירה אם אפשר להחיל על Folder את עדכון האבטחה שדורש קוד גישה כדי לגשת אליו כשמשתפים אותו באמצעות קישור. |
get | Boolean | הפונקציה מחזירה את הערך true אם נדרש מפתח משאב כדי לגשת ל-Folder כשמשתפים אותו באמצעות קישור, אחרת היא מחזירה את הערך false. |
get | Access | הפונקציה מחזירה את סוג המשתמשים שיכולים לגשת אל Folder, בנוסף למשתמשים פרטיים שקיבלו גישה באופן מפורש. |
get | Permission | מקבל את ההרשאה שניתנה למשתמשים שיכולים לגשת אל Folder, בנוסף לכל משתמש בודד שקיבל גישה באופן מפורש. |
get | Integer | הפונקציה מחזירה את מספר הבייטים שמשמשים לאחסון Folder ב-Drive. |
get | String | מחזירה את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את Folder באפליקציית Google כמו Drive או Docs. |
get | User[] | מחזירה את רשימת הצופים והמגיבים של Folder. |
is | Boolean | ההגדרה קובעת אם משתמשים עם הרשאות עריכה ב-Folder יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
is | Boolean | ההגדרה קובעת אם Folder סומן בכוכב ב-Drive של המשתמש. |
is | Boolean | ההגדרה קובעת אם הקובץ Folder נמצא באשפה ב-Drive של המשתמש. |
move | Folder | העברת הפריט לתיקיית היעד שצוינה. |
remove | Folder | מסיר את המשתמש שצוין מרשימת העורכים של Folder. |
remove | Folder | מסיר את המשתמש שצוין מרשימת העורכים של Folder. |
remove | Folder | הסרת המשתמש שצוין מרשימת הצופים והמגיבים של Folder. |
remove | Folder | הסרת המשתמש שצוין מרשימת הצופים והמגיבים של Folder. |
revoke | Folder | מבטלת את הגישה אל Folder שהוענקה למשתמש מסוים. |
revoke | Folder | מבטלת את הגישה אל Folder שהוענקה למשתמש מסוים. |
search | File | מקבל אוסף של כל הקבצים שהם צאצאים של התיקייה הנוכחית ותואמים לקריטריוני החיפוש שצוינו. |
search | Folder | מאחזר אוסף של כל התיקיות שהן צאצאים של התיקייה הנוכחית ותואמות לקריטריוני החיפוש שצוינו. |
set | Folder | מגדיר את התיאור של Folder. |
set | Folder | מגדיר את השם של Folder. |
set | Folder | שינוי הבעלים של Folder. |
set | Folder | שינוי הבעלים של Folder. |
set | Folder | ההגדרה קובעת אם נדרש מפתח משאב כדי לגשת ל-Folder כשמשתפים אותו באמצעות קישור. |
set | Folder | ההגדרה קובעת אם משתמשים עם הרשאת עריכה ב-Folder יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות. |
set | Folder | ההגדרה הזו קובעת לאיזה סוג של משתמשים תהיה גישה ל-Folder ואילו הרשאות יקבלו המשתמשים האלה, בנוסף למשתמשים ספציפיים שקיבלו גישה באופן מפורש. |
set | Folder | הגדרה של סימון Folder בכוכב ב-Drive של המשתמש. |
set | Folder | קובעת אם Folder נמצא באשפה ב-Drive של המשתמש. |
Folder Iterator
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
get | String | מקבלים טוקן שאפשר להשתמש בו כדי להמשיך את האיטרציה הזו במועד מאוחר יותר. |
has | Boolean | קובעת אם קריאה ל-next() תחזיר פריט. |
next() | Folder | מחזירה את הפריט הבא באוסף הקבצים או התיקיות. |
Permission
מאפיינים
| נכס | סוג | תיאור |
|---|---|---|
VIEW | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק לצפות בהם או להעתיק אותם. |
EDIT | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים לערוך אותם. |
COMMENT | Enum | משתמשים שיש להם גישה לקובץ או לתיקייה יכולים רק לצפות בהם, להעתיק אותם או להגיב עליהם. |
OWNER | Enum | המשתמש הוא הבעלים של הקובץ או התיקייה. |
ORGANIZER | Enum | משתמשים שיכולים לארגן קבצים ותיקיות בתוך אחסון שיתופי. |
FILE_ORGANIZER | Enum | משתמשים שיכולים לערוך, להעביר לאשפה ולהעביר תוכן בתוך אחסון שיתופי. |
NONE | Enum | למשתמש אין הרשאות לקובץ או לתיקייה. |
User
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
get | String|null | מקבל את שם הדומיין שמשויך לחשבון של המשתמש. |
get | String|null | מקבל את כתובת האימייל של המשתמש. |
get | String|null | מקבל את השם של המשתמש. |
get | String|null | מקבל את כתובת ה-URL של התמונה של המשתמש. |