Query

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,

  // 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)
  }
  // End of list of possible types for union field corpus_options_field.
}
Campos
corpus

enum (CorpusType)

El servicio de Google Workspace para realizar búsquedas.
dataScope

enum (DataScope)

La fuente de datos en la que se buscará.
searchMethod
(deprecated)

enum (SearchMethod)

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

enum (SearchMethod)

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)

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Indica la hora de finalización de la búsqueda. Especifícalo en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Es 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, consulte el Centro de ayuda de Vault.
Campo de unión search_method_field. Cuando es necesario, los detalles de las entidades para buscar search_method_field pueden ser solo uno de los siguientes:
accountInfo

object (AccountInfo)

Es 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)

Es 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 las opciones específicas de búsqueda de Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Establece opciones específicas de 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 para la búsqueda de Calendario.

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 los datos están en espera.
UNPROCESSED_DATA Solo los datos que Vault aún no haya procesado. (Solo Gmail y Grupos)

SearchMethod

El tipo de entidad para la búsqueda.

Enumeraciones
SEARCH_METHOD_UNSPECIFIED Debes 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 de la unidad de equipo que se especifica en teamDriveInfo.
ENTIRE_ORG Buscar los datos de todas las cuentas de la organización Solo es compatible con Gmail. Cuando se especifique, no es necesario que especifiques AccountInfo ni OrgUnitInfo.
ROOM Busca mensajes en los espacios de Chat especificados en HangoutsChatInfo.
SITES_URL Busca sitios mediante las URL publicadas que se especifican en SitesUrlInfo.
SHARED_DRIVE Busca los archivos de las unidades compartidas que se especificaron en SharedDriveInfo.

AccountInfo

Las cuentas en las que se buscará

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

string

Es un conjunto de cuentas para buscar.

OrgUnitInfo

La unidad organizativa en la que se realizará la búsqueda

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 buscar

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

string

Una lista de los IDs de las unidades compartidas, tal como lo proporciona la API de Drive.

HangoutsChatInfo

Los espacios de Chat que quieres buscar

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

string

Una lista de IDs de espacios de Chat, como los 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 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 para realizar búsquedas

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

string

Lista de IDs de unidades de equipo, que 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 como true para excluir borradores.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Especifica si los resultados deben incluir contenido encriptado, contenido 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 con encriptación del cliente y no encriptado en los resultados.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluye solo contenido con encriptación del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Incluye solo 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.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

Se establece como verdadero para incluir la unidad de equipo.
includeSharedDrives

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 ambos. Actualmente 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 del 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 "New and Better Zealand": solo coincide con la siguiente
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

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 "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.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Respuesta del usuario a una invitación.

Enumeraciones
ATTENDEE_RESPONSE_UNSPECIFIED No se especificó la respuesta del asistente. Si esta opción está configurada, no se aplicará ningún filtro a las respuestas, por lo que se ignorarán todas las respuestas de los asistentes que formen parte de las opciones de consulta.
ATTENDEE_RESPONSE_NEEDS_ACTION Se invitó al participante, pero aún no ha respondido.
ATTENDEE_RESPONSE_ACCEPTED El participante planea asistir.
ATTENDEE_RESPONSE_DECLINED El participante no planea asistir.
ATTENDEE_RESPONSE_TENTATIVE El participante espera asistir.