Query

Es la definición de la 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,

  "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)
  }
}
Campos
corpus

enum (CorpusType)

Es el servicio de Google Workspace que se buscará.
dataScope

enum (DataScope)

Es la fuente de datos en la que se realizará la búsqueda.
searchMethod
(deprecated)

enum (SearchMethod)

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

enum (SearchMethod)

Es la entidad que se 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)

Es 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 el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “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)

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

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “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)

Es obligatorio cuando SearchMethod es TEAM_DRIVE.
timeZone

string

El nombre de la zona horaria. Debe ser un nombre de zona horaria de IANA, como "America/Los_Angeles". Para obtener una lista de los nombres de las 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.
Especifica los detalles de las entidades que se buscarán, cuando sea necesario. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
accountInfo

object (AccountInfo)

Es obligatorio cuando SearchMethod es ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Es obligatorio cuando SearchMethod es ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Es obligatorio cuando SearchMethod es SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Es obligatorio cuando SearchMethod es ROOM. (solo lectura)
sitesUrlInfo

object (SitesUrlInfo)

Es obligatorio cuando SearchMethod es SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Es obligatorio cuando SearchMethod es DRIVE_DOCUMENT.
Fin de los campos mutuamente excluyentes.
Opciones de búsqueda adicionales para servicios específicos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
mailOptions

object (MailOptions)

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

object (DriveOptions)

Establece opciones específicas para la búsqueda en 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)

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

object (GeminiOptions)

Establecer opciones específicas de búsqueda de la app de Gemini
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Establece las opciones específicas de búsqueda de Gemini en Workspace.
Fin de los campos mutuamente excluyentes.

DataScope

Es la fuente de datos en la que se realizará la búsqueda.

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

SearchMethod

Es el tipo de entidad para la búsqueda.

Enums
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 se admite para 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 de sitios publicados especificadas en SitesUrlInfo.
SHARED_DRIVE Busca los archivos en las unidades compartidas especificadas en SharedDriveInfo.
DRIVE_DOCUMENT Recupera los documentos especificados en DriveDocumentInfo.

AccountInfo

Las cuentas que se deben buscar

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

string

Un conjunto de cuentas en las que se realizará la búsqueda

OrgUnitInfo

La unidad organizativa que se buscará

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

string

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

SharedDriveInfo

Son las unidades compartidas en las que se realizará la búsqueda.

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

string

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

HangoutsChatInfo

Los espacios de Chat en los que se buscará

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

string

Es una lista de IDs de espacios de Chat, según lo proporciona la API de Chat. Hay un límite de exportación de 500 espacios de Chat por solicitud.

SitesUrlInfo

Las URLs de los sitios publicados de la versión nueva de Google Sites que se buscarán

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

string

Es una lista de URLs de sitios publicados.

DriveDocumentInfo

Son los documentos de Drive que se buscarán.

Representación JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Campos
Es el formato para recuperar los documentos de Drive. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
documentIds

object (DriveDocumentIds)

Especifica los documentos de Drive por ID de documento.
Fin de los campos mutuamente excluyentes.

DriveDocumentIds

Especifica los documentos de Drive por ID de documento.

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

string

Obligatorio. Es una lista de IDs de documentos de Drive.

TeamDriveInfo

Unidades de equipo para buscar

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

string

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

MailOptions

Opciones adicionales para la búsqueda en Gmail

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

boolean

Establécelo como true para excluir los borradores.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Especifica si los resultados deben incluir contenido encriptado, contenido sin encriptar 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

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED No se especificó el estado de la encriptación. Los resultados incluyen contenido con y sin encriptación del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluir en los resultados el contenido con encriptación del cliente y el contenido sin encriptar
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluye solo contenido con encriptación del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Incluye solo contenido sin encriptar.

DriveOptions

Son opciones adicionales para la búsqueda en Drive.

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

string (Timestamp format)

Busca en 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 el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “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 de equipo.
includeSharedDrives
(deprecated)

boolean

Establécelo como true para incluir unidades compartidas.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Establece si los resultados incluyen solo contenido encriptado con la encriptación del cliente de Google Workspace, solo contenido sin encriptar o ambos. La configuración predeterminada es ambas. Actualmente, se admite para Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Opcional. Opciones para incluir o excluir documentos en unidades compartidas. Te recomendamos que uses este campo en lugar de includeSharedDrives. Este campo anula includeSharedDrives y includeTeamDrives cuando se establece.

SharedDrivesOption

Es la opción sobre el tipo de documentos de la unidad compartida que se incluirán.

Enums
SHARED_DRIVES_OPTION_UNSPECIFIED No se especificó ninguna opción de unidad compartida.
NOT_INCLUDED Si un recurso se encuentra en una unidad compartida, no se incluye en la búsqueda.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Los recursos de la unidad compartida solo se incluyen en los casos en los que la cuenta es colaboradora de un recurso, pero no es miembro de la unidad compartida. Esto se asigna a la opción "Los recursos se incluyen solo si los documentos se comparten directamente (no si la cuenta es miembro de la unidad compartida)" en la IU de Vault. (anteriormente, "includeSharedDrives" desactivado)
INCLUDED Los recursos de las unidades compartidas se incluyen en la búsqueda. (anteriormente, activar "includeSharedDrives")

HangoutsChatOptions

Opciones adicionales para la búsqueda de Google Chat

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

boolean

En el caso de las búsquedas por cuenta o unidad organizativa, establécelo en true para incluir 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

Coincide solo con los eventos cuya ubicación contiene todas las palabras del conjunto proporcionado. Si la cadena contiene frases entre comillas, este método solo busca coincidencias con los eventos cuya ubicación contenga la frase exacta. Las entradas del conjunto se consideran en "and".

Ejemplo de división de palabras: ["Nueva Zelanda"] frente a ["Nueva","Zelanda"] "Nueva Zelanda": coincide con ambas "Nueva y mejor Zelanda": solo coincide con la última
peopleQuery[]

string

Coincide solo con los eventos cuyos asistentes contengan todas las palabras del conjunto especificado. Las entradas del conjunto se consideran en "and".
minusWords[]

string

Coincide solo 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 "or".
responseStatuses[]

enum (AttendeeResponse)

Coincide solo 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 el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AttendeeResponse

Es la respuesta del usuario a una invitación.

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

GeminiOptions

Este tipo no tiene campos.

Opciones adicionales para la búsqueda en la app de Gemini

GeminiInWorkspaceOptions

Este tipo no tiene campos.

Opciones adicionales para la búsqueda de Gemini en Workspace