Эта страница переведена с помощью Cloud Translation API.

Class Folder

Папка в Google Диске. Доступ к папкам или их создание возможны через DriveApp .

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

Методы

Метод	Тип возвращаемого значения	Краткое описание
`add Editor(emailAddress)`	`Folder`	Добавляет указанного пользователя в список редакторов `Folder` .
`add Editor(user)`	`Folder`	Добавляет указанного пользователя в список редакторов `Folder` .
`add Editors(emailAddresses)`	`Folder`	Добавляет указанный массив пользователей в список редакторов для `Folder` .
`add Viewer(emailAddress)`	`Folder`	Добавляет указанного пользователя в список пользователей, просматривающих `Folder` .
`add Viewer(user)`	`Folder`	Добавляет указанного пользователя в список пользователей, просматривающих `Folder` .
`add Viewers(emailAddresses)`	`Folder`	Добавляет указанный массив пользователей в список пользователей, просматривающих `Folder` .
`create File(blob)`	`File`	Создает файл в текущей папке из заданного `Blob` с произвольными данными.
`create File(name, content)`	`File`	Создает текстовый файл в текущей папке с заданным именем и содержимым.
`create File(name, content, mimeType)`	`File`	Создает файл в текущей папке с заданным именем, содержимым и MIME-типом.
`create Folder(name)`	`Folder`	Создает папку в текущей папке с заданным именем.
`create Shortcut(targetId)`	`File`	Создает ярлык для указанного идентификатора элемента Google Диска и возвращает его.
`create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)`	`File`	Создает ярлык для указанного идентификатора элемента Google Диска и ключа ресурса и возвращает его.
`get Access(email)`	`Permission`	Получает разрешение, предоставленное конкретному пользователю.
`get Access(user)`	`Permission`	Получает разрешение, предоставленное конкретному пользователю.
`get Date Created()`	`Date`	Получает дату создания `Folder` .
`get Description()`	`String`	Получает описание `Folder` .
`get Editors()`	`User[]`	Получает список редакторов для этой `Folder` .
`get Files()`	`File Iterator`	Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке.
`get Files By Name(name)`	`File Iterator`	Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке и имеющих заданное имя.
`get Files By Type(mimeType)`	`File Iterator`	Получает коллекцию всех файлов, являющихся дочерними файлами текущей папки и имеющих заданный MIME-тип.
`get Folders()`	`Folder Iterator`	Получает коллекцию всех папок, являющихся дочерними по отношению к текущей папке.
`get Folders By Name(name)`	`Folder Iterator`	Получает коллекцию всех папок, являющихся дочерними по отношению к текущей папке и имеющих заданное имя.
`get Id()`	`String`	Получает идентификатор `Folder` .
`get Last Updated()`	`Date`	Получает дату последнего обновления `Folder` .
`get Name()`	`String`	Получает имя `Folder` .
`get Owner()`	`User`	Получает владельца этой `Folder` .
`get Parents()`	`Folder Iterator`	Получает набор папок, являющихся непосредственными родительскими папками для данной `Folder` .
`get Resource Key()`	`String`	Получает ключ ресурса `Folder` , необходимый для доступа к элементам, предоставленным в общий доступ по ссылке.
`get Security Update Eligible()`	`Boolean`	Выводит информацию о том, подходит ли данная `Folder` для применения обновления безопасности, для доступа к которому требуется ключ ресурса при предоставлении доступа по ссылке.
`get Security Update Enabled()`	`Boolean`	Выводит информацию о том, требуется ли для доступа к этой `Folder` ключ ресурса при ее совместном использовании по ссылке.
`get Sharing Access()`	`Access`	Определяет, какой класс пользователей может получить доступ к `Folder` , помимо отдельных пользователей, которым был явно предоставлен доступ.
`get Sharing Permission()`	`Permission`	Получает разрешения, предоставленные тем пользователям, которые могут получить доступ к `Folder` , помимо тех отдельных пользователей, которым был явно предоставлен доступ.
`get Size()`	`Integer`	Получает количество байтов, используемых для хранения `Folder` на Диске.
`get Url()`	`String`	Получает URL-адрес, который можно использовать для открытия `Folder` в приложении Google, таком как Google Диск или Документы.
`get Viewers()`	`User[]`	Получает список пользователей, просматривающих и комментирующих эту `Folder` .
`is Shareable By Editors()`	`Boolean`	Определяет, разрешено ли пользователям с правами редактирования `Folder` предоставлять доступ другим пользователям или изменять права доступа.
`is Starred()`	`Boolean`	Определяет, отмечена ли `Folder` звездочкой на Диске пользователя.
`is Trashed()`	`Boolean`	Определяет, находится ли `Folder` в корзине на Диске пользователя.
`move To(destination)`	`Folder`	Перемещает этот элемент в указанную папку назначения.
`remove Editor(emailAddress)`	`Folder`	Удаляет указанного пользователя из списка редакторов `Folder` .
`remove Editor(user)`	`Folder`	Удаляет указанного пользователя из списка редакторов `Folder` .
`remove Viewer(emailAddress)`	`Folder`	Удаляет указанного пользователя из списка пользователей, просматривающих и комментирующих `Folder` .
`remove Viewer(user)`	`Folder`	Удаляет указанного пользователя из списка пользователей, просматривающих и комментирующих `Folder` .
`revoke Permissions(emailAddress)`	`Folder`	Отменяет предоставленный данному пользователю доступ к `Folder` .
`revoke Permissions(user)`	`Folder`	Отменяет предоставленный данному пользователю доступ к `Folder` .
`search Files(params)`	`File Iterator`	Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке и соответствующих заданным критериям поиска.
`search Folders(params)`	`Folder Iterator`	Получает коллекцию всех папок, являющихся дочерними по отношению к текущей папке и соответствующих заданным критериям поиска.
`set Description(description)`	`Folder`	Задает описание для `Folder` .
`set Name(name)`	`Folder`	Задает имя `Folder` .
`set Owner(emailAddress)`	`Folder`	Изменяет владельца `Folder` .
`set Owner(user)`	`Folder`	Изменяет владельца `Folder` .
`set Security Update Enabled(enabled)`	`Folder`	Определяет, требуется ли для доступа `Folder` ключ ресурса при её совместном использовании по ссылке.
`set Shareable By Editors(shareable)`	`Folder`	Определяет, разрешено ли пользователям с правами редактирования `Folder` предоставлять доступ другим пользователям или изменять права доступа.
`set Sharing(accessType, permissionType)`	`Folder`	Определяет, какой класс пользователей может получить доступ `Folder` и какие разрешения предоставляются этим пользователям, помимо отдельных пользователей, которым был явно предоставлен доступ.
`set Starred(starred)`	`Folder`	Определяет, будет ли `Folder` отмечена звездочкой на Диске пользователя.
`set Trashed(trashed)`	`Folder`	Определяет, будет ли `Folder` находиться в корзине на Диске пользователя.

Устаревшие методы

Метод	Тип возвращаемого значения	Краткое описание
`add File(child)`	`Folder`	Добавляет указанный файл в текущую папку.
`add Folder(child)`	`Folder`	Добавляет указанную папку в текущую папку.
`remove File(child)`	`Folder`	Удаляет указанный файл из текущей папки.
`remove Folder(child)`	`Folder`	Удаляет указанную папку из текущей папки.

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

`addEditor(emailAddress)`

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

Параметры

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

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

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

Авторизация

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

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

`addEditor(user)`

Параметры

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

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

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

Авторизация

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

`addEditors(emailAddresses)`

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

Параметры

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

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

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

Авторизация

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

`addViewer(emailAddress)`

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

Параметры

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

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

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

Авторизация

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

`addViewer(user)`

Параметры

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

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

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

Авторизация

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

`addViewers(emailAddresses)`

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

Параметры

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

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

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

Авторизация

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

`createFile(blob)`

Создает файл в текущей папке из заданного Blob с произвольными данными.

Параметры

Имя	Тип	Описание
`blob`	`Blob Source`	Данные для нового файла.

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

File — Новый файл.

Авторизация

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

`createFile(name, content)`

Создает текстовый файл в текущей папке с заданным именем и содержимым. Генерирует исключение, если content превышает 50 МБ.

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

Параметры

Имя	Тип	Описание
`name`	`String`	Название нового файла.
`content`	`String`	Содержимое нового файла.

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

File — Новый файл.

Авторизация

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

`createFile(name, content, mimeType)`

Создает файл в текущей папке с заданным именем, содержимым и MIME-типом. Генерирует исключение, если content превышает 10 МБ.

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Параметры

Имя	Тип	Описание
`name`	`String`	Название нового файла.
`content`	`String`	Содержимое нового файла.
`mime Type`	`String`	MIME-тип нового файла.

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

File — Новый файл.

Авторизация

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

`createFolder(name)`

Создает папку в текущей папке с заданным именем.

Параметры

Имя	Тип	Описание
`name`	`String`	Название новой папки.

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

Folder — Новая папка.

Авторизация

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

`createShortcut(targetId)`

Создает ярлык для указанного идентификатора элемента Google Диска и возвращает его.

Параметры

Имя	Тип	Описание
`target Id`	`String`	Идентификатор целевого файла или папки.

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

File — новая комбинация клавиш.

Авторизация

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

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

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

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

Параметры

Имя	Тип	Описание
`target Id`	`String`	Идентификатор целевого файла или папки.
`target Resource Key`	`String`	Ключ ресурса целевого файла или папки.

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

File — новая комбинация клавиш.

Авторизация

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

`getAccess(email)`

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

Параметры

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

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

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

Авторизация

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

`getAccess(user)`

Параметры

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

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

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

Авторизация

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

`getDateCreated()`

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

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

Date — дата создания Folder .

Авторизация

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

`getDescription()`

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

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

String — описание Folder

Авторизация

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

`getEditors()`

Получает список редакторов для этой Folder . Если у пользователя, выполняющего скрипт, нет прав на редактирование Folder , этот метод возвращает пустой массив.

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

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

User[] — Список редакторов для этой Folder , если у пользователя есть права на редактирование, или пустой массив в противном случае.

Авторизация

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

`getFiles()`

Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке.

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

FileIterator — Коллекция всех файлов, являющихся дочерними файлами текущей папки.

Авторизация

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

`getFilesByName(name)`

Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке и имеющих заданное имя.

Параметры

Имя	Тип	Описание
`name`	`String`	Названия файлов, которые нужно найти.

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

FileIterator — Коллекция всех файлов, являющихся дочерними файлами текущей папки и имеющих заданное имя.

Авторизация

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

`getFilesByType(mimeType)`

Получает коллекцию всех файлов, являющихся дочерними файлами текущей папки и имеющих заданный MIME-тип.

Параметры

Имя	Тип	Описание
`mime Type`	`String`	MIME-тип файлов для поиска.

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

FileIterator — Коллекция всех файлов, являющихся дочерними по отношению к текущей папке и имеющих заданный MIME-тип.

Авторизация

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

`getFolders()`

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

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

FolderIterator — Коллекция всех папок, являющихся дочерними по отношению к текущей папке.

Авторизация

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

`getFoldersByName(name)`

Получает коллекцию всех папок, являющихся дочерними по отношению к текущей папке и имеющих заданное имя.

Параметры

Имя	Тип	Описание
`name`	`String`	Названия папок, которые нужно найти.

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

FolderIterator — Коллекция всех папок, являющихся дочерними по отношению к текущей папке и имеющих заданное имя.

Авторизация

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

`getId()`

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

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

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

Авторизация

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

`getLastUpdated()`

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

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

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

Авторизация

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

`getName()`

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

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

String — имя Folder

Авторизация

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

`getOwner()`

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

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

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

User — владелец этой Folder .

Авторизация

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

`getParents()`

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

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

FolderIterator — набор папок, являющихся непосредственными родительскими папками для данной Folder

Авторизация

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

`getResourceKey()`

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

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

String — Ключ ресурса Folder .

Авторизация

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

`getSecurityUpdateEligible()`

Выводит информацию о том, подходит ли данная Folder для применения обновления безопасности, для доступа к которому требуется ключ ресурса при предоставлении доступа по ссылке.

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

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

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

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

Авторизация

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

`getSecurityUpdateEnabled()`

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

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

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

Boolean — Указывает, включено ли требование наличия ключа ресурса для этой Folder .

Авторизация

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

`getSharingAccess()`

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

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

Access — к какой категории пользователей разрешен доступ к Folder

Авторизация

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

`getSharingPermission()`

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

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

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

Авторизация

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

`getSize()`

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

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

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

Авторизация

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

`getUrl()`

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

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

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

Авторизация

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

`getViewers()`

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

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

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

User[] — Список пользователей, просматривающих и комментирующих эту Folder , если у пользователя есть доступ на редактирование, или пустой массив в противном случае.

Авторизация

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

`isShareableByEditors()`

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

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

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

Авторизация

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

`isStarred()`

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

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

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

Авторизация

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

`isTrashed()`

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

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

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

Авторизация

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

`moveTo(destination)`

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

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

Параметры

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

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

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

Авторизация

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

`removeEditor(emailAddress)`

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

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

Параметры

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

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

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

Авторизация

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

`removeEditor(user)`

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

Параметры

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

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

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

Авторизация

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

`removeViewer(emailAddress)`

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

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

Параметры

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

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

Folder — Эта Folder используется для создания цепочек сообщений.

Авторизация

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

`removeViewer(user)`

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

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

Параметры

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

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

Folder — Эта Folder используется для создания цепочек сообщений.

Авторизация

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

`revokePermissions(emailAddress)`

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

Параметры

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

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

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

Авторизация

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

`revokePermissions(user)`

Параметры

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

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

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

Авторизация

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

`searchFiles(params)`

Получает коллекцию всех файлов, являющихся дочерними по отношению к текущей папке и соответствующих заданным критериям поиска. Критерии поиска подробно описаны в документации Google Drive SDK . Обратите внимание, что сервис Drive использует версию 2 API Drive, и некоторые поля запроса отличаются от версии 3. Ознакомьтесь с различиями в полях между версиями 2 и 3 .

Аргумент params представляет собой строку запроса, которая может содержать строковые значения, поэтому будьте внимательны при экранировании кавычек (например, "title contains 'Gulliver\\'s Travels'" или 'title contains "Gulliver\'s Travels"' ).

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Параметры

Имя	Тип	Описание
`params`	`String`	Критерии поиска подробно описаны в документации Google Drive SDK .

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

FileIterator — Коллекция всех файлов, являющихся дочерними по отношению к текущей папке и соответствующих критериям поиска.

Авторизация

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

`searchFolders(params)`

Получает коллекцию всех папок, являющихся дочерними по отношению к текущей папке и соответствующих заданным критериям поиска. Критерии поиска подробно описаны в документации Google Drive SDK . Обратите внимание, что сервис Drive использует версию 2 API Drive, и некоторые поля запроса отличаются от версии 3. Ознакомьтесь с различиями в полях между версиями 2 и 3 .

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Параметры

Имя	Тип	Описание
`params`	`String`	Критерии поиска подробно описаны в документации Google Drive SDK .

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

FolderIterator — Коллекция всех папок, являющихся дочерними по отношению к текущей папке и соответствующих критериям поиска.

Авторизация

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

`setDescription(description)`

Задает описание для Folder .

Параметры

Имя	Тип	Описание
`description`	`String`	новое описание для `Folder`

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

Folder — эта Folder для создания цепочек сообщений.

Авторизация

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

`setName(name)`

Задает имя Folder .

Параметры

Имя	Тип	Описание
`name`	`String`	новое название `Folder`

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

Folder — эта Folder для создания цепочек сообщений.

Авторизация

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

`setOwner(emailAddress)`

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

Google Диск не поддерживает изменение прав доступа к элементам, принадлежащим учетным записям gmail.com; эта функция поддерживается для учетных записей Workspace.

Параметры

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

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

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

Авторизация

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

`setOwner(user)`

Параметры

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

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

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

Авторизация

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

`setSecurityUpdateEnabled(enabled)`

Определяет, требуется ли для доступа Folder ключ ресурса при её совместном использовании по ссылке. По умолчанию доступны соответствующие файлы и папки.

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

Параметры

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

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

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

Авторизация

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

`setShareableByEditors(shareable)`

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

Параметры

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

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

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

Авторизация

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

`setSharing(accessType, permissionType)`

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

// 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`	Какая категория пользователей должна иметь доступ к `Folder`
`permission Type`	`Permission`	права доступа, которые должны быть предоставлены пользователям, имеющим доступ к `Folder`

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

Folder — эта Folder для создания цепочек сообщений.

Авторизация

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

`setStarred(starred)`

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

Параметры

Имя	Тип	Описание
`starred`	`Boolean`	`true` указывает, следует ли пометить `Folder` звездочкой на Диске пользователя; `false` — нет.

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

Folder — эта Folder для создания цепочек сообщений.

Авторизация

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

`setTrashed(trashed)`

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

Параметры

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

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

Folder — эта Folder для создания цепочек сообщений.

Авторизация

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

Устаревшие методы

`addFile(child)`

Устарело. Вместо этого используйте File.moveTo(destination) или createShortcut(targetId) .

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

Параметры

Имя	Тип	Описание
`child`	`File`	Дочерний файл для добавления.

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

Folder — новый родительский файл, добавленный в качестве дочернего.

Авторизация

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

`addFolder(child)`

Устарело. Вместо этого используйте moveTo(destination) или createShortcut(targetId) .

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

Параметры

Имя	Тип	Описание
`child`	`Folder`	Дочерняя папка для добавления.

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

Folder — новый родительский элемент папки, добавленной в качестве дочернего элемента.

Авторизация

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

`removeFile(child)`

Устарело. Вместо этого используйте File.moveTo(destination) .

Удаляет указанный файл из текущей папки. Этот метод не удаляет сам файл, но если файл удален из всех родительских папок, его нельзя будет увидеть в Google Диска, кроме как с помощью поиска или просмотра «Все элементы».

Параметры

Имя	Тип	Описание
`child`	`File`	Дочерний файл, который нужно удалить.

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

Folder — Предыдущий родитель ребенка.

Авторизация

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

`removeFolder(child)`

Устарело. Вместо этого используйте moveTo(destination) .

Удаляет указанную папку из текущей папки. Этот метод не удаляет папку или её содержимое, но если папка удалена из всех своих родительских папок, её нельзя будет увидеть в Google Диска, кроме как с помощью поиска или просмотра «Все элементы».

Параметры

Имя	Тип	Описание
`child`	`Folder`	Дочерняя папка, которую нужно удалить.

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

Folder — Предыдущий родитель ребенка.

Авторизация

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

Class Folder Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Методы

Устаревшие методы

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

addEditor(emailAddress)

Параметры

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

Авторизация

addEditor(user)

Параметры

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

Авторизация

addEditors(emailAddresses)

Параметры

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

Авторизация

addViewer(emailAddress)

Параметры

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

Авторизация

addViewer(user)

Параметры

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

Авторизация

addViewers(emailAddresses)

Параметры

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

Авторизация

createFile(blob)

Параметры

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

Авторизация

createFile(name, content)

Параметры

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

Авторизация

createFile(name, content, mimeType)

Параметры

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

Авторизация

createFolder(name)

Параметры

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

Авторизация

createShortcut(targetId)

Параметры

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

Авторизация

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Параметры

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

Авторизация

getAccess(email)

Параметры

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

Авторизация

getAccess(user)

Параметры

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

Авторизация

getDateCreated()

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

Авторизация

getDescription()

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

Авторизация

getEditors()

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

Авторизация

getFiles()

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

Авторизация

getFilesByName(name)

Параметры

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

Авторизация

getFilesByType(mimeType)

Параметры

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

Авторизация

Class Folder

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`createFile(blob)`

`createFile(name, content)`

`createFile(name, content, mimeType)`

`createFolder(name)`

`createShortcut(targetId)`

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

`getAccess(email)`

`getAccess(user)`

`getDateCreated()`

`getDescription()`

`getEditors()`

`getFiles()`

`getFilesByName(name)`

`getFilesByType(mimeType)`

`getFolders()`

`getFoldersByName(name)`

`getId()`

`getLastUpdated()`

`getName()`

`getOwner()`

`getParents()`

`getResourceKey()`

`getSecurityUpdateEligible()`

`getSecurityUpdateEnabled()`

`getSharingAccess()`

`getSharingPermission()`

`getSize()`

`getUrl()`

`getViewers()`

`isShareableByEditors()`

`isStarred()`

`isTrashed()`

`moveTo(destination)`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`