Позволяет сценариям создавать, находить и изменять файлы и папки на 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()); }
Характеристики
Свойство | Тип | Описание |
---|---|---|
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 | Получает коллекцию всех папок на Диске пользователя, соответствующих заданным критериям поиска. |
Подробная документация
continueFileIterator(continuationToken)
Возобновляет итерацию файла, используя маркер продолжения предыдущего итератора. Этот метод полезен, если обработка итератора за одно выполнение превысит максимальное время выполнения. Жетоны продолжения обычно действительны в течение одной недели.
Параметры
Имя | Тип | Описание |
---|---|---|
continuationToken | String | токен продолжения от предыдущего итератора файла |
Возвращаться
FileIterator
— набор файлов, которые остались в предыдущем итераторе, когда был сгенерирован токен продолжения.
continueFolderIterator(continuationToken)
Возобновляет итерацию папки, используя маркер продолжения предыдущего итератора. Этот метод полезен, если обработка итератора за одно выполнение превысит максимальное время выполнения. Жетоны продолжения обычно действительны в течение одной недели.
Параметры
Имя | Тип | Описание |
---|---|---|
continuationToken | String | токен продолжения из предыдущего итератора папки |
Возвращаться
FolderIterator
— коллекция папок, которые остались в предыдущем итераторе, когда был сгенерирован токен продолжения.
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.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.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.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)
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
enforceSingleParent(value)
Включает или отключает поведение forceSingleParent для всех вызовов, влияющих на родительские элементы.
Дополнительную информацию см. в блоге « Упрощение структуры папок и моделей совместного использования Google Диска» .
Параметры
Имя | Тип | Описание |
---|---|---|
value | Boolean | Новое состояние флага EnforceSingleParent. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive
getFileById(id)
Получает файл с заданным идентификатором. Выдает исключение сценария, если файл не существует или у пользователя нет разрешения на доступ к нему.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор файла |
Возвращаться
File
— файл с заданным ID
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFileByIdAndResourceKey(id, resourceKey)
Получает файл с заданным идентификатором и ключом ресурса. Ресурсные ключи — это дополнительный параметр, который необходимо передать для доступа к файлам, к которым был предоставлен общий доступ по ссылке.
Создает исключение сценария, если файл не существует или у пользователя нет разрешения на доступ к нему.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | Идентификатор файла. |
resourceKey | String | Ресурсный ключ папки. |
Возвращаться
File
— файл с заданным идентификатором.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
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
getFolderById(id)
Получает папку с заданным идентификатором. Создает исключение сценария, если папка не существует или у пользователя нет разрешения на доступ к ней.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор папки |
Возвращаться
Folder
— папка с заданным ID
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFolderByIdAndResourceKey(id, resourceKey)
Получает папку с заданным идентификатором и ключом ресурса. Ресурсные ключи — это дополнительный параметр, который необходимо передать для доступа к папкам, к которым был предоставлен общий доступ по ссылке.
Создает исключение сценария, если папка не существует или у пользователя нет разрешения на доступ к ней.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | Идентификатор папки. |
resourceKey | String | Ресурсный ключ папки. |
Возвращаться
Folder
— папка с заданным идентификатором.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
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
getRootFolder()
getStorageLimit()
Получает количество байтов, которое пользователь может хранить на Диске.
Возвращаться
Integer
число — количество байтов, которое пользователь может хранить на Диске.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getStorageUsed()
Получает количество байтов, которые пользователь в данный момент хранит на Диске.
Возвращаться
Integer
число — количество байтов, которые пользователь в данный момент хранит на Диске.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTrashedFiles()
Получает коллекцию всех файлов в корзине Диска пользователя.
Возвращаться
FileIterator
— коллекция файлов в корзине
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTrashedFolders()
Получает коллекцию всех папок в корзине Диска пользователя.
Возвращаться
FolderIterator
— коллекция папок в корзине
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
searchFiles(params)
Получает коллекцию всех файлов на Диске пользователя, соответствующих заданным критериям поиска. Критерии поиска подробно описаны в документации Google Drive SDK . Обратите внимание, что служба Диска использует API Диска версии 2, а некоторые поля запроса отличаются от версии 3. Просмотрите различия в полях между v2 и v3 .
Аргумент params
представляет собой строку запроса, которая может содержать строковые значения, поэтому позаботьтесь о правильном выходе из кавычек (например "title contains 'Gulliver\\'s Travels'"
или 'title contains "Gulliver\'s Travels"'
).
// Logs the name of every file in the user's Drive that modified after February 28, // 2022 whose name contains "untitled."" var files = DriveApp.searchFiles( 'modifiedDate > "2022-02-28" and title contains "untitled"'); while (files.hasNext()) { var file = files.next(); console.log(file.getName()); }
Параметры
Имя | Тип | Описание |
---|---|---|
params | String | Критерии поиска, как подробно описано в документации Google Drive SDK . |
Возвращаться
FileIterator
— коллекция всех файлов на Диске пользователя, соответствующих критериям поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
searchFolders(params)
Получает коллекцию всех папок на Диске пользователя, соответствующих заданным критериям поиска. Критерии поиска подробно описаны в документации Google Drive SDK . Обратите внимание, что служба Диска использует API Диска версии 2, а некоторые поля запроса отличаются от версии 3. Просмотрите различия в полях между v2 и v3 .
Аргумент params
представляет собой строку запроса, которая может содержать строковые значения, поэтому позаботьтесь о правильном выходе из кавычек (например "title contains 'Gulliver\\'s Travels'"
или 'title contains "Gulliver\'s Travels"'
).
// Logs the name of every folder in the user's Drive that you own and is starred. var folders = DriveApp.searchFolders('starred = true and "me" in owners'); while (folders.hasNext()) { var folder = folders.next(); console.log(folder.getName()); }
Параметры
Имя | Тип | Описание |
---|---|---|
params | String | Критерии поиска, как подробно описано в документации Google Drive SDK . |
Возвращаться
FolderIterator
— коллекция всех папок на Диске пользователя, соответствующих критериям поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive