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,

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

enum (CorpusType)

Servicio de Google Workspace en el que se realizará la búsqueda.
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 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)

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 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.
Campo de unión search_method_field. Cuando sea necesario, los detalles de las entidades para buscar search_method_field solo pueden ser uno de los siguientes:
accountInfo

object (AccountInfo)

Se requiere 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)

Se requiere cuando SearchMethod es ROOM. (solo lectura)
sitesUrlInfo

object (SitesUrlInfo)

Se requiere cuando SearchMethod es SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Obligatorio cuando SearchMethod es DRIVE_DOCUMENT.
Campo de unión corpus_options_field. Opciones de búsqueda adicionales para servicios específicos corpus_options_field puede ser solo uno de los parámetros siguientes:
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 la búsqueda en Chat. (solo lectura)
voiceOptions

object (VoiceOptions)

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

object (CalendarOptions)

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

object (GeminiOptions)

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

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 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 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 Buscar 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 que especifiques 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.
DRIVE_DOCUMENT Recupera los documentos especificados en DriveDocumentInfo.

AccountInfo

Cuentas que se buscarán

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

string

Es un conjunto de cuentas en las que se realizará la búsqueda.

OrgUnitInfo

Unidad organizativa en la que se realizará la búsqueda

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

string

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

SharedDriveInfo

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 proporciona la API de Drive.

HangoutsChatInfo

Los espacios de Chat en los que se realizará la búsqueda

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 publicadas de los nuevos sitios 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 en los que se realizará la búsqueda.

Representación JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Campos
Campo de unión identifier. Es el formato para recuperar los documentos de Drive. identifier puede ser solo uno de los parámetros siguientes:
documentIds

object (DriveDocumentIds)

Especifica documentos de Drive por ID de documento.

DriveDocumentIds

Especifica 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 en las que se realizará la búsqueda

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

string

Es la lista de IDs de unidades de equipo, tal como la 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

Se configura 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 encriptación. Los resultados incluyen contenido encriptado del cliente y contenido sin encriptar.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluye contenido encriptado y sin encriptar del cliente en los resultados.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluye solo el contenido encriptado del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Solo se debe incluir 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)

Buscar la versión actual del archivo de Drive, pero exportar 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 compartida.
includeSharedDrives
(deprecated)

boolean

Se debe establecer en true para incluir las 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 ambos. Actualmente, se admite en Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Opcional. Opciones para incluir o excluir documentos en unidades compartidas Te recomendamos que uses este campo en lugar de includeSharedDrives. Cuando se configura este campo, se anulan includeSharedDrives y includeTeamDrives.

SharedDrivesOption

Es una 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, "includeSharedDrives" estaba activado)

HangoutsChatOptions

Opciones adicionales para la búsqueda en Google Chat

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

boolean

En el caso de las búsquedas por cuenta o unidad organizativa, se debe establecer en verdadero 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 los eventos cuya ubicación contiene la frase exacta. Las entradas del conjunto se consideran en "y".

Ejemplo de división de palabras: ["Nueva Zelanda"] vs. ["Nueva","Zelanda"] "Nueva Zelanda": Coincide con "Nueva y mejor Zelanda": Solo coincide con la última
peopleQuery[]

string

Solo coincide con los eventos cuyos asistentes contienen 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 dio una de estas respuestas. Si el conjunto está vacío o contiene ATTENDEE_RESPONSE_UNSPECIFIED, no se aplicará ningún filtro a las respuestas.
versionDate

string (Timestamp format)

Buscar la versión actual del evento de calendario, pero exportar 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 configura, no se filtrarán las respuestas y se ignorarán todas las demás respuestas de los asistentes que formen parte de las opciones de la 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 poder asistir.

GeminiOptions

Este tipo no tiene campos.

Opciones adicionales para la búsqueda en Gemini