Class File

Файл

Файл на Google Диске. Доступ к файлам и их создание можно получить из Drive App .

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

Методы

Метод Тип возврата Краткое описание
add Commenter(emailAddress) File Добавьте данного пользователя в список комментаторов File .
add Commenter(user) File Добавьте данного пользователя в список комментаторов File .
add Commenters(emailAddresses) File Добавьте данный массив пользователей в список комментаторов File .
add Editor(emailAddress) File Добавляет данного пользователя в список редакторов File .
add Editor(user) File Добавляет данного пользователя в список редакторов File .
add Editors(emailAddresses) File Добавляет заданный массив пользователей в список редакторов File .
add Viewer(emailAddress) File Добавляет данного пользователя в список просмотрщиков File .
add Viewer(user) File Добавляет данного пользователя в список просмотрщиков File .
add Viewers(emailAddresses) File Добавляет заданный массив пользователей в список просмотрщиков File .
get Access(email) Permission Получает разрешение, предоставленное конкретному пользователю.
get Access(user) Permission Получает разрешение, предоставленное конкретному пользователю.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Date Created() Date Получает дату создания File .
get Description() String Получает описание File .
get Download Url() String Получает URL-адрес, который можно использовать для загрузки файла.
get Editors() User[] Получает список редакторов для этого File .
get Id() String Получает идентификатор File .
get Last Updated() Date Получает дату последнего обновления File .
get Mime Type() String Получает MIME-тип файла.
get Name() String Получает имя File .
get Owner() User Получает владельца файла.
get Parents() Folder Iterator Получает коллекцию папок, которые являются непосредственными родительскими папками File .
get Resource Key() String Получает ключ ресурса File , необходимый для доступа к элементам, к которым предоставлен общий доступ по ссылке.
get Security Update Eligible() Boolean Определяет, имеет ли этот File право на применение обновления безопасности, для доступа к которому требуется ключ ресурса при его совместном использовании по ссылке.
get Security Update Enabled() Boolean Определяет, требует ли этот File ключ ресурса для доступа при его совместном использовании по ссылке.
get Sharing Access() Access Получает класс пользователей, которые могут получить доступ к File , помимо отдельных пользователей, которым явно предоставлен доступ.
get Sharing Permission() Permission Получает разрешение, предоставленное тем пользователям, которые могут получить доступ к File , помимо отдельных пользователей, которым явно предоставлен доступ.
get Size() Integer Получает количество байтов, используемых для хранения File на диске.
get Target Id() String Если это ярлык, возвращает идентификатор элемента, на который он указывает.
get Target Mime Type() String Если это ярлык, возвращает mime-тип элемента, на который он указывает.
get Target Resource Key() String Если файл является ярлыком, возвращает ключ ресурса элемента, на который он указывает.
get Thumbnail() Blob Получает миниатюру файла или null , если миниатюра не существует.
get Url() String Получает URL-адрес, который можно использовать для открытия File в приложении Google, например на Диске или Документах.
get Viewers() User[] Получает список читателей и комментаторов этого File .
is Shareable By Editors() Boolean Определяет, разрешено ли пользователям с разрешениями на редактирование File делиться с другими пользователями или изменять разрешения.
is Starred() Boolean Определяет, был ли File помечен на Диске пользователя.
is Trashed() Boolean Определяет, находится ли File в корзине Диска пользователя.
make Copy() File Создает копию файла.
make Copy(destination) File Создает копию файла в каталоге назначения.
make Copy(name) File Создает копию файла и называет ее указанным именем.
make Copy(name, destination) File Создает копию файла в каталоге назначения и называет ее указанным именем.
move To(destination) File Перемещает этот элемент в указанную папку назначения.
remove Commenter(emailAddress) File Удаляет данного пользователя из списка комментаторов File .
remove Commenter(user) File Удаляет данного пользователя из списка комментаторов File .
remove Editor(emailAddress) File Удаляет данного пользователя из списка редакторов File .
remove Editor(user) File Удаляет данного пользователя из списка редакторов File .
remove Viewer(emailAddress) File Удаляет данного пользователя из списка читателей и комментаторов File .
remove Viewer(user) File Удаляет данного пользователя из списка читателей и комментаторов File .
revoke Permissions(emailAddress) File Отменяет доступ к File , предоставленный данному пользователю.
revoke Permissions(user) File Отменяет доступ к File , предоставленный данному пользователю.
set Content(content) File Перезаписывает содержимое файла с заданной заменой.
set Description(description) File Устанавливает описание File .
set Name(name) File Устанавливает имя File .
set Owner(emailAddress) File Изменяет владельца File .
set Owner(user) File Изменяет владельца File .
set Security Update Enabled(enabled) File Определяет, требует ли File ключа ресурса для доступа, когда он распространяется по ссылке.
set Shareable By Editors(shareable) File Определяет, могут ли пользователи с разрешениями на редактирование File делиться файлом с другими пользователями или изменять разрешения.
set Sharing(accessType, permissionType) File Устанавливает, какой класс пользователей может получить доступ File и какие разрешения предоставляются этим пользователям, помимо отдельных пользователей, которым был явно предоставлен доступ.
set Starred(starred) File Определяет, помечается ли File звездочкой на Диске пользователя.
set Trashed(trashed) File Определяет, находится ли File в корзине Диска пользователя.

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

add Commenter(emailAddress)

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

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

add Commenter(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

add Commenters(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));
}

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

File — Этот File для связывания.

Авторизация

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

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

add Editor(emailAddress)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

add Editor(user)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

add Editors(emailAddresses)

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

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

File — Этот File для связывания.

Авторизация

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

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

add Viewer(emailAddress)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

add Viewer(user)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

add Viewers(emailAddresses)

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

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

File — Этот File для связывания.

Авторизация

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

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

get Access(email)

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

Параметры

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

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

Permission — разрешения, предоставленные пользователю.

Авторизация

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

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

get Access(user)

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

Параметры

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

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

Permission — разрешения, предоставленные пользователю.

Авторизация

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

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

get As(contentType)

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

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

Параметры

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

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

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

get Blob()

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

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

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

get Date Created()

Получает дату создания File .

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

Date — дата создания File

Авторизация

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

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

get Description()

Получает описание File .

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

String — описание File

Авторизация

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

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

get Download Url()

Получает URL-адрес, который можно использовать для загрузки файла. Доступ к URL-адресу смогут получить только пользователи, имеющие разрешение на открытие файла на Google Диске. Вы можете использовать этот URL-адрес в браузере для загрузки файла, но его нельзя использовать для получения файла с помощью Url Fetch App . Если вы хотите, чтобы содержимое файла было в сценарии, используйте get Blob() .

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

get Editors()

Получает список редакторов для этого 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

get Id()

Получает идентификатор File .

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

String — идентификатор File

Авторизация

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

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

get Last Updated()

Получает дату последнего обновления File .

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

Date — дата последнего обновления File .

Авторизация

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

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

get Mime Type()

Получает 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

get Name()

Получает имя File .

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

String — имя File

Авторизация

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

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

get Owner()

Получает владельца файла.

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

get Parents()

Получает коллекцию папок, которые являются непосредственными родительскими папками File .

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

Folder Iterator — набор папок, которые являются непосредственными родительскими папками File

Авторизация

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

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

get Resource Key()

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

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

String — ключ ресурса File .

Авторизация

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

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

get Security Update Eligible()

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

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

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

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

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

Авторизация

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

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

get Security Update Enabled()

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

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

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

Boolean — включено ли требование ключа ресурса для этого File .

Авторизация

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

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

get Sharing Access()

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

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

Access — какой класс пользователей может получить доступ к File

Авторизация

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

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

get Sharing Permission()

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

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

Permission — разрешения, предоставленные пользователям, которые могут получить доступ к File

Авторизация

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

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

get Size()

Получает количество байтов, используемых для хранения File на диске. Обратите внимание, что файлы приложений Google Workspace не учитываются при расчете ограничений на объем хранилища на Диске и поэтому возвращают 0 байт.

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

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

Авторизация

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

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

get Target Id()

Если это ярлык, возвращает идентификатор элемента, на который он указывает.

В противном случае он возвращает 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 — идентификатор целевого элемента.

get Target Mime Type()

Если это ярлык, возвращает 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-тип целевого элемента.

get Target Resource Key()

Если файл является ярлыком, возвращает ключ ресурса элемента, на который он указывает. Ключ ресурса — это дополнительный параметр, который необходимо передать для доступа к файлам, к которым предоставлен общий доступ по ссылке.

Если файл не является ярлыком, он возвращает 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

get Thumbnail()

Получает миниатюру для файла или 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

get Url()

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

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

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

Авторизация

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

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

get Viewers()

Получает список читателей и комментаторов этого 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 (const viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

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

User[] — если у пользователя есть права на редактирование этого File , возвращает список зрителей и комментаторов. Если у пользователя нет прав на редактирование, возвращается пустой массив.

Авторизация

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

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

is Shareable By Editors()

Определяет, разрешено ли пользователям с разрешениями на редактирование File делиться с другими пользователями или изменять разрешения.

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

Boolean — true , если пользователям с разрешениями на редактирование разрешено делиться с другими пользователями или изменять разрешения; false если нет

Авторизация

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

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

is Starred()

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

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

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

Авторизация

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

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

is Trashed()

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

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

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

Авторизация

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

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

make Copy()

Создает копию файла. 

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

make Copy(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

make Copy(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

make Copy(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

move To(destination)

Перемещает этот элемент в указанную папку назначения.

Текущий пользователь должен быть владельцем файла или иметь хотя бы доступ к редактированию текущей родительской папки элемента, чтобы переместить элемент в папку назначения.

Параметры

Имя Тип Описание
destination Folder Папка, которая становится новым родителем.

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

File — Этот File для связывания.

Авторизация

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

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

remove Commenter(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');
}

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

remove Commenter(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

remove Editor(emailAddress)

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

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

remove Editor(user)

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

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

remove Viewer(emailAddress)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Viewer(user)

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

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

Параметры

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

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

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

Авторизация

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

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

revoke Permissions(emailAddress)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

revoke Permissions(user)

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

Параметры

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

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

File — Этот File для связывания.

Авторизация

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

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

set Content(content)

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

// Creates a text file with the content 'Hello, world!'
const 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

set Description(description)

Устанавливает описание File .

Параметры

Имя Тип Описание
description String новое описание File

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

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

Авторизация

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

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

set Name(name)

Устанавливает имя File .

Параметры

Имя Тип Описание
name String новое имя File

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

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

Авторизация

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

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

set Owner(emailAddress)

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

Параметры

Имя Тип Описание
email Address String адрес электронной почты пользователя, который должен стать новым владельцем

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

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

Авторизация

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

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

set Owner(user)

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

Параметры

Имя Тип Описание
user User представление пользователя, который должен стать новым владельцем

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

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

Авторизация

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

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

set Security Update Enabled(enabled)

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

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

Параметры

Имя Тип Описание
enabled Boolean Включить ли требование ключа ресурса для File .

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

File — Этот File для связывания.

Авторизация

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

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

set Shareable By Editors(shareable)

Определяет, могут ли пользователи с разрешениями на редактирование File делиться файлом с другими пользователями или изменять разрешения. По умолчанию для нового File установлено true .

Параметры

Имя Тип Описание
shareable Boolean true , если пользователям с разрешениями на редактирование должно быть разрешено делиться с другими пользователями или изменять разрешения; false если нет

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

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

Авторизация

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

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

set Sharing(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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Параметры

Имя Тип Описание
access Type Access какой класс пользователей должен иметь доступ к File
permission Type Permission разрешения, которые должны быть предоставлены пользователям, имеющим доступ к File

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

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

Авторизация

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

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

set Starred(starred)

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

Параметры

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

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

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

Авторизация

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

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

set Trashed(trashed)

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

Параметры

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

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

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

Авторизация

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

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