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)
  }
}
Поля
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: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" .

teamDriveInfo
(deprecated)

object ( TeamDriveInfo )

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

timeZone

string

Название часового пояса. Это должно быть название часового пояса IANA, например, "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 )

Настройте параметры поиска в Google Диске.

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 и Groups)

Метод поиска

Тип сущности для поиска.

Перечисления
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 Google Диска .

HangoutsChatInfo

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

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

string

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

SitesUrlInfo

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

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

string

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

DriveDocumentInfo

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

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

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

object ( DriveDocumentIds )

Указывайте файлы на Диске по идентификатору документа.

Идентификаторы документов диска

Указывайте файлы на Диске по идентификатору документа.

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

string

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

TeamDriveInfo

Команда прилагает усилия для поиска

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

string

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

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

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

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

string ( Timestamp format)

Найдите текущую версию файла на Google Диске, но экспортируйте содержимое последней версии, сохраненной до 00:00 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, чтобы включить TeamDrive.

includeSharedDrives
(deprecated)

boolean

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

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

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

sharedDrivesOption

enum ( SharedDrivesOption )

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

SharedDrivesOption

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

Перечисления
SHARED_DRIVES_OPTION_UNSPECIFIED Параметр "общий диск" не указан.
NOT_INCLUDED Если ресурс находится на общем диске, он не включается в поиск.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Ресурсы общего доступа включаются только в тех случаях, когда учетная запись является соавтором ресурса, но не входит в состав пользователей общего доступа. Это соответствует параметру «Включать только в том случае, если документы предоставлены в общий доступ напрямую (а не в связи с членством в общем доступе)» в пользовательском интерфейсе хранилища. (Ранее параметр «Включать общие диски» был отключен).
INCLUDED В поиск включаются ресурсы, находящиеся на общих дисках. (Ранее была включена опция "includeSharedDrives")

HangoutsChatOptions

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

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

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

Пример разделения слов: ["New Zealand"] против ["New","Zealand"] "New Zealand": совпадает с обоими "New and better Zealand": совпадает только с последним

peopleQuery[]

string

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

minusWords[]

string

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

responseStatuses[]

enum ( AttendeeResponse )

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

versionDate

string ( Timestamp format)

Найдите текущую версию события календаря, но экспортируйте содержимое последней версии, сохраненной до 00:00 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

Этот тип не содержит полей.

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