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 Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Blob() 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 Получает миниатюрное изображение для файла или null , если миниатюра отсутствует.
get Url() String Получает URL-адрес, который можно использовать для открытия File в приложении Google, таком как Google Диск или 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)

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

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

Параметры

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

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

Blob — Данные в виде двоичных данных (blob).


get Blob()

Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).

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

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

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

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

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

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

Авторизация

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

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

get Security Update Enabled()

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

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

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

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

Авторизация

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

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

get Url()

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

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

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

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

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

Авторизация

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

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

is Starred()

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

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

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

Авторизация

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

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

is Trashed()

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

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

Booleantrue если 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 находится на общем диске, к которому пользователь имеет доступ.

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

Параметры

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

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

File — Этот File , для создания цепочек вызовов.

Авторизация

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

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

remove Editor(user)

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

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

Параметры

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

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

File — Этот File , для создания цепочек вызовов.

Авторизация

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

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

remove Viewer(emailAddress)

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

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

Параметры

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

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

File — Этот File используется для создания цепочек вызовов.

Авторизация

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

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

remove Viewer(user)

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

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

Параметры

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

Параметры

Имя Тип Описание
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 из корзины. Значение по умолчанию для новых Filefalse .

Параметры

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

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

File — этот File для создания цепочек вызовов

Авторизация

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

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