Class Folder

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

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

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var 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(user) 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 в корзине на Диске пользователя.

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

addEditor(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

addEditor(user)

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

Параметры

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

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

Параметры

Имя Тип Описание
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 объекта произвольных данных.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(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)

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

Параметры

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

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

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

Авторизация

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

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

getAccess(email)

Получает разрешение, предоставленное данному пользователю.

Параметры

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

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

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

Авторизация

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

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

getAccess(user)

Получает разрешение, предоставленное данному пользователю.

Параметры

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

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

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

Авторизация

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

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

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 , этот метод возвращает пустой массив.

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

User[] — Массив пользователей с правами редактирования.

Авторизация

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

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

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

User — объект User , представляющий владельца

Авторизация

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

  • 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 , этот метод возвращает пустой массив.

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

User[] — Массив пользователей с правами просмотра или комментирования.

Авторизация

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

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

isShareableByEditors()

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

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

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

Авторизация

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

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

isStarred()

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

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

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

Авторизация

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

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

isTrashed()

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

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

Booleantrue , если 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)

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

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

Параметры

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

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

Параметры

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

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

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

Авторизация

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

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

revokePermissions(user)

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

Параметры

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

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

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

Авторизация

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

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

searchFiles(params)

Получает коллекцию всех файлов, которые являются дочерними элементами текущей папки и соответствуют заданным критериям поиска. Критерии поиска подробно описаны в документации Google Drive SDK . Обратите внимание, что аргумент params представляет собой строку запроса, которая может содержать строковые значения, поэтому позаботьтесь о правильном выходе из кавычек (например "title contains 'Gulliver\\'s Travels'" или 'title contains "Gulliver\'s Travels"' ).

// Log the name of every file that are children of the current folder and modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.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 . Обратите внимание, что аргумент params представляет собой строку запроса, которая может содержать строковые значения, поэтому позаботьтесь о правильном выходе из кавычек (например "title contains 'Gulliver\\'s Travels'" или 'title contains "Gulliver\'s Travels"' ).

// Log the name of every folder that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.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)

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

Параметры

Имя Тип Описание
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.)
var 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 s установлено значение false .

Параметры

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

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

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

Авторизация

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

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

setTrashed(trashed)

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

Параметры

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

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

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

Авторизация

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

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

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