דף זה תורגם על ידי Cloud Translation API.

Class File

קובץ ב-Google Drive. יש לך אפשרות ליצור קבצים או לגשת אליהם דרך DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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 של המשתמש.

תיעוד מפורט

`addCommenter(emailAddress)`

הוספת המשתמש הנתון לרשימת המגיבים בFile. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להוסיף.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addCommenter(user)`

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addCommenters(emailAddresses)`

מוסיפים את מערך המשתמשים הנתון לרשימת המגיבים ב-File. אם משתמש כלשהו כבר היה ברשימת הצופים, השיטה הזו מקדמת אותו מחוץ לרשימת הצופים.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters.
  const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com'];
  console.log(file.addCommenters(emails));
}

פרמטרים

שם	תיאור	התיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addEditor(emailAddress)`

מוסיף את המשתמש הנתון לרשימת העורכים של File. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להוסיף.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addEditor(user)`

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addEditors(emailAddresses)`

מוסיף את מערך המשתמשים הנתון לרשימת העורכים של File. אם אחד מהמשתמשים כבר היה ברשימת הצופים, השיטה הזו מקדמת אותו מחוץ לרשימת הצופים.

פרמטרים

שם	תיאור	התיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addViewer(emailAddress)`

מוסיף את המשתמש הנתון לרשימת הצופים בFile. אם המשתמש כבר היה ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להוסיף.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addViewer(user)`

מוסיף את המשתמש הנתון לרשימת הצופים בFile. אם המשתמש כבר היה ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`addViewers(emailAddresses)`

הוספה של מערך המשתמשים הנתון לרשימת הצופים של File. אם אחד מהמשתמשים כבר היה ברשימת העורכים, לשיטה הזו אין השפעה עליו.

פרמטרים

שם	תיאור	התיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים להוספה.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`getAccess(email)`

הפונקציה מקבלת את ההרשאה שהוענקה למשתמש הנתון.

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש לבדוק את ההרשאות שלו

החזרות

Permission – ההרשאות שהוענקו למשתמש

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getAccess(user)`

הפונקציה מקבלת את ההרשאה שהוענקה למשתמש הנתון.

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שצריך לבדוק את ההרשאות שלו

החזרות

Permission – ההרשאות שהוענקו למשתמש

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getAs(contentType)`

החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. השיטה הזו מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, 'myfile.pdf'. עם זאת, ההנחה היא שהחלק שמופיע בשם הקובץ אחרי הנקודה האחרונה (אם יש כזה) הוא תוסף קיים שצריך להחליף. בעקבות זאת, הערך "ShoppingList.12.25.2014" הופך ל-"ShoppingList.12.25.pdf".

במאמר מכסות לשירותי Google תוכלו לראות את המכסות היומיות להמרות. באופן זמני, דומיינים חדשים ב-Google Workspace עשויים להיות כפופים למכסות מחמירות יותר.

פרמטרים

שם	תיאור	התיאור
`contentType`	`String`	סוג ה-MIME שאליו יש להמיר. ברוב ה-blobs, `'application/pdf'` היא האפשרות החוקית היחידה. עבור תמונות בפורמט BMP, GIF, JPEG או PNG, ניתן גם להשתמש בכל אחד מהערכים `'image/bmp'`, `'image/gif'`, `'image/jpeg'` או `'image/png'`.

החזרות

Blob – הנתונים כ-blob.

`getBlob()`

החזרת הנתונים שבתוך האובייקט הזה כ-blob.

החזרות

Blob – הנתונים כ-blob.

`getDateCreated()`

הפונקציה מקבלת את תאריך היצירה של File.

החזרות

Date – התאריך שבו File נוצר

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDescription()`

הפונקציה מקבלת את התיאור של File.

החזרות

String - התיאור של File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDownloadUrl()`

הפונקציה מקבלת את כתובת ה-URL שדרכה אפשר להוריד את הקובץ. רק משתמשים עם הרשאה לפתוח קובץ ב-Google Drive יכולים לגשת לכתובת ה-URL. תוכלו להשתמש בכתובת ה-URL הזו בדפדפן כדי להוריד את הקובץ, אבל לא תוכלו להשתמש בו כדי לאחזר את הקובץ בעזרת UrlFetchApp. כדי לכלול את תוכן הקובץ בסקריפט, השתמשו ב-getBlob().

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

החזרות

String – כתובת ה-URL שדרכה אפשר להוריד את הקובץ.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getEditors()`

הפונקציה מקבלת את רשימת העורכים של File. אם למשתמש שמבצע את הסקריפט אין גישת עריכה ל-File, השיטה הזו מחזירה מערך ריק.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

החזרות

User[] – אם למשתמש יש גישת עריכה במכשיר File, תוצג רשימת העורכים. אם למשתמש אין גישת עריכה, מחזירה מערך ריק.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getId()`

הפונקציה מקבלת את המזהה של File.

החזרות

String – המזהה של File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getLastUpdated()`

הפונקציה מקבלת את תאריך העדכון האחרון של File.

החזרות

Date – התאריך שבו File עודכן לאחרונה

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getMimeType()`

הפונקציה מקבלת את סוג ה-MIME של הקובץ.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

החזרות

String - סוג ה-MIME של הקובץ.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getName()`

הפונקציה מקבלת את השם של File.

החזרות

String - השם של File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getOwner()`

מאתר את הבעלים של הקובץ.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

החזרות

User - הבעלים של הקובץ.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getParents()`

מקבלת אוסף של תיקיות שהן הורה מיידי של File.

החזרות

FolderIterator - אוסף של תיקיות שהן הורה מיידי של File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getResourceKey()`

הפונקציה מקבלת את מפתח המשאב של File שנדרש כדי לגשת לפריטים ששותפו באמצעות קישור.

החזרות

String - מפתח המשאב של File.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEligible()`

כך אפשר לדעת אם File עומד בדרישות להחלת עדכון האבטחה שדורש מפתח משאב כדי לקבל גישה אליו, כשמשתפים אותו באמצעות קישור.

כדי לגשת לתיקיות או לקבצים ששותפו באמצעות קישור, נדרש מפתח משאב ב-Drive. השינוי הזה הוא חלק מעדכון אבטחה. העדכון פועל כברירת מחדל בקבצים ובתיקיות שעומדים בדרישות. כדי להפעיל או להשבית את הדרישה של מפתח המשאב בקבצים שעומדים בדרישות, צריך להשתמש ב-setSecurityUpdateEnabled.

למידע נוסף על עדכון האבטחה של Google Drive.

החזרות

Boolean – האם אפשר להחיל את הדרישה של מפתח המשאב עבור File.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEnabled()`

מציין אם שיתוף של File באמצעות קישור דורש מפתח משאב לצורך גישה. הדרישה הזו מופעלת כברירת מחדל בקבצים ובתיקיות שעומדים בדרישות. כדי להפעיל או להשבית את הדרישה של מפתח המשאב בקבצים שעומדים בדרישות, יש להשתמש ב-setSecurityUpdateEnabled.

למידע נוסף על עדכון האבטחה של Google Drive.

החזרות

Boolean – האם הדרישה של מפתח המשאב מופעלת עבור File.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingAccess()`

מראה איזו סיווג של משתמשים יכולה לגשת ל-File, מלבד משתמשים ספציפיים שקיבלו גישה באופן מפורש.

החזרות

Access – איזו קטגוריה של משתמשים יכולה לגשת אל File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingPermission()`

הפונקציה הזו מקבלת את ההרשאה שניתנה למשתמשים שיש להם גישה ל-File, בנוסף לכל משתמש שקיבל גישה באופן מפורש.

החזרות

Permission – ההרשאות שהוענקו למשתמשים שיכולים לגשת אל File

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSize()`

הפונקציה מקבלת את מספר הבייטים המשמשים לשמירת הקובץ File ב-Drive. שימו לב: קבצים של אפליקציות Google Workspace לא נכללים במגבלות האחסון ב-Drive, ולכן מקבלים 0 בייטים.

החזרות

Integer – מספר הבייטים באחסון של File ב-Drive

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getTargetId()`

אם זהו קיצור דרך, הפונקציה מחזירה את המזהה של הפריט שאליו הוא מפנה.

אחרת, הוא יחזיר null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

החזרות

String – מזהה פריט היעד.

`getTargetMimeType()`

אם זהו קיצור דרך, סוג ה-MIME של הפריט שאליו הוא מפנה.

אחרת, הוא יחזיר null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

החזרות

String – סוג ה-mime של פריט היעד.

`getTargetResourceKey()`

אם הקובץ הוא קיצור דרך, הפונקציה מחזירה את מקש המשאב של הפריט שאליו הוא מפנה. מפתח משאב הוא פרמטר נוסף שצריך להעביר כדי לקבל גישה לקבצים ששותפו באמצעות קישור.

אם הקובץ אינו קיצור דרך, הפונקציה מחזירה את הערך null.

// Gets a file by its ID.
// TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it points to.
console.log(file.getTargetResourceKey());

החזרות

String – מקש המשאב של פריט היעד או null אם הקובץ אינו קיצור דרך.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getThumbnail()`

הפונקציה מקבלת תמונה ממוזערת של הקובץ, או null אם לא קיימת תמונה ממוזערת.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

החזרות

Blob - התמונה הממוזערת של הקובץ.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getUrl()`

הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לפתוח את File באפליקציית Google, כמו Drive או Docs.

החזרות

String – כתובת ה-URL שניתן להשתמש בה כדי להציג את File הזה באפליקציית Google כמו Drive או Docs

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getViewers()`

הצגת רשימת הצופים והמגיבים בFile הזה. אם למשתמש שמריץ את הסקריפט אין גישת עריכה ל-File, ה-method הזה מחזיר מערך ריק.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

החזרות

User[] — אם למשתמש יש גישת עריכה במכשיר File, הפונקציה מחזירה את רשימת הצופים והמגיבים. אם למשתמש אין גישת עריכה, מחזירה מערך ריק.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isShareableByEditors()`

המדיניות הזו קובעת אם משתמשים שיש להם הרשאות עריכה ב-File יוכלו לשתף עם משתמשים אחרים או לשנות את ההרשאות.

החזרות

Boolean — true אם משתמשים עם הרשאות עריכה יכולים לשתף עם משתמשים אחרים או לשנות את ההרשאות; false אם לא

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isStarred()`

המדיניות הזו קובעת אם File סומן בכוכב ב-Drive של המשתמש.

החזרות

Boolean - true אם File מסומן בכוכב ב-Drive של המשתמש; false אם לא

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isTrashed()`

המדיניות קובעת אם File נמצא באשפה של ה-Drive של המשתמש.

החזרות

Boolean - true אם File נמצא באשפה של ה-Drive של המשתמש; false אם לא

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`makeCopy()`

יוצר עותק של הקובץ.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

החזרות

File - העותק החדש.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`makeCopy(destination)`

יצירת עותק של הקובץ בספריית היעד.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

פרמטרים

שם	תיאור	התיאור
`destination`	`Folder`	הספרייה שאליה מעתיקים את הקובץ.

החזרות

File - העותק החדש.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`makeCopy(name)`

יוצר עותק של הקובץ ונותן לו שם עם השם שסופק.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

פרמטרים

שם	תיאור	התיאור
`name`	`String`	שם הקובץ שצריך להחיל על העותק החדש.

החזרות

File - העותק החדש.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`makeCopy(name, destination)`

יוצר עותק של הקובץ בספריית היעד ונותן לו שם עם השם שסופק.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

פרמטרים

שם	תיאור	התיאור
`name`	`String`	שם הקובץ שצריך להחיל על העותק החדש.
`destination`	`Folder`	הספרייה שאליה מעתיקים את הקובץ.

החזרות

File - העותק החדש.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`moveTo(destination)`

מעביר את הפריט הזה לתיקיית היעד שצוינה.

כדי להעביר את הפריט לתיקיית היעד, המשתמש הנוכחי צריך להיות הבעלים של הקובץ או בעל גישת עריכה לפחות בתיקיית ההורה הנוכחית של הפריט.

פרמטרים

שם	תיאור	התיאור
`destination`	`Folder`	התיקייה שתהפוך להורה החדש.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeCommenter(emailAddress)`

מסיר את המשתמש הנתון מרשימת המגיבים בFile. השיטה הזו לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים למחלקה של משתמשים שיש להם גישה כללית – למשל, אם File משותף עם כל הדומיין של המשתמש.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להסיר.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeCommenter(user)`

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש להסיר.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeEditor(emailAddress)`

מסיר את המשתמש הנתון מרשימת העורכים של File. השיטה הזו לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים לקטגוריה של משתמשים שיש להם גישה כללית, למשל אם File משותף עם כל הדומיין של המשתמש, או אם File נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להסיר.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeEditor(user)`

בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש להסיר.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeViewer(emailAddress)`

מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בFile. לשיטה הזו אין השפעה אם המשתמש הוא עורך, ולא צופה או מגיב. השיטה הזו גם לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים לסוג של משתמשים שיש להם גישה כללית, למשל אם File משותף עם כל הדומיין של המשתמש, או אם File נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להסיר.

החזרות

File – File לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`removeViewer(user)`

מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בFile. לשיטה הזו אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים לקטגוריה של משתמשים שיש להם גישה כללית, למשל אם File משותף עם כל הדומיין של המשתמש, או אם ה-File נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש להסיר.

החזרות

File – File לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`revokePermissions(emailAddress)`

ביטול הגישה אל File שהוענקה למשתמש הנתון. השיטה הזו לא חוסמת את הגישה של משתמשים ל-File אם הם שייכים לקטגוריה של משתמשים שיש להם גישה כללית, למשל אם File משותף עם כל הדומיין של המשתמש.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש לבטל את הגישה שלו.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`revokePermissions(user)`

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש לבטל את הגישה שלו.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setContent(content)`

תוכן הקובץ יוחלף בהחלפה נתונה. הפונקציה מוסיפה החרגה אם הקובץ content גדול מ-10MB.

// Creates a text file with the content 'Hello, world!'
file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

פרמטרים

שם	תיאור	התיאור
`content`	`String`	התוכן החדש של הקובץ.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setDescription(description)`

מגדיר את התיאור של File.

פרמטרים

שם	תיאור	התיאור
`description`	`String`	התיאור החדש של `File`

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setName(name)`

הגדרת השם של File.

פרמטרים

שם	תיאור	התיאור
`name`	`String`	השם החדש של `File`

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setOwner(emailAddress)`

משנה את הבעלים של File. השיטה הזו גם נותנת לבעלים הקודם גישת עריכה מפורשת ל-File.

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שאמור להפוך לבעלים החדש

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setOwner(user)`

משנה את הבעלים של File. השיטה הזו גם נותנת לבעלים הקודם גישת עריכה מפורשת ל-File.

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שאמור להפוך לבעלים החדש

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setSecurityUpdateEnabled(enabled)`

המדיניות הזו קובעת אם הקוד File מחייב מפתח משאב לצורך גישה, כשמשתפים אותו באמצעות קישור. הקבצים והתיקיות המתאימים מופעלים כברירת מחדל.

למידע נוסף על עדכון האבטחה של Google Drive.

פרמטרים

שם	תיאור	התיאור
`enabled`	`Boolean`	האם להפעיל את הדרישה של מפתח המשאב עבור `File`.

החזרות

File – File, לשרשור.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setShareableByEditors(shareable)`

המדיניות קובעת אם משתמשים שיש להם הרשאות עריכה ב-File יוכלו לשתף עם משתמשים אחרים או לשנות את ההרשאות. ברירת המחדל במשתנה File חדש היא true.

פרמטרים

שם	תיאור	התיאור
`shareable`	`Boolean`	`true` אם משתמשים עם הרשאות עריכה יוכלו לשתף עם משתמשים אחרים או לשנות את ההרשאות. `false` אם לא,

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setSharing(accessType, permissionType)`

ההגדרה קובעת איזו רמה של משתמשים יכולים לגשת ל-File ואילו הרשאות מוקצות למשתמשים האלה, מלבד משתמשים בודדים שקיבלו גישה מפורשת.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

פרמטרים

שם	תיאור	התיאור
`accessType`	`Access`	איזו קבוצת משתמשים תוכל לגשת אל `File`
`permissionType`	`Permission`	ההרשאות שיש להעניק למשתמשים שיכולים לגשת אל `File`

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setStarred(starred)`

המדיניות הזו קובעת אם File יסומן בכוכב ב-Drive של המשתמש. ברירת המחדל לקובצי File חדשים היא false.

פרמטרים

שם	תיאור	התיאור
`starred`	`Boolean`	`true` אם צריך לסמן את `File` בכוכב ב-Drive של המשתמש; `false` אם לא

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive

`setTrashed(trashed)`

המדיניות הזו קובעת אם File נמצא באשפה של ה-Drive של המשתמש. רק הבעלים יכול להעביר את File לאשפה. ברירת המחדל עבור חדשים מסוג File היא false.

פרמטרים

שם	תיאור	התיאור
`trashed`	`Boolean`	`true` אם צריך להעביר את `File` לאשפה של ה-Drive של המשתמש; `false` אם לא

החזרות

File — File, לשרשור

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/drive