Query

Es la definición de consulta que se usa para la búsqueda y la exportación.

Representación 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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Campos
corpus

enum (CorpusType)

El servicio de Google Workspace en el que se realizará la búsqueda.
dataScope

enum (DataScope)

Es la fuente de datos que se debe buscar.
searchMethod
(deprecated)

enum (SearchMethod)

Es el método de búsqueda que se usará.
method

enum (SearchMethod)

Es la entidad que se va a buscar. Este campo reemplaza a searchMethod para admitir unidades compartidas. Cuando searchMethod es TEAM_DRIVE, la respuesta de este campo es SHARED_DRIVE.
terms

string

Operadores de búsqueda específicos del servicio para filtrar los resultados de la búsqueda
startTime

string (Timestamp format)

La hora de inicio de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

La hora de finalización de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obligatorio cuando SearchMethod es TEAM_DRIVE.
timeZone

string

El nombre de la zona horaria. Debe ser un nombre de IANA TZ, como “America/Los_Angeles”. Para obtener una lista de los nombres de zonas horarias, consulta Zona horaria. Para obtener más información sobre cómo Vault usa las zonas horarias, consulta el Centro de ayuda de Vault.
Campo de unión search_method_field. Cuando sea necesario, los detalles de las entidades que se buscarán search_method_field pueden ser solo uno de los siguientes:
accountInfo

object (AccountInfo)

Obligatorio cuando SearchMethod es ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Obligatorio cuando SearchMethod es ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Obligatorio cuando SearchMethod es SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Obligatorio cuando SearchMethod es ROOM. (solo lectura)
sitesUrlInfo

object (SitesUrlInfo)

Obligatorio cuando SearchMethod es SITES_URL.
Campo de unión corpus_options_field. Opciones de búsqueda adicionales para servicios específicos. Las direcciones (corpus_options_field) solo pueden ser una de las siguientes opciones:
mailOptions

object (MailOptions)

Establece opciones específicas de la búsqueda de Gmail.
driveOptions

object (DriveOptions)

Establece opciones específicas de la búsqueda de Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Establece opciones específicas de búsqueda de Chat. (solo lectura)
voiceOptions

object (VoiceOptions)

Establece opciones específicas de la Búsqueda por voz.
calendarOptions

object (CalendarOptions)

Configura opciones específicas de búsqueda del Calendario.
geminiOptions

object (GeminiOptions)

Establece opciones específicas de la búsqueda de Gemini.

DataScope

Es la fuente de datos que se buscará.

Enumeraciones
DATA_SCOPE_UNSPECIFIED No se especificó ninguna fuente de datos.
ALL_DATA Todos los datos disponibles
HELD_DATA Solo datos en espera.
UNPROCESSED_DATA Solo los datos que Vault aún no procesó. (Solo para Gmail y Grupos)

SearchMethod

Es el tipo de entidad de la búsqueda.

Enumeraciones
SEARCH_METHOD_UNSPECIFIED Se debe especificar un método de búsqueda; de lo contrario, se rechazará.
ACCOUNT Busca los datos de las cuentas especificadas en AccountInfo.
ORG_UNIT Busca los datos de todas las cuentas de la unidad organizativa especificada en OrgUnitInfo.
TEAM_DRIVE

Busca los datos en la unidad de equipo especificada en teamDriveInfo.
ENTIRE_ORG Buscar los datos de todas las cuentas de la organización Solo es compatible con Gmail. Cuando se especifica, no es necesario especificar AccountInfo ni OrgUnitInfo.
ROOM Busca mensajes en los espacios de Chat especificados en HangoutsChatInfo.
SITES_URL Busca sitios por las URLs publicadas que se especifican en SitesUrlInfo.
SHARED_DRIVE Busca los archivos en las unidades compartidas especificadas en SharedDriveInfo.

AccountInfo

Las cuentas que se buscarán

Representación JSON 
{
  "emails": [
    string
  ]
}
Campos
emails[]

string

Es un conjunto de cuentas para buscar.

OrgUnitInfo

La unidad organizativa que se debe buscar

Representación JSON 
{
  "orgUnitId": string
}
Campos
orgUnitId

string

Es el nombre de la unidad organizativa que se buscará, como lo proporciona la API de Directory del SDK de Admin.

SharedDriveInfo

Las unidades compartidas en las que se debe realizar la búsqueda

Representación JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Campos
sharedDriveIds[]

string

Es una lista de IDs de unidades compartidas, como los proporciona la API de Drive.

HangoutsChatInfo

Los espacios de Chat que quieres buscar

Representación JSON 
{
  "roomId": [
    string
  ]
}
Campos
roomId[]

string

Es una lista de IDs de espacios de Chat, como los proporciona la API de Chat. Existe un límite de exportación de 500 espacios de Chat por solicitud.

SitesUrlInfo

Las URLs publicadas de los sitios de Google nuevos que deseas buscar

Representación JSON 
{
  "urls": [
    string
  ]
}
Campos
urls[]

string

Una lista de las URLs publicadas de los sitios.

TeamDriveInfo

Unidades de equipo en las que buscar

Representación JSON 
{
  "teamDriveIds": [
    string
  ]
}
Campos
teamDriveIds[]
(deprecated)

string

Es una lista de los IDs de las unidades de equipo, como los proporciona la API de Drive.

MailOptions

Opciones adicionales para la búsqueda de Gmail

Representación JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campos
excludeDrafts

boolean

Configúralo en true para excluir los borradores.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Especifica si los resultados deben incluir contenido encriptado, no encriptado o ambos. La configuración predeterminada incluye ambos.

ClientSideEncryptedOption

Si tu organización usa la encriptación del cliente de Google Workspace, el estado de encriptación del contenido

Enumeraciones
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED No se especificó el estado de la encriptación. Los resultados incluyen contenido encriptado y no encriptado del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluye contenido encriptado y no encriptado del cliente en los resultados.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluye solo contenido encriptado del lado del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Solo incluye contenido no encriptado.

DriveOptions

Opciones adicionales para la búsqueda de Drive.

Representación JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campos
versionDate

string (Timestamp format)

Busca la versión actual del archivo de Drive, pero exporta el contenido de la última versión guardada antes de las 12:00 a.m. (UTC) de la fecha especificada. Ingresa la fecha en UTC.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Se establece como verdadero para incluir la unidad compartida del equipo.
includeSharedDrives
(deprecated)

boolean

Configúralo en true para incluir las unidades compartidas.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Establece si los resultados solo incluyen contenido encriptado con la encriptación del cliente de Google Workspace, solo contenido no encriptado o ambos. La configuración predeterminada es ambas. Actualmente, es compatible con Drive.

HangoutsChatOptions

Opciones adicionales para la búsqueda de Google Chat

Representación JSON 
{
  "includeRooms": boolean
}
Campos
includeRooms

boolean

Para las búsquedas por cuenta o unidad organizativa, establece el valor en true para incluir las salas.

VoiceOptions

Opciones adicionales para la Búsqueda por voz

Representación JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campos
coveredData[]

enum (VoiceCoveredData)

Tipos de datos para buscar

CalendarOptions

Opciones adicionales para la búsqueda en el Calendario

Representación JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Campos
locationQuery[]

string

Solo coincide con los eventos cuya ubicación contiene todas las palabras del conjunto determinado. Si la cadena contiene frases entre comillas, este método solo coincide con aquellos eventos cuya ubicación contiene la frase exacta. Las entradas del conjunto se consideran en "y".

Ejemplo de división de palabras: ["New Zealand"] vs ["New","Zealand"] "New Zealand": coincide con ambas "New and better Zealand": solo coincide con la última
peopleQuery[]

string

Solo coincide con los eventos cuyos asistentes contengan todas las palabras del conjunto determinado. Las entradas del conjunto se consideran en "y".
minusWords[]

string

Solo coincide con los eventos que no contienen ninguna de las palabras del conjunto determinado en el título, la descripción, la ubicación o los asistentes. Las entradas del conjunto se consideran en "o".
responseStatuses[]

enum (AttendeeResponse)

Solo coincide con los eventos para los que el custodio proporcionó una de estas respuestas. Si el conjunto está vacío o contiene ATTENDEE_RESPONSE_UNSPECIFIED, no se filtrarán las respuestas.
versionDate

string (Timestamp format)

Busca en la versión actual del evento de Calendario, pero exporta el contenido de la última versión guardada antes de las 12:00 a.m. (UTC) de la fecha especificada. Ingresa la fecha en UTC.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AttendeeResponse

Respuesta del usuario a una invitación.

Enumeraciones
ATTENDEE_RESPONSE_UNSPECIFIED No se especificó la respuesta del asistente. Si se establece esta opción, no se aplicará ningún filtro a las respuestas, y se ignorarán todas las demás respuestas de los asistentes que forman parte de las opciones de consulta.
ATTENDEE_RESPONSE_NEEDS_ACTION Se invitó al participante, pero aún no responde.
ATTENDEE_RESPONSE_ACCEPTED El participante planea asistir.
ATTENDEE_RESPONSE_DECLINED El participante no planea asistir.
ATTENDEE_RESPONSE_TENTATIVE El participante espera poder asistir.

GeminiOptions

Este tipo no tiene campos.

Opciones adicionales para la búsqueda de Gemini