Drive Service

Водить машину

Этот сервис позволяет сценариям создавать, находить и изменять файлы и папки на Google Диске. Хотя встроенный сервис Drive проще в использовании, он имеет некоторые ограничения. Чтобы получить доступ к самым современным функциям и поддержке, а также получить доступ к файлам и папкам на общих дисках, используйте расширенный сервис Диска .

Если ваш скрипт использует стандартный облачный проект вместо облачного проекта по умолчанию, вам необходимо вручную включить Drive API. В своем стандартном облачном проекте включите Drive API:

Включите API Диска

В следующем примере кода показано, как регистрировать имена каждого файла в папке «Мой диск» пользователя: 
// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Классы

Имя Краткое описание
Access Перечисление, представляющее классы пользователей, которые могут получить доступ к файлу или папке, помимо отдельных пользователей, которым был явно предоставлен доступ.
Drive App Позволяет сценариям создавать, находить и изменять файлы и папки на Google Диске.
File Файл на Google Диске.
File Iterator Итератор, позволяющий сценариям перебирать потенциально большую коллекцию файлов.
Folder Папка на Google Диске.
Folder Iterator Объект, позволяющий сценариям перебирать потенциально большую коллекцию папок.
Permission Перечисление, представляющее разрешения, предоставленные пользователям, которые могут получить доступ к файлу или папке, помимо любых отдельных пользователей, которым был явно предоставлен доступ.
User Пользователь, связанный с файлом на Google Диске.

Access

Характеристики

Свойство Тип Описание
ANYONE Enum Любой человек в Интернете может найти и получить доступ.
ANYONE_WITH_LINK Enum Доступ может получить любой, у кого есть ссылка.
DOMAIN Enum Люди в вашем домене могут находить и получать доступ.
DOMAIN_WITH_LINK Enum Доступ к ней смогут получить пользователи вашего домена, у которых есть ссылка.
PRIVATE Enum Доступ могут получить только люди, которым явно предоставлено разрешение.

Drive App

Характеристики

Свойство Тип Описание
Access Access Перечисление, представляющее классы пользователей, которые могут получить доступ к файлу или папке, помимо отдельных пользователей, которым был явно предоставлен доступ.
Permission Permission Перечисление, представляющее разрешения, предоставленные пользователям, которые могут получить доступ к файлу или папке, помимо любых отдельных пользователей, которым был явно предоставлен доступ.

Методы

Метод Тип возврата Краткое описание
continue File Iterator(continuationToken) File Iterator Возобновляет итерацию файла, используя токен продолжения предыдущего итератора.
continue Folder Iterator(continuationToken) Folder Iterator Возобновляет итерацию папки, используя токен продолжения предыдущего итератора.
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 Создает ярлык для предоставленного идентификатора элемента Диска и ключа ресурса и возвращает его.
enforce Single Parent(value) void Включает или отключает поведение EnforceSingleParent для всех вызовов, влияющих на родителей элементов.
get File By Id(id) File Получает файл с заданным идентификатором.
get File By Id And Resource Key(id, resourceKey) File Получает файл с заданным идентификатором и ключом ресурса.
get Files() File Iterator Получает коллекцию всех файлов на Диске пользователя.
get Files By Name(name) File Iterator Получает коллекцию всех файлов на Диске пользователя, имеющих заданное имя.
get Files By Type(mimeType) File Iterator Получает коллекцию всех файлов на Диске пользователя, имеющих заданный тип MIME.
get Folder By Id(id) Folder Получает папку с заданным идентификатором.
get Folder By Id And Resource Key(id, resourceKey) Folder Получает папку с заданным идентификатором и ключом ресурса.
get Folders() Folder Iterator Получает коллекцию всех папок на Диске пользователя.
get Folders By Name(name) Folder Iterator Получает коллекцию всех папок на Диске пользователя, имеющих заданное имя.
get Root Folder() Folder Получает папку в корне Диска пользователя.
get Storage Limit() Integer Получает количество байтов, которые пользователю разрешено хранить на Диске.
get Storage Used() Integer Получает количество байтов, которые пользователь в настоящее время хранит на Диске.
get Trashed Files() File Iterator Получает коллекцию всех файлов в корзине Диска пользователя.
get Trashed Folders() Folder Iterator Получает коллекцию всех папок в корзине Диска пользователя.
search Files(params) File Iterator Получает коллекцию всех файлов на Диске пользователя, соответствующих заданным критериям поиска.
search Folders(params) Folder Iterator Получает коллекцию всех папок на Диске пользователя, соответствующих заданным критериям поиска.

File

Методы

Метод Тип возврата Краткое описание
add Commenter(emailAddress) File Добавьте данного пользователя в список комментаторов File .
add Commenter(user) File Добавьте данного пользователя в список комментаторов File .
add Commenters(emailAddresses) File Добавьте данный массив пользователей в список комментаторов File .
add Editor(emailAddress) File Добавляет данного пользователя в список редакторов File .
add Editor(user) File Добавляет данного пользователя в список редакторов File .
add Editors(emailAddresses) File Добавляет заданный массив пользователей в список редакторов File .
add Viewer(emailAddress) File Добавляет данного пользователя в список просмотрщиков File .
add Viewer(user) File Добавляет данного пользователя в список просмотрщиков File .
add Viewers(emailAddresses) File Добавляет заданный массив пользователей в список просмотрщиков File .
get Access(email) Permission Получает разрешение, предоставленное конкретному пользователю.
get Access(user) Permission Получает разрешение, предоставленное конкретному пользователю.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Date Created() Date Получает дату создания File .
get Description() String Получает описание File .
get Download Url() String Получает URL-адрес, который можно использовать для загрузки файла.
get Editors() User[] Получает список редакторов для этого File .
get Id() String Получает идентификатор File .
get Last Updated() Date Получает дату последнего обновления File .
get Mime Type() String Получает MIME-тип файла.
get Name() String Получает имя File .
get Owner() User Получает владельца файла.
get Parents() Folder Iterator Получает коллекцию папок, которые являются непосредственными родительскими папками File .
get Resource Key() String Получает ключ ресурса File , необходимый для доступа к элементам, к которым предоставлен общий доступ по ссылке.
get Security Update Eligible() Boolean Определяет, имеет ли этот File право на применение обновления безопасности, для доступа к которому требуется ключ ресурса при его совместном использовании по ссылке.
get Security Update Enabled() Boolean Определяет, требует ли этот File ключ ресурса для доступа, когда к нему предоставляется общий доступ по ссылке.
get Sharing Access() Access Получает класс пользователей, которые могут получить доступ к File , помимо отдельных пользователей, которым явно предоставлен доступ.
get Sharing Permission() Permission Получает разрешение, предоставленное тем пользователям, которые могут получить доступ к File , помимо отдельных пользователей, которым явно предоставлен доступ.
get Size() Integer Получает количество байтов, используемых для хранения File на диске.
get Target Id() String Если это ярлык, возвращает идентификатор элемента, на который он указывает.
get Target Mime Type() String Если это ярлык, возвращает mime-тип элемента, на который он указывает.
get Target Resource Key() String Если файл является ярлыком, возвращает ключ ресурса элемента, на который он указывает.
get Thumbnail() Blob Получает миниатюру файла или null , если миниатюра не существует.
get Url() String Получает URL-адрес, который можно использовать для открытия File в приложении Google, например на Диске или Документах.
get Viewers() User[] Получает список читателей и комментаторов этого File .
is Shareable By Editors() Boolean Определяет, разрешено ли пользователям с разрешениями на редактирование File делиться с другими пользователями или изменять разрешения.
is Starred() Boolean Определяет, был ли File помечен на Диске пользователя.
is Trashed() Boolean Определяет, находится ли File в корзине Диска пользователя.
make Copy() File Создает копию файла.
make Copy(destination) File Создает копию файла в каталоге назначения.
make Copy(name) File Создает копию файла и называет ее указанным именем.
make Copy(name, destination) File Создает копию файла в каталоге назначения и присваивает ей указанное имя.
move To(destination) File Перемещает этот элемент в указанную папку назначения.
remove Commenter(emailAddress) File Удаляет данного пользователя из списка комментаторов File .
remove Commenter(user) File Удаляет данного пользователя из списка комментаторов File .
remove Editor(emailAddress) File Удаляет данного пользователя из списка редакторов File .
remove Editor(user) File Удаляет данного пользователя из списка редакторов File .
remove Viewer(emailAddress) File Удаляет данного пользователя из списка читателей и комментаторов File .
remove Viewer(user) File Удаляет данного пользователя из списка читателей и комментаторов File .
revoke Permissions(emailAddress) File Отменяет доступ к File , предоставленный данному пользователю.
revoke Permissions(user) File Отменяет доступ к File , предоставленный данному пользователю.
set Content(content) File Перезаписывает содержимое файла с заданной заменой.
set Description(description) File Устанавливает описание File .
set Name(name) File Устанавливает имя File .
set Owner(emailAddress) File Изменяет владельца File .
set Owner(user) File Изменяет владельца File .
set Security Update Enabled(enabled) File Определяет, требует ли File ключа ресурса для доступа, когда он распространяется по ссылке.
set Shareable By Editors(shareable) File Определяет, могут ли пользователи с разрешениями на редактирование File делиться файлом с другими пользователями или изменять разрешения.
set Sharing(accessType, permissionType) File Устанавливает, какой класс пользователей может получить доступ File и какие разрешения предоставляются этим пользователям, помимо отдельных пользователей, которым был явно предоставлен доступ.
set Starred(starred) File Определяет, помечается ли File звездочкой на Диске пользователя.
set Trashed(trashed) File Определяет, находится ли File в корзине Диска пользователя.

File Iterator

Методы

Метод Тип возврата Краткое описание
get Continuation Token() String Получает токен, который можно использовать для возобновления этой итерации позднее.
has Next() Boolean Определяет, вернет ли вызов next() элемент.
next() File Получает следующий элемент в коллекции файлов или папок.

Folder

Методы

Метод Тип возврата Краткое описание
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 в корзине Диска пользователя.

Folder Iterator

Методы

Метод Тип возврата Краткое описание
get Continuation Token() String Получает токен, который можно использовать для возобновления этой итерации позднее.
has Next() Boolean Определяет, вернет ли вызов next() элемент.
next() Folder Получает следующий элемент в коллекции файлов или папок.

Permission

Характеристики

Свойство Тип Описание
VIEW Enum Пользователи, имеющие доступ к файлу или папке, могут только просматривать или копировать их.
EDIT Enum Пользователи, у которых есть доступ к файлу или папке, могут редактировать их.
COMMENT Enum Пользователи, имеющие доступ к файлу или папке, могут только просматривать, копировать или комментировать их.
OWNER Enum Пользователь является владельцем файла или папки.
ORGANIZER Enum Пользователи, которые могут упорядочивать файлы и папки на общем диске.
FILE_ORGANIZER Enum Пользователи, которые могут редактировать, удалять и перемещать контент на общем диске.
NONE Enum У пользователя нет прав доступа к файлу или папке.

User

Методы

Метод Тип возврата Краткое описание
get Domain() String Получает имя домена, связанное с учетной записью пользователя.
get Email() String Получает адрес электронной почты пользователя.
get Name() String Получает имя пользователя.
get Photo Url() String Получает URL-адрес фотографии пользователя.