Class Folder

Папка

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

// 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 Создает ярлык для предоставленного идентификатора элемента Диска и возвращает его.
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey) File Создает ярлык для предоставленного идентификатора элемента Диска и ключа ресурса и возвращает его.
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, например на Диске или Документах.
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 Editor(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

add Editor(user)

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

Параметры

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

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

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

Авторизация

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

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

add Editors(emailAddresses)

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

Параметры

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

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

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

Авторизация

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

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

add Viewer(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

add Viewer(user)

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

Параметры

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

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

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

Авторизация

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

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

add Viewers(emailAddresses)

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

Параметры

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

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

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

Авторизация

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

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

create File(blob)

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

Параметры

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

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

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

Авторизация

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

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

create File(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

create File(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

create Folder(name)

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

Параметры

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

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

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

Авторизация

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

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

create Shortcut(targetId)

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

Параметры

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

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

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

Авторизация

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

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

create Shortcut For Target Id And Resource Key(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(),
  );
}

Параметры

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

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

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

Авторизация

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

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

get Access(email)

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

Параметры

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

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

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

Авторизация

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

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

get Access(user)

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

Параметры

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

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

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

Авторизация

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

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

get Date Created()

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

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

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

Авторизация

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

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

get Description()

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

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

String — описание Folder

Авторизация

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

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

get Editors()

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

get Files()

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

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

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

Авторизация

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

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

get Files By Name(name)

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

Параметры

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

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

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

Авторизация

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

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

get Files By Type(mimeType)

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

Параметры

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

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

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

Авторизация

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

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

get Folders()

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

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

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

Авторизация

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

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

get Folders By Name(name)

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

Параметры

Имя Тип Описание
name String Имя папок, которые необходимо найти.

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

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

Авторизация

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

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

get Id()

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

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

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

Авторизация

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

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

get Last Updated()

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

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

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

Авторизация

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

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

get Name()

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

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

String — имя Folder

Авторизация

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

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

get Owner()

Получает владельца этой 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

get Parents()

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

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

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

Авторизация

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

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

get Resource Key()

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

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

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

Авторизация

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

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

get Security Update Eligible()

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

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

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

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

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

Авторизация

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

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

get Security Update Enabled()

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

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

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

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

Авторизация

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

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

get Sharing Access()

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

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

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

Авторизация

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

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

get Sharing Permission()

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

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

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

Авторизация

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

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

get Size()

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

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

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

Авторизация

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

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

get Url()

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

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

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

Авторизация

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

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

get Viewers()

Получает список читателей и комментаторов этой 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

is Shareable By Editors()

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

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

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

Авторизация

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

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

is Starred()

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

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

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

Авторизация

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

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

is Trashed()

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

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

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

Авторизация

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

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

move To(destination)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Editor(emailAddress)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Editor(user)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Viewer(emailAddress)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Viewer(user)

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

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

Параметры

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

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

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

Авторизация

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

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

revoke Permissions(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

revoke Permissions(user)

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

Параметры

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

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

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

Авторизация

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

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

search Files(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 .

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

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

Авторизация

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

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

search Folders(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 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 .

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

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

Авторизация

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

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

set Description(description)

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

Параметры

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

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

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

Авторизация

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

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

set Name(name)

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

Параметры

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

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

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

Авторизация

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

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

set Owner(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

set Owner(user)

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

Параметры

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

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

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

Авторизация

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

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

set Security Update Enabled(enabled)

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

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

Параметры

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

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

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

Авторизация

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

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

set Shareable By Editors(shareable)

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

Параметры

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

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

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

Авторизация

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

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

set Sharing(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

set Starred(starred)

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

Параметры

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

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

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

Авторизация

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

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

set Trashed(trashed)

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

Параметры

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

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

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

Авторизация

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

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

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