Эта страница переведена с помощью 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());
}

Методы

Метод	Тип возврата	Краткое описание
`addEditor(emailAddress)`	`Folder`	Добавляет данного пользователя в список редакторов `Folder` .
`addEditor(user)`	`Folder`	Добавляет данного пользователя в список редакторов `Folder` .
`addEditors(emailAddresses)`	`Folder`	Добавляет заданный массив пользователей в список редакторов `Folder` .
`addViewer(emailAddress)`	`Folder`	Добавляет данного пользователя в список зрителей `Folder` .
`addViewer(user)`	`Folder`	Добавляет данного пользователя в список зрителей `Folder` .
`addViewers(emailAddresses)`	`Folder`	Добавляет заданный массив пользователей в список зрителей `Folder` .
`createFile(blob)`	`File`	Создает файл в текущей папке из заданного `Blob` произвольных данных.
`createFile(name, content)`	`File`	Создает текстовый файл в текущей папке с заданным именем и содержимым.
`createFile(name, content, mimeType)`	`File`	Создает файл в текущей папке с заданным именем, содержимым и типом MIME.
`createFolder(name)`	`Folder`	Создает папку в текущей папке с заданным именем.
`createShortcut(targetId)`	`File`	Создает ярлык для предоставленного идентификатора элемента Диска и возвращает его.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Создает ярлык для предоставленного идентификатора элемента Диска и ключа ресурса и возвращает его.
`getAccess(email)`	`Permission`	Получает разрешение, предоставленное конкретному пользователю.
`getAccess(user)`	`Permission`	Получает разрешение, предоставленное конкретному пользователю.
`getDateCreated()`	`Date`	Получает дату создания `Folder` .
`getDescription()`	`String`	Получает описание `Folder` .
`getEditors()`	`User[]`	Получает список редакторов для этой `Folder` .
`getFiles()`	`FileIterator`	Получает коллекцию всех файлов, которые являются дочерними элементами текущей папки.
`getFilesByName(name)`	`FileIterator`	Получает коллекцию всех файлов, которые являются дочерними по отношению к текущей папке и имеют заданное имя.
`getFilesByType(mimeType)`	`FileIterator`	Получает коллекцию всех файлов, которые являются дочерними по отношению к текущей папке и имеют заданный тип MIME.
`getFolders()`	`FolderIterator`	Получает коллекцию всех папок, которые являются дочерними по отношению к текущей папке.
`getFoldersByName(name)`	`FolderIterator`	Получает коллекцию всех папок, которые являются дочерними по отношению к текущей папке и имеют заданное имя.
`getId()`	`String`	Получает идентификатор `Folder` .
`getLastUpdated()`	`Date`	Получает дату последнего обновления `Folder` .
`getName()`	`String`	Получает имя `Folder` .
`getOwner()`	`User`	Получает владельца этой `Folder` .
`getParents()`	`FolderIterator`	Получает коллекцию папок, которые являются непосредственными родительскими папками `Folder` .
`getResourceKey()`	`String`	Получает ключ ресурса `Folder` , необходимый для доступа к элементам, к которым предоставлен общий доступ по ссылке.
`getSecurityUpdateEligible()`	`Boolean`	Определяет, имеет ли эта `Folder` право на применение обновления безопасности, для доступа к которому требуется ключ ресурса, когда к ней предоставляется общий доступ по ссылке.
`getSecurityUpdateEnabled()`	`Boolean`	Определяет, требуется ли для этой `Folder` ключ ресурса для доступа, когда к ней предоставляется общий доступ по ссылке.
`getSharingAccess()`	`Access`	Получает класс пользователей, которые могут получить доступ к `Folder` , помимо отдельных пользователей, которым явно предоставлен доступ.
`getSharingPermission()`	`Permission`	Получает разрешение, предоставленное тем пользователям, которые могут получить доступ к `Folder` , помимо отдельных пользователей, которым явно предоставлен доступ.
`getSize()`	`Integer`	Получает количество байтов, используемых для хранения `Folder` на Диске.
`getUrl()`	`String`	Получает URL-адрес, который можно использовать для открытия `Folder` в приложении Google, например на Диске или Документах.
`getViewers()`	`User[]`	Получает список читателей и комментаторов этой `Folder` .
`isShareableByEditors()`	`Boolean`	Определяет, разрешено ли пользователям с разрешениями на редактирование `Folder` делиться ею с другими пользователями или изменять разрешения.
`isStarred()`	`Boolean`	Определяет, помечена ли `Folder` на Диске пользователя.
`isTrashed()`	`Boolean`	Определяет, находится ли `Folder` в корзине Диска пользователя.
`moveTo(destination)`	`Folder`	Перемещает этот элемент в указанную папку назначения.
`removeEditor(emailAddress)`	`Folder`	Удаляет данного пользователя из списка редакторов `Folder` .
`removeEditor(user)`	`Folder`	Удаляет данного пользователя из списка редакторов `Folder` .
`removeViewer(emailAddress)`	`Folder`	Удаляет данного пользователя из списка читателей и комментаторов `Folder` .
`removeViewer(user)`	`Folder`	Удаляет данного пользователя из списка читателей и комментаторов `Folder` .
`revokePermissions(emailAddress)`	`Folder`	Отменяет доступ к `Folder` предоставленный данному пользователю.
`revokePermissions(user)`	`Folder`	Отменяет доступ к `Folder` предоставленный данному пользователю.
`searchFiles(params)`	`FileIterator`	Получает коллекцию всех файлов, которые являются дочерними элементами текущей папки и соответствуют заданным критериям поиска.
`searchFolders(params)`	`FolderIterator`	Получает коллекцию всех папок, которые являются дочерними по отношению к текущей папке и соответствуют заданным критериям поиска.
`setDescription(description)`	`Folder`	Устанавливает описание `Folder` .
`setName(name)`	`Folder`	Устанавливает имя `Folder` .
`setOwner(emailAddress)`	`Folder`	Изменяет владельца `Folder` .
`setOwner(user)`	`Folder`	Изменяет владельца `Folder` .
`setSecurityUpdateEnabled(enabled)`	`Folder`	Определяет, требует ли `Folder` ключ ресурса для доступа при совместном использовании по ссылке.
`setShareableByEditors(shareable)`	`Folder`	Определяет, разрешено ли пользователям с разрешениями на редактирование `Folder` делиться ею с другими пользователями или изменять разрешения.
`setSharing(accessType, permissionType)`	`Folder`	Устанавливает, какой класс пользователей может получить доступ `Folder` и какие разрешения предоставляются этим пользователям, помимо отдельных пользователей, которым был явно предоставлен доступ.
`setStarred(starred)`	`Folder`	Определяет, помечена ли `Folder` на Диске пользователя.
`setTrashed(trashed)`	`Folder`	Определяет, находится ли `Folder` в корзине Диска пользователя.

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

Метод	Тип возврата	Краткое описание
`addFile(child)`	`Folder`	Добавляет указанный файл в текущую папку.
`addFolder(child)`	`Folder`	Добавляет указанную папку в текущую папку.
`removeFile(child)`	`Folder`	Удаляет указанный файл из текущей папки.
`removeFolder(child)`	`Folder`	Удаляет данную папку из текущей папки.

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

`addEditor(emailAddress)`

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`addEditor(user)`

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`addEditors(emailAddresses)`

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`addViewer(emailAddress)`

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`addViewer(user)`

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`addViewers(emailAddresses)`

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`createFile(blob)`

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

Параметры

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

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

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`	Содержимое нового файла.
`mimeType`	`String`	MIME-тип нового файла.

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

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

Авторизация

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

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

`createFolder(name)`

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

Параметры

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

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

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

Авторизация

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

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

`createShortcut(targetId)`

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

Параметры

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

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

File — новый ярлык.

Авторизация

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

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

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

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

// 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(),
  );
}

Параметры

Имя	Тип	Описание
`targetId`	`String`	Идентификатор целевого файла или папки.
`targetResourceKey`	`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.

Параметры

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

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

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

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

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

Авторизация

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

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

`getSecurityUpdateEnabled()`

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

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

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

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

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

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

Авторизация

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

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

`getUrl()`

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

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

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

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`removeEditor(user)`

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

Параметры

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

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

Folder — эта Folder для связывания.

Авторизация

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

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

`removeViewer(emailAddress)`

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

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

Параметры

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

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

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

Авторизация

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

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

`removeViewer(user)`

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

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

Параметры

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

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

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

Авторизация

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

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

`revokePermissions(emailAddress)`

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

Параметры

Имя	Тип	Описание
`emailAddress`	`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 Drive API, а некоторые поля запросов отличаются от версии 3. Просмотрите различия в полях между v2 и v3 .

Аргумент 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 Drive API, а некоторые поля запросов отличаются от версии 3. Просмотрите различия в полях между v2 и v3 .

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

Параметры

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

Параметры

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

Параметры

Имя	Тип	Описание
`accessType`	`Access`	какой класс пользователей должен иметь доступ к `Folder`
`permissionType`	`Permission`	разрешения, которые должны быть предоставлены пользователям, имеющим доступ к `Folder`

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

Folder — эта Folder , для связывания

Авторизация

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

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

`setStarred(starred)`

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

Параметры

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

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

Folder — эта Folder , для связывания

Авторизация

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

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

`setTrashed(trashed)`

Определяет, находится ли Folder в корзине Диска пользователя. Только владелец может удалить Folder . По умолчанию для new 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) .

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

Параметры

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

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

Folder — предыдущий родитель дочернего элемента.

Авторизация

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

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

`removeFolder(child)`

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

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

Параметры

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

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

Folder — предыдущий родитель дочернего элемента.

Авторизация

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

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