השירות הזה מאפשר ל-scripts ליצור, לאתר ולשנות קבצים ותיקיות ב-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 | מחזור (iterator) שמאפשר לסקריפטים לבצע איטרציה על אוסף גדול של קבצים. |
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 | יצירת קובץ ברמה הבסיסית (root) של Drive של המשתמש מ-Blob נתונים שרירותיים. |
create | File | יצירת קובץ טקסט בספריית השורש של Drive של המשתמש עם השם והתוכן שצוינו. |
create | File | יצירת קובץ ברמה הבסיסית (root) של 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 | הפונקציה מקבלת את הערך שמציין אם File הזה מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. |
get | Access | הפונקציה מקבלת את סוג המשתמשים שיכולים לגשת ל-File , מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
get | Permission | הפונקציה מקבלת את ההרשאה שהוענקה למשתמשים שיכולים לגשת ל-File , מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש. |
get | Integer | הפונקציה מקבלת את מספר הבייטים ששימשו לאחסון ה-File ב-Drive. |
get | String | אם מדובר בקיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מפנה. |
get | String | אם מדובר בקיצור דרך, הפונקציה מחזירה את סוג ה-MIME של הפריט שאליו הוא מפנה. |
get | String | אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מפתח המשאב של הפריט שאליו הוא מפנה. |
get | Blob | הפונקציה מקבלת תמונה ממוזערת של הקובץ, או את הערך 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 | הפונקציה מקבלת את הערך שמציין אם Folder הזה מחייב מפתח משאב לגישה כשהוא שותף באמצעות קישור. |
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 | הפונקציה מקבלת את שם הדומיין שמשויך לחשבון המשתמש. |
get | String | הפונקציה מקבלת את כתובת האימייל של המשתמש. |
get | String | הפונקציה מקבלת את שם המשתמש. |
get | String | הפונקציה מקבלת את כתובת ה-URL של התמונה של המשתמש. |