Query

Определение запроса, используемое для поиска и экспорта.

JSON-представление 
{
  "corpus": enum (CorpusType),
  "dataScope": enum (DataScope),
  "searchMethod": enum (SearchMethod),
  "method": enum (SearchMethod),
  "terms": string,
  "startTime": string,
  "endTime": string,
  "teamDriveInfo": {
    object (TeamDriveInfo)
  },
  "timeZone": string,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
Поля
corpus

enum (CorpusType)

Сервис Google Workspace, в котором нужно выполнить поиск.
dataScope

enum (DataScope)

Источник данных для поиска.
searchMethod
(deprecated)

enum (SearchMethod)

Метод поиска.
method

enum (SearchMethod)

Объект, в котором нужно выполнить поиск. Это поле заменяет searchMethod для поддержки общих дисков. Если для параметра searchMethod задано значение TEAM_DRIVE, в ответе этого поля будет указано SHARED_DRIVE.
terms

string

Операторы поиска для фильтрации результатов поиска.
startTime

string (Timestamp format)

Время начала поискового запроса. Укажите время по Гринвичу. Значение округляется до 12:00 указанной даты.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Время окончания поискового запроса. Укажите время по Гринвичу. Значение округляется до 12:00 указанной даты.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Обязательно, если для параметра SearchMethod задано значение TEAM_DRIVE.
timeZone

string

Название часового пояса. Это должно быть название часового пояса в базе данных IANA, например "America/Los_Angeles". Список названий часовых поясов приведен в статье Часовой пояс. Дополнительную информацию о том, как Сейф использует часовые пояса, можно найти в Справочном центре Сейфа.
Указывает сведения об объектах, которые нужно найти, если это необходимо. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
accountInfo

object (AccountInfo)

Обязательно, если для параметра SearchMethod задано значение ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Обязательно, если для параметра SearchMethod задано значение ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Обязательно, если для параметра SearchMethod задано значение SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Обязательно, если для параметра SearchMethod задано значение ROOM. (только для чтения)
sitesUrlInfo

object (SitesUrlInfo)

Обязательно, если для параметра SearchMethod задано значение SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Обязательно, если для параметра SearchMethod задано значение DRIVE_DOCUMENT.
Конец взаимоисключающих полей.
Дополнительные параметры поиска для определенных сервисов. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
mailOptions

object (MailOptions)

Задайте параметры поиска в Gmail.
driveOptions

object (DriveOptions)

Задайте параметры поиска на Диске.
hangoutsChatOptions

object (HangoutsChatOptions)

Задайте параметры поиска в Chat. (только для чтения)
voiceOptions

object (VoiceOptions)

Задайте настройки голосового поиска.
calendarOptions

object (CalendarOptions)

Задайте параметры поиска в Календаре.
geminiOptions

object (GeminiOptions)

Задайте параметры поиска в приложении Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Задайте параметры поиска для Gemini в Workspace.
Конец взаимоисключающих полей.

DataScope

Источник данных для поиска.

Перечисления
DATA_SCOPE_UNSPECIFIED Источник данных не указан.
ALL_DATA Все доступные данные.
HELD_DATA Только данные с запретом на удаление.
UNPROCESSED_DATA Только данные, которые ещё не обработаны Сейфом. (только для Gmail и Групп)

SearchMethod

Тип объекта для поиска.

Перечисления
SEARCH_METHOD_UNSPECIFIED Если метод поиска не указан, запрос будет отклонен.
ACCOUNT Поиск данных в аккаунтах, указанных в AccountInfo.
ORG_UNIT Поиск данных всех аккаунтов в организационном подразделении, указанном в OrgUnitInfo.
TEAM_DRIVE

Поиск данных на общем диске, указанном в teamDriveInfo.
ENTIRE_ORG Поиск по данным всех аккаунтов в организации. Поддерживается только для Gmail. Если он указан, то указывать AccountInfo или OrgUnitInfo не нужно.
ROOM Поиск сообщений в чат-группах Chat, указанных в HangoutsChatInfo.
SITES_URL Поиск сайтов по опубликованным URL, указанным в SitesUrlInfo.
SHARED_DRIVE Поиск файлов на общих дисках, указанных в SharedDriveInfo.
DRIVE_DOCUMENT Получить документы, указанные в DriveDocumentInfo.

AccountInfo

Аккаунты, в которых нужно выполнить поиск

JSON-представление 
{
  "emails": [
    string
  ]
}
Поля
emails[]

string

набор аккаунтов, в которых нужно выполнить поиск;

OrgUnitInfo

Организационное подразделение для поиска.

JSON-представление 
{
  "orgUnitId": string
}
Поля
orgUnitId

string

Название организационного подразделения, которое нужно найти, как указано в Admin SDK Directory API.

SharedDriveInfo

Общие диски, на которых нужно выполнить поиск.

JSON-представление 
{
  "sharedDriveIds": [
    string
  ]
}
Поля
sharedDriveIds[]

string

Список идентификаторов общих дисков, предоставленный Drive API.

HangoutsChatInfo

Чат-группы Chat, в которых нужно выполнить поиск.

JSON-представление 
{
  "roomId": [
    string
  ]
}
Поля
roomId[]

string

Список идентификаторов чат-групп, предоставленный Chat API. За один запрос можно экспортировать данные не более чем из 500 чат-групп Chat.

SitesUrlInfo

URL опубликованных сайтов, созданных в новой версии Google Сайтов, для поиска.

JSON-представление 
{
  "urls": [
    string
  ]
}
Поля
urls[]

string

Список URL опубликованных сайтов.

DriveDocumentInfo

Документы на Диске, в которых нужно выполнить поиск.

JSON-представление 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Поля
Формат, в котором нужно получить документы Диска. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
documentIds

object (DriveDocumentIds)

Укажите документы на Диске по идентификатору.
Конец взаимоисключающих полей.

DriveDocumentIds

Укажите документы на Диске по идентификатору.

JSON-представление 
{
  "ids": [
    string
  ]
}
Поля
ids[]

string

Обязательно. Список идентификаторов документов на Диске.

TeamDriveInfo

Общие диски для поиска

JSON-представление 
{
  "teamDriveIds": [
    string
  ]
}
Поля
teamDriveIds[]
(deprecated)

string

Список идентификаторов общих дисков, предоставленный Drive API.

MailOptions

Дополнительные параметры поиска в Gmail

JSON-представление 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Поля
excludeDrafts

boolean

Установите значение true, чтобы исключить черновики.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Указывает, должны ли результаты включать зашифрованный контент, незашифрованный контент или и то, и другое. По умолчанию включены оба варианта.

ClientSideEncryptedOption

Если в вашей организации используется клиентское шифрование Google Workspace, статус шифрования контента

Перечисления
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Статус шифрования не указан. В результатах поиска будет как клиентский зашифрованный, так и незашифрованный контент.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Включать в результаты как зашифрованный на стороне клиента, так и незашифрованный контент.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Включить только контент, зашифрованный на стороне клиента.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Включать только незашифрованный контент.

DriveOptions

Дополнительные параметры поиска на Диске.

JSON-представление 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
Поля
versionDate

string (Timestamp format)

Искать данные в текущей версии файла на Диске, но экспортировать содержимое последней версии файла, сохраненной до 00:00 (UTC) указанного дня. Укажите дату по всемирному координированному времени (UTC).

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Установите значение true, чтобы включить командный диск.
includeSharedDrives
(deprecated)

boolean

Установите значение true, чтобы включить общие диски.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Укажите, что должно быть включено в результаты: только контент, зашифрованный с помощью клиентского шифрования Google Workspace, только незашифрованный контент или и то, и другое. По умолчанию используются оба. В настоящее время поддерживается для Диска.
sharedDrivesOption

enum (SharedDrivesOption)

Необязательное поле. Параметры для включения или исключения документов на общих дисках. Рекомендуем использовать это поле вместо includeSharedDrives. Если это поле задано, оно переопределяет includeSharedDrives и includeTeamDrives.

SharedDrivesOption

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

Перечисления
SHARED_DRIVES_OPTION_UNSPECIFIED Не указан параметр общего диска.
NOT_INCLUDED Ресурс, находящийся на общем диске, не включается в результаты поиска.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Ресурсы общего диска включаются только в том случае, если аккаунт является соавтором ресурса, но не является участником общего диска. Это соответствует параметру Ресурс включается только в том случае, если документы были предоставлены напрямую (не в рамках доступа к общему диску) в интерфейсе Сейфа. (ранее – includeSharedDrives=false)
INCLUDED Ресурсы, находящиеся на общих дисках, включаются в результаты поиска. (ранее – includeSharedDrives)

HangoutsChatOptions

Дополнительные параметры поиска в Google Chat

JSON-представление 
{
  "includeRooms": boolean
}
Поля
includeRooms

boolean

Для поиска по аккаунту или организационному подразделению установите значение true, чтобы включить переговорные комнаты.

VoiceOptions

Дополнительные параметры голосового поиска

JSON-представление 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Поля
coveredData[]

enum (VoiceCoveredData)

Типы данных для поиска

CalendarOptions

Дополнительные параметры поиска в Календаре

JSON-представление 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Поля
locationQuery[]

string

Соответствует только тем событиям, место проведения которых содержит все слова из заданного набора. Если строка содержит фразы в кавычках, этот метод сопоставляет только те мероприятия, место проведения которых содержит точную фразу. Записи в наборе рассматриваются как "и".

Пример разделения слов: ["Новая Зеландия"] и ["Новая","Зеландия"]. "Новая Зеландия" соответствует обоим вариантам. "Новая и лучшая Зеландия" соответствует только второму варианту.
peopleQuery[]

string

Совпадение только с теми мероприятиями, в списке участников которых есть все слова из заданного набора. Записи в наборе рассматриваются как "и".
minusWords[]

string

Соответствует только тем мероприятиям, которые не содержат ни одного из слов в заданном наборе в названии, описании, месте или участниках. Записи в наборе рассматриваются как "или".
responseStatuses[]

enum (AttendeeResponse)

Соответствует только событиям, по которым хранитель дал один из этих ответов. Если набор пуст или содержит ATTENDEE_RESPONSE_UNSPECIFIED, фильтрация по ответам не выполняется.
versionDate

string (Timestamp format)

Искать текущую версию мероприятия в Календаре, но экспортировать содержимое последней версии, сохраненной до 12:00 (UTC) в указанную дату. Укажите дату по всемирному координированному времени (UTC).

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

AttendeeResponse

Ответ пользователя на приглашение.

Перечисления
ATTENDEE_RESPONSE_UNSPECIFIED Ответ участника не указан. Если задано это значение, фильтрация по ответам не выполняется, а все остальные ответы участников, которые являются частью параметров запроса, игнорируются.
ATTENDEE_RESPONSE_NEEDS_ACTION Участник приглашен, но ещё не ответил.
ATTENDEE_RESPONSE_ACCEPTED Участник планирует посетить мероприятие.
ATTENDEE_RESPONSE_DECLINED Участник не планирует присутствовать.
ATTENDEE_RESPONSE_TENTATIVE Участник, возможно, посетит мероприятие.

GeminiOptions

У этого типа нет полей.

Дополнительные параметры поиска в приложении Gemini

GeminiInWorkspaceOptions

У этого типа нет полей.

Дополнительные параметры поиска Gemini в Workspace