Class File

Файл

Файл на Google Диске. Доступ к файлам или их создание можно получить из 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 Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getBlob() 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 на диске.
getTargetId() String Если это ярлык, возвращает идентификатор элемента, на который он указывает.
getTargetMimeType() String Если это ярлык, возвращает MIME-тип элемента, на который он указывает.
getTargetResourceKey() String Если файл является ярлыком, возвращает ключ ресурса элемента, на который он указывает.
getThumbnail() Blob Получает миниатюру для файла или null , если миниатюра не существует.
getUrl() String Получает URL-адрес, который можно использовать для открытия File в приложении Google, таком как Диск или Документы.
getViewers() User[] Получает список зрителей и комментаторов для этого File .
isShareableByEditors() Boolean Определяет, могут ли пользователи с разрешениями на редактирование File делиться с другими пользователями или изменять разрешения.
isStarred() Boolean Определяет, был ли File помечен на Диске пользователя.
isTrashed() Boolean Определяет, находится ли File в корзине на Диске пользователя.
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 помечен на Диске пользователя.
setTrashed(trashed) File Определяет, находится ли File в корзине на Диске пользователя.

Подробная документация

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)

Добавить данного пользователя в список комментаторов 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');

// 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)

Добавляет данного пользователя в список редакторов File . Если пользователь уже был в списке зрителей, этот метод продвигает пользователя из списка зрителей.

Параметры

Имя Тип Описание
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)

Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента. Этот метод добавляет к имени файла соответствующее расширение, например, «myfile.pdf». Однако предполагается, что часть имени файла, которая следует за последней точкой (если она есть), является существующим расширением, которое следует заменить. Следовательно, «Список покупок.12.25.2014» становится «Список покупок.12.25.pdf».

Чтобы просмотреть дневные квоты на конверсии, см. Квоты для сервисов Google . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя Тип Описание
contentType String Тип MIME для преобразования. Для большинства BLOB-объектов единственным допустимым вариантом является 'application/pdf' . Для изображений в формате BMP, GIF, JPEG или PNG допустимо любое из значений 'image/bmp' , 'image/gif' , 'image/jpeg' или 'image/png' .

Возвращаться

Blob — данные в виде большого двоичного объекта.

getBlob()

Верните данные внутри этого объекта в виде большого двоичного объекта.

Возвращаться

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 Диске могут получить доступ к 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 право применять обновление для системы безопасности, для доступа к которому требуется ключ ресурса, когда к нему предоставлен совместный доступ по ссылке.

Диску требуется ключ ресурса для доступа к некоторым файлам или папкам, к которым предоставлен общий доступ по ссылке. Это изменение является частью обновления безопасности. Обновление включено по умолчанию для подходящих файлов и папок. Чтобы включить или отключить требование ключа ресурса для подходящих файлов, используйте setSecurityUpdateEnabled .

Узнайте больше об обновлении безопасности для Google Диска .

Возвращаться

Boolean — можно ли применить требование ключа ресурса к File .

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

getSecurityUpdateEnabled()

Получает, требуется ли этому File ключ ресурса для доступа, когда к нему предоставлен общий доступ по ссылке. Это требование включено по умолчанию для подходящих файлов и папок. Чтобы включить или отключить требование ключа ресурса для подходящих файлов, используйте setSecurityUpdateEnabled .

Узнайте больше об обновлении безопасности для Google Диска .

Возвращаться

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 на диске. Обратите внимание, что файлы приложений Google Workspace не учитываются при ограничении объема хранилища на Диске и поэтому возвращают 0 байт.

Возвращаться

Integer — количество байтов, используемых для хранения File на диске.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • 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 .

Возвращаться

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, таком как Диск или Документы.

Возвращаться

String — URL-адрес, который можно использовать для просмотра этого File в приложении Google, таком как Диск или Документы.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

getViewers()

Получает список зрителей и комментаторов для этого 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();

  // 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 помечен на Диске пользователя.

Возвращаться

Boolean — true , если File помечен звездочкой на Диске пользователя; false если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

isTrashed()

Определяет, находится ли File в корзине на Диске пользователя.

Возвращаться

Boolean — true , если File находится в корзине Диска пользователя; 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)

Удаляет данного пользователя из списка комментаторов 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.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

Параметры

Имя Тип Описание
user User Представление пользователя, которого необходимо удалить.

Возвращаться

File — этот File для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

removeEditor(emailAddress)

Удаляет данного пользователя из списка редакторов File . Этот метод не блокирует пользователям доступ к File , если они принадлежат к классу пользователей с общим доступом, например, если File доступен для всего домена пользователя или если File находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка просматривающих.

Параметры

Имя Тип Описание
emailAddress String Адрес электронной почты пользователя, которого необходимо удалить.

Возвращаться

File — этот File для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

removeEditor(user)

Удаляет данного пользователя из списка редакторов File . Этот метод не блокирует пользователям доступ к File , если они принадлежат к классу пользователей с общим доступом, например, если File доступен для всего домена пользователя или если File находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка просматривающих.

Параметры

Имя Тип Описание
user User Представление пользователя, которого необходимо удалить.

Возвращаться

File — этот File для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

removeViewer(emailAddress)

Удаляет данного пользователя из списка просматривающих и комментирующих File . Этот метод не работает, если пользователь является редактором, а не зрителем или комментатором. Этот метод также не блокирует пользователям доступ к File , если они принадлежат к классу пользователей с общим доступом, например, если File доступен для всего домена пользователя или если File находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка редакторов.

Параметры

Имя Тип Описание
emailAddress String Адрес электронной почты пользователя, которого необходимо удалить.

Возвращаться

File — Этот File для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

removeViewer(user)

Удаляет данного пользователя из списка просматривающих и комментирующих File . Этот метод не работает, если пользователь является редактором, а не зрителем. Этот метод также не блокирует пользователям доступ к File , если они принадлежат к классу пользователей с общим доступом, например, если File доступен для всего домена пользователя или если File находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка редакторов.

Параметры

Имя Тип Описание
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)

Отменяет доступ к File , предоставленный данному пользователю. Этот метод не блокирует пользователям доступ к File , если они принадлежат к классу пользователей с общим доступом, например, если File доступен для всего домена пользователя.

Параметры

Имя Тип Описание
user User Представление пользователя, доступ которого должен быть отозван.

Возвращаться

File — этот File для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

setContent(content)

Перезаписывает содержимое файла с заданной заменой. Выдает исключение, если размер content превышает 10 МБ.

// 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 Диска .

Параметры

Имя Тип Описание
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 помечен на Диске пользователя. По умолчанию для новых File s установлено значение false .

Параметры

Имя Тип Описание
starred Boolean true , если File должен быть отмечен звездочкой на Диске пользователя; false если нет

Возвращаться

File — этот File , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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

setTrashed(trashed)

Определяет, находится ли File в корзине на Диске пользователя. Только владелец может удалить File . По умолчанию для новых File s установлено значение false .

Параметры

Имя Тип Описание
trashed Boolean true , если File нужно переместить в корзину на Диске пользователя; false если нет

Возвращаться

File — этот File , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

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