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

Drive Service

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

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Примечание. Администраторы доменов Google Workspace могут отключить Drive SDK для своего домена, что не позволит их пользователям устанавливать и использовать приложения Google Диска. Этот параметр также не позволит пользователям использовать скрипты Apps Script, веб-приложения и надстройки, использующие службу Диска или расширенную службу Диска (даже если рассматриваемая надстройка или веб-приложение были установлены до отключения администратором). Драйв SDK ).

Однако, если надстройка, использующая службу Диска, опубликована для установки на уровне домена и установлена администратором для некоторых или всех пользователей в домене, или любой сценарий приложений, клиент OAuth которого добавлен в белый список администратором домена, надстройка -on работает для этих пользователей, даже если Drive SDK отключен в домене.

Классы

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

`Access`

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

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

`DriveApp`

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

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

Методы

Метод	Тип возврата	Краткое описание
`continueFileIterator(continuationToken)`	`FileIterator`	Возобновляет итерацию файла, используя маркер продолжения предыдущего итератора.
`continueFolderIterator(continuationToken)`	`FolderIterator`	Возобновляет итерацию папки, используя маркер продолжения предыдущего итератора.
`createFile(blob)`	`File`	Создает файл в корне Диска пользователя из заданного `Blob` объекта произвольных данных.
`createFile(name, content)`	`File`	Создает текстовый файл в корне Диска пользователя с заданным именем и содержимым.
`createFile(name, content, mimeType)`	`File`	Создает файл в корне Диска пользователя с заданным именем, содержимым и типом MIME.
`createFolder(name)`	`Folder`	Создает папку в корне Диска пользователя с заданным именем.
`createShortcut(targetId)`	`File`	Создает ярлык для предоставленного идентификатора элемента Диска и возвращает его.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Создает ярлык для предоставленного идентификатора элемента Диска и ключа ресурса и возвращает его.
`enforceSingleParent(value)`	`void`	Включает или отключает поведение forceSingleParent для всех вызовов, влияющих на родительские элементы.
`getFileById(id)`	`File`	Получает файл с заданным идентификатором.
`getFileByIdAndResourceKey(id, resourceKey)`	`File`	Получает файл с заданным идентификатором и ключом ресурса.
`getFiles()`	`FileIterator`	Получает коллекцию всех файлов на Диске пользователя.
`getFilesByName(name)`	`FileIterator`	Получает коллекцию всех файлов на Диске пользователя с заданным именем.
`getFilesByType(mimeType)`	`FileIterator`	Получает коллекцию всех файлов на Диске пользователя, имеющих заданный тип MIME.
`getFolderById(id)`	`Folder`	Получает папку с заданным идентификатором.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Получает папку с заданным идентификатором и ключом ресурса.
`getFolders()`	`FolderIterator`	Получает коллекцию всех папок на Диске пользователя.
`getFoldersByName(name)`	`FolderIterator`	Получает коллекцию всех папок на Диске пользователя с заданным именем.
`getRootFolder()`	`Folder`	Получает папку в корне Диска пользователя.
`getStorageLimit()`	`Integer`	Получает количество байтов, которое пользователь может хранить на Диске.
`getStorageUsed()`	`Integer`	Получает количество байтов, которые пользователь в данный момент хранит на Диске.
`getTrashedFiles()`	`FileIterator`	Получает коллекцию всех файлов в корзине Диска пользователя.
`getTrashedFolders()`	`FolderIterator`	Получает коллекцию всех папок в корзине Диска пользователя.
`searchFiles(params)`	`FileIterator`	Получает коллекцию всех файлов на Диске пользователя, соответствующих заданным критериям поиска.
`searchFolders(params)`	`FolderIterator`	Получает коллекцию всех папок на Диске пользователя, соответствующих заданным критериям поиска.

`File`

Методы

Метод	Тип возврата	Краткое описание
`addCommenter(emailAddress)`	`File`	Добавить данного пользователя в список комментаторов `File` .
`addCommenter(user)`	`File`	Добавить данного пользователя в список комментаторов `File` .
`addCommenters(emailAddresses)`	`File`	Добавьте заданный массив пользователей в список комментаторов для `File` .
`addEditor(emailAddress)`	`File`	Добавляет данного пользователя в список редакторов `File` .
`addEditor(user)`	`File`	Добавляет данного пользователя в список редакторов `File` .
`addEditors(emailAddresses)`	`File`	Добавляет заданный массив пользователей в список редакторов `File` .
`addViewer(emailAddress)`	`File`	Добавляет данного пользователя в список зрителей для `File` .
`addViewer(user)`	`File`	Добавляет данного пользователя в список зрителей для `File` .
`addViewers(emailAddresses)`	`File`	Добавляет указанный массив пользователей в список зрителей для `File` .
`getAccess(email)`	`Permission`	Получает разрешение, предоставленное данному пользователю.
`getAccess(user)`	`Permission`	Получает разрешение, предоставленное данному пользователю.
`getAs(contentType)`	`Blob`	Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
`getBlob()`	`Blob`	Верните данные внутри этого объекта в виде большого двоичного объекта.
`getDateCreated()`	`Date`	Получает дату создания `File` .
`getDescription()`	`String`	Получает описание `File` .
`getDownloadUrl()`	`String`	Получает URL-адрес, который можно использовать для загрузки файла.
`getEditors()`	`User[]`	Получает список редакторов для этого `File` .
`getId()`	`String`	Получает идентификатор `File` .
`getLastUpdated()`	`Date`	Получает дату последнего обновления `File` .
`getMimeType()`	`String`	Получает MIME-тип файла.
`getName()`	`String`	Получает имя `File` .
`getOwner()`	`User`	Получает владельца файла.
`getParents()`	`FolderIterator`	Получает коллекцию папок, которые являются непосредственными родительскими папками `File` .
`getResourceKey()`	`String`	Получает ключ ресурса `File` , необходимый для доступа к элементам, к которым предоставлен общий доступ с помощью ссылки.
`getSecurityUpdateEligible()`	`Boolean`	Получает, имеет ли этот `File` право на применение обновления безопасности, для которого требуется ключ ресурса для доступа, когда к нему предоставлен совместный доступ по ссылке.
`getSecurityUpdateEnabled()`	`Boolean`	Получает, требуется ли этому `File` ключ ресурса для доступа, когда к нему предоставлен общий доступ по ссылке.
`getSharingAccess()`	`Access`	Получает, какой класс пользователей может получить доступ к `File` , помимо любых отдельных пользователей, которым был явно предоставлен доступ.
`getSharingPermission()`	`Permission`	Получает разрешение, предоставленное тем пользователям, которые могут получить доступ к `File` , помимо любых отдельных пользователей, которым был явно предоставлен доступ.
`getSize()`	`Integer`	Получает количество байтов, используемых для хранения `File` на диске.
`getTargetId()`	`String`	Если это ярлык, возвращает идентификатор элемента, на который он указывает.
`getTargetMimeType()`	`String`	Если это ярлык, возвращает MIME-тип элемента, на который он указывает.
`getTargetResourceKey()`	`String`	Если файл является ярлыком, возвращает ключ ресурса элемента, на который он указывает.
`getThumbnail()`	`Blob`	Получает миниатюру для файла или `null` , если миниатюра не существует.
`getUrl()`	`String`	Получает URL-адрес, который можно использовать для открытия `File` в приложении Google, таком как Диск или Документы.
`getViewers()`	`User[]`	Получает список зрителей и комментаторов для этого `File` .
`isShareableByEditors()`	`Boolean`	Определяет, могут ли пользователи с разрешениями на редактирование `File` делиться с другими пользователями или изменять разрешения.
`isStarred()`	`Boolean`	Определяет, был ли `File` помечен на Диске пользователя.
`isTrashed()`	`Boolean`	Определяет, находится ли `File` в корзине на Диске пользователя.
`makeCopy()`	`File`	Создает копию файла.
`makeCopy(destination)`	`File`	Создает копию файла в целевом каталоге.
`makeCopy(name)`	`File`	Создает копию файла и присваивает ей указанное имя.
`makeCopy(name, destination)`	`File`	Создает копию файла в целевом каталоге и присваивает ей указанное имя.
`moveTo(destination)`	`File`	Перемещает этот элемент в указанную папку назначения.
`removeCommenter(emailAddress)`	`File`	Удаляет данного пользователя из списка комментаторов `File` .
`removeCommenter(user)`	`File`	Удаляет данного пользователя из списка комментаторов `File` .
`removeEditor(emailAddress)`	`File`	Удаляет данного пользователя из списка редакторов `File` .
`removeEditor(user)`	`File`	Удаляет данного пользователя из списка редакторов `File` .
`removeViewer(emailAddress)`	`File`	Удаляет данного пользователя из списка просматривающих и комментирующих `File` .
`removeViewer(user)`	`File`	Удаляет данного пользователя из списка просматривающих и комментирующих `File` .
`revokePermissions(emailAddress)`	`File`	Отменяет доступ к `File` , предоставленный данному пользователю.
`revokePermissions(user)`	`File`	Отменяет доступ к `File` , предоставленный данному пользователю.
`setContent(content)`	`File`	Перезаписывает содержимое файла с заданной заменой.
`setDescription(description)`	`File`	Устанавливает описание для `File` .
`setName(name)`	`File`	Устанавливает имя `File` .
`setOwner(emailAddress)`	`File`	Изменяет владельца `File` .
`setOwner(user)`	`File`	Изменяет владельца `File` .
`setSecurityUpdateEnabled(enabled)`	`File`	Устанавливает, требуется ли `File` ключ ресурса для доступа, когда он используется совместно с использованием ссылки.
`setShareableByEditors(shareable)`	`File`	Устанавливает, разрешено ли пользователям с разрешениями на редактирование `File` делиться с другими пользователями или изменять разрешения.
`setSharing(accessType, permissionType)`	`File`	Устанавливает, какой класс пользователей может получить доступ к `File` и какие разрешения предоставлены этим пользователям, помимо любых отдельных пользователей, которым был явно предоставлен доступ.
`setStarred(starred)`	`File`	Устанавливает, будет ли `File` помечен на Диске пользователя.
`setTrashed(trashed)`	`File`	Определяет, находится ли `File` в корзине на Диске пользователя.

`FileIterator`

Методы

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

`Folder`

Методы

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

`FolderIterator`

Методы

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

`Permission`

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

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

`User`

Методы

Метод	Тип возврата	Краткое описание
`getDomain()`	`String`	Получает доменное имя, связанное с учетной записью пользователя.
`getEmail()`	`String`	Получает адрес электронной почты пользователя.
`getName()`	`String`	Получает имя пользователя.
`getPhotoUrl()`	`String`	Получает URL-адрес фотографии пользователя.