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)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }
  // 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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // 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)

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

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

endTime

string ( Timestamp format)

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

Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "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 TZ, например "America/Los_Angeles". Список имен часовых поясов см. в разделе Часовой пояс . Дополнительную информацию о том, как Vault использует часовые пояса, см. в справочном центре Vault .

Поле объединения 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 .

driveDocumentInfo

object ( DriveDocumentInfo )

Требуется, если SearchMethod — DRIVE_DOCUMENT .

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

object ( MailOptions )

Настройте параметры поиска Gmail.

driveOptions

object ( DriveOptions )

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

hangoutsChatOptions

object ( HangoutsChatOptions )

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

voiceOptions

object ( VoiceOptions )

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

calendarOptions

object ( CalendarOptions )

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

geminiOptions

object ( GeminiOptions )

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

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 .
DRIVE_DOCUMENT Извлеките документы, указанные в DriveDocumentInfo.

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

Учетные записи для поиска

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

string

Набор учетных записей для поиска.

OrgUnitInfo

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

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

string

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

SharedDriveInfo

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

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

string

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

HangoutsChatInfo

Чат-пространства для поиска

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

string

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

СайтыUrlInfo

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

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

string

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

DriveDocumentInfo

Документы Диска для поиска.

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

  // Union field identifier can be only one of the following:
  "documentIds": {
    object (DriveDocumentIds)
  }
  // End of list of possible types for union field identifier.
}
Поля
identifier поля объединения. Формат для извлечения документов Диска. identifier может быть только одним из следующих:
documentIds

object ( DriveDocumentIds )

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

DriveDocumentIds

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

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

string

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

TeamDriveInfo

Командные диски для поиска

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

string

Список идентификаторов общих дисков, предоставленный 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)

Поиск текущей версии файла Drive, но экспорт содержимого последней версии, сохраненной до 12:00 AM UTC указанной даты. Введите дату в формате UTC.

Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "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 Ресурсы общего диска включаются только в случаях, когда учетная запись является соавтором ресурса, но не является участником общего диска. Это соответствует параметру «Включено только если документы предоставлены в общий доступ напрямую (не из-за членства в общем диске)» в пользовательском интерфейсе Vault. (Ранее «includeSharedDrives» было отключено)
INCLUDED Ресурсы на общих дисках включены в поиск. (Ранее «includeSharedDrives» включено)

HangoutsЧатПараметры

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

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

boolean

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

VoiceOptions

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

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

enum ( VoiceCoveredData )

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

КалендарьОпции

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

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

string

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

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

peopleQuery[]

string

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

minusWords[]

string

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

responseStatuses[]

enum ( AttendeeResponse )

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

versionDate

string ( Timestamp format)

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

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

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

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

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

GeminiOptions

Этот тип не имеет полей.

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