В этом справочном руководстве приведены поисковые запросы и операторы, которые можно использовать с Google Drive API для фильтрации файлов, папок и общих дисков.
Примеры поисковых запросов приведены в статье Как искать файлы и папки.
Примеры поиска по общим дискам приведены в статье Как найти общий диск.
Синтаксис строки запроса
Строка запроса состоит из трех частей:
query_term operator values
Где:
query_term– это поисковый запрос или поле, по которому выполняется поиск.operatorуказывает условие для поискового запроса.values– это значения, по которым вы хотите отфильтровать результаты поиска.
Операторы запросов
В таблице ниже перечислены допустимые операторы запросов.
| Оператор | Использование |
|---|---|
contains |
Содержимое одной строки присутствует в другой. |
= |
Содержимое строки или логического значения равно другому. |
!= |
Содержимое строки или логическое значение не равно другому. |
< |
Одно значение меньше другого. |
<= |
Одно значение меньше или равно другому. |
> |
Одно значение больше другого. |
>= |
Значение больше другого или равно ему. |
in |
Элемент содержится в коллекции. |
and |
Возвращает объекты, соответствующие обоим запросам. |
or |
Возвращает объекты, соответствующие любому из запросов. |
not |
Отрицает поисковый запрос. |
has |
Коллекция содержит элемент, соответствующий параметрам. |
Условия запроса для определенного файла
В таблице ниже перечислены все допустимые условия запроса для файлов. Типы данных и их описания можно найти в справочнике по ресурсу files.
| Поисковый запрос | Допустимые операторы | Использование |
|---|---|---|
name |
contains, =, != |
Название файла. Заключите в одинарные кавычки ('). Экранируйте одинарные кавычки в запросах с помощью \', например 'Valentine\'s Day'. |
fullText |
contains |
Совпадает ли текст в свойствах name, description, indexableText или в контенте или метаданных файла. Заключите в одинарные кавычки ('). Экранируйте одинарные кавычки в запросах с помощью \', например 'Valentine\'s Day'. |
mimeType |
contains, =, != |
MIME-тип файла. Заключите в одинарные кавычки ('). Экранируйте одинарные кавычки в запросах с помощью \', например 'Valentine\'s Day'. Дополнительную информацию о MIME-типах можно найти в статье Поддерживаемые MIME-типы для Google Workspace и Google Диска. |
modifiedTime |
<=, <, =, !=, >, >= |
Дата последнего изменения файла. Формат RFC 3339, часовой пояс по умолчанию – UTC, например 2012-06-04T12:00:00-08:00. Поля типа date нельзя сравнивать друг с другом, только с постоянными датами. |
viewedByMeTime |
<=, <, =, !=, >, >= |
Дата последнего просмотра файла пользователем. Формат RFC 3339, часовой пояс по умолчанию – UTC, например 2012-06-04T12:00:00-08:00. Поля типа date нельзя сравнивать друг с другом, только с постоянными датами. |
trashed |
=, != |
Находится ли файл в корзине. Допустимые значения: true или false. |
starred |
=, != |
Помечен ли файл. Допустимые значения: true или false. |
parents |
in |
Содержит ли коллекция parents указанный идентификатор. Проверяются только непосредственные родительские папки, а не все папки, в которые они вложены. |
owners |
in |
Пользователи, которым принадлежит файл. |
writers |
in |
Пользователи или группы, у которых есть разрешение на изменение файла. См. справочник по ресурсам permissions. |
readers |
in |
Пользователи или группы, у которых есть разрешение на чтение файла. Ознакомьтесь с информацией о ресурсе permissions. |
sharedWithMe |
=, != |
Файлы, которые находятся в коллекции "Доступные мне" пользователя. Все пользователи файла добавлены в список контроля доступа к нему. Допустимые значения: true или false. |
createdTime |
<=, <, =, !=, >, >= |
Дата создания файла. Используйте формат RFC 3339. Часовой пояс по умолчанию – UTC, например 2012-06-04T12:00:00-08:00. Поддерживается только в Drive API версии 3. |
properties |
has |
Общедоступные настраиваемые свойства файлов. |
appProperties |
has |
Частные настраиваемые свойства файлов. |
visibility |
=, != |
Уровень доступа к файлу. Допустимые значения: anyoneCanFind, anyoneWithLink, domainCanFind, domainWithLink и limited. Заключите в одинарные кавычки ('). |
shortcutDetails.targetId |
=, != |
Идентификатор объекта, на который указывает ярлык. |
Ниже приведены примеры сочетаний операторов и поисковых запросов.
Оператор
containsвыполняет сопоставление только по префиксу для терминаname. Например, у вас есть названиеHelloWorld. Запросname contains 'Hello'возвращает результат, а запросname contains 'World'– нет.Оператор
containsвыполняет сопоставление только по полным строковым токенам для терминаfullText. Например, если полный текст документа содержит строку "HelloWorld", то результат будет возвращен только по запросуfullText contains 'HelloWorld'.Оператор
containsсопоставляет фразу, если правый операнд заключен в двойные кавычки. Пример:Если
fullTextдокумента содержит строку "Hello there world", то запросfullText contains '"Hello there"'вернет результат, а запросfullText contains '"Hello world"'– нет.Если полный текст документа содержит строку "Hello_world", то запрос
fullText contains '"Hello world"'все равно вернет результат, поскольку символ подчеркивания в строке документа обрабатывается как пробел.
Условия
owners,writersиreadersкосвенно отражены в спискеpermissionsи относятся кroleв разрешении. Полный список разрешений для ролей приведен в статье Роли и разрешения.
Другие примеры поиска по строке запроса можно найти в разделе Примеры строк запроса для файлов.
Условия запроса для общих дисков
В таблице ниже перечислены все допустимые условия запроса для общих дисков. Типы данных и их описания приведены в справочнике по ресурсу drives.
| Поисковый запрос | Допустимые операторы | Использование | useDomainAdminAccess параметр |
|---|---|---|---|
createdTime |
<=, <, =, !=, >, >= |
Дата создания общего диска. Формат RFC 3339, часовой пояс по умолчанию – UTC, например 2012-06-04T12:00:00-08:00. |
true |
hidden |
=, != |
Указывает, скрыт ли общий диск. Может иметь значение true или false. |
false |
memberCount |
<=, <, =, !=, >, >= |
Количество пользователей и групп, которые являются участниками общего диска. Принимает числовое значение. | true |
name |
contains, =, != |
Название общего диска. Заключите в одинарные кавычки ('). Экранируйте одинарные кавычки в запросах с помощью \', например 'Valentine\'s Day'. |
true |
organizerCount |
<=, <, =, !=, >, >= |
Количество пользователей и групп, которые являются менеджерами общего диска. Принимает числовое значение. | true |
orgUnitId |
=, != |
Идентификатор организационного подразделения общего диска. Принимает строковое значение. | true |
Дополнительные примеры поиска по строке запроса приведены в статье Примеры строк запроса для общего диска.