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,

  // Union field search_method_field can be only one of the following:
  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  }
  // End of list of possible types for union field search_method_field.

  // Union field corpus_options_field can be only one of the following:
  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Поля
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 часов утра указанной даты.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

teamDriveInfo
(deprecated)

object ( TeamDriveInfo )

Требуется, если SearchMethod имеет значение TEAM_DRIVE .

timeZone

string

Название часового пояса. Это должно быть имя IANA TZ, например «America/Los_Angeles». Список названий часовых поясов см. в разделе Часовой пояс . Дополнительную информацию о том, как Сейф использует часовые пояса, можно найти в Справочном центре Сейфа .

Поле объединения search_method_field . При необходимости сведения об объектах для поиска search_method_field могут быть только одним из следующих:
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 .

Поле объединения corpus_options_field . Дополнительные возможности поиска по конкретным услугам. corpus_options_field может быть только одним из следующих:
mailOptions

object ( MailOptions )

Установите параметры поиска Gmail.

driveOptions

object ( DriveOptions )

Установите параметры поиска на Диске.

hangoutsChatOptions

object ( HangoutsChatOptions )

Установите параметры поиска в чате. (только чтение)

voiceOptions

object ( VoiceOptions )

Установите параметры голосового поиска.

calendarOptions

object ( CalendarOptions )

Установите параметры поиска по календарю.

DataScope

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

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

ПоискМетод

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

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

Найдите данные на общем диске, указанном в TeamDriveInfo .

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

Информация об аккаунте

Аккаунты для поиска

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

string

Набор аккаунтов для поиска.

Информация о организационном подразделении

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

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

string

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

SharedDriveInfo

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

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

string

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

HangoutsЧатИнформация

Пространства чата для поиска

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

string

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

СайтыUrlИнформация

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

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

string

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

TeamDriveИнформация

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

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

string

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

Параметры почты

Дополнительные возможности поиска в 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 Включайте только незашифрованный контент.

Параметры диска

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

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

string ( Timestamp format)

Найдите текущую версию файла на Диске, но экспортируйте содержимое последней версии, сохраненной до 00:00 UTC указанной даты. Введите дату в формате UTC.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

includeTeamDrives
(deprecated)

boolean

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

includeSharedDrives

boolean

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

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

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

Параметры HangoutsChat

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

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

boolean

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

Голосовые параметры

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

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

enum ( VoiceCoveredData )

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

Параметры календаря

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

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)

Найдите текущую версию события календаря, но экспортируйте содержимое последней версии, сохраненной до 00:00 UTC указанной даты. Введите дату в формате UTC.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Ответ участника

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

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