Query

La definizione della query utilizzata per la ricerca e l'esportazione.

Rappresentazione 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)
  }
}
Campi
corpus

enum (CorpusType)

Il servizio Google Workspace in cui eseguire la ricerca.
dataScope

enum (DataScope)

L'origine dati in cui effettuare la ricerca.
searchMethod
(deprecated)

enum (SearchMethod)

Il metodo di ricerca da utilizzare.
method

enum (SearchMethod)

L'entità da cercare. Questo campo sostituisce searchMethod per supportare i Drive condivisi. Quando searchMethod è TEAM_DRIVE, la risposta di questo campo è SHARED_DRIVE.
terms

string

Operatori di ricerca specifici per il servizio per filtrare i risultati di ricerca.
startTime

string (Timestamp format)

L'ora di inizio della query di ricerca. Specifica in GMT. Il valore viene arrotondato alle ore 00:00 della data specificata.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

L'ora di fine della query di ricerca. Specifica in GMT. Il valore viene arrotondato alle ore 00:00 della data specificata.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obbligatorio quando SearchMethod è TEAM_DRIVE.
timeZone

string

Il nome del fuso orario. Deve essere un nome TZ IANA, ad esempio "America/Los_Angeles". Per un elenco dei nomi dei fusi orari, consulta Fuso orario. Per ulteriori informazioni su come Vault utilizza i fusi orari, consulta il Centro assistenza Vault.
Campo unione search_method_field. Se necessario, i dettagli delle entità da cercare search_method_field possono essere solo uno dei seguenti:
accountInfo

object (AccountInfo)

Obbligatorio quando SearchMethod è ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Obbligatorio quando SearchMethod è ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Obbligatorio quando SearchMethod è SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Obbligatorio quando SearchMethod è ROOM. (sola lettura)
sitesUrlInfo

object (SitesUrlInfo)

Obbligatorio quando SearchMethod è SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Obbligatorio quando SearchMethod è DRIVE_DOCUMENT.
Campo unione corpus_options_field. Opzioni di ricerca aggiuntive per servizi specifici. corpus_options_field può essere solo uno dei seguenti tipi:
mailOptions

object (MailOptions)

Imposta le opzioni specifiche per la ricerca in Gmail.
driveOptions

object (DriveOptions)

Imposta opzioni specifiche per la ricerca di Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Imposta opzioni specifiche per la ricerca di Chat. (sola lettura)
voiceOptions

object (VoiceOptions)

Imposta le opzioni specifiche della ricerca vocale.
calendarOptions

object (CalendarOptions)

Imposta le opzioni specifiche per la ricerca in Calendar.
geminiOptions

object (GeminiOptions)

Imposta le opzioni specifiche per la ricerca di Gemini.

DataScope

L'origine dei dati da cercare.

Enum
DATA_SCOPE_UNSPECIFIED Nessuna origine dati specificata.
ALL_DATA Tutti i dati disponibili.
HELD_DATA Solo i dati sottoposti a blocco.
UNPROCESSED_DATA Solo i dati non ancora elaborati da Vault. (Solo Gmail e Gruppi)

SearchMethod

Il tipo di entità per la ricerca.

Enum
SEARCH_METHOD_UNSPECIFIED È necessario specificare un metodo di ricerca, altrimenti la richiesta viene rifiutata.
ACCOUNT Cerca i dati degli account specificati in AccountInfo.
ORG_UNIT Cerca nei dati di tutti gli account dell'unità organizzativa specificata in OrgUnitInfo.
TEAM_DRIVE

Cerca i dati nel Drive del team specificato in teamDriveInfo.
ENTIRE_ORG Cerca nei dati di tutti gli account dell'organizzazione. Supportato solo per Gmail. Se specificato, non è necessario specificare AccountInfo o OrgUnitInfo.
ROOM Cerca i messaggi negli spazi di Chat specificati in HangoutsChatInfo.
SITES_URL Cerca i siti in base agli URL pubblicati specificati in SitesUrlInfo.
SHARED_DRIVE Cerca i file nei Drive condivisi specificati in SharedDriveInfo.
DRIVE_DOCUMENT Recupera i documenti specificati in DriveDocumentInfo.

AccountInfo

Gli account in cui eseguire la ricerca

Rappresentazione JSON 
{
  "emails": [
    string
  ]
}
Campi
emails[]

string

Un insieme di account in cui eseguire la ricerca.

OrgUnitInfo

L'unità organizzativa da cercare

Rappresentazione JSON 
{
  "orgUnitId": string
}
Campi
orgUnitId

string

Il nome dell'unità organizzativa da cercare, come fornito dall'API Directory dell'SDK Admin.

SharedDriveInfo

I Drive condivisi in cui eseguire la ricerca

Rappresentazione JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Campi
sharedDriveIds[]

string

Un elenco di ID Drive condivisi, fornito dall'API Drive.

HangoutsChatInfo

Gli spazi di Chat in cui eseguire la ricerca

Rappresentazione JSON 
{
  "roomId": [
    string
  ]
}
Campi
roomId[]

string

Un elenco di ID spazi di Chat, fornito dall'API Chat. Esiste un limite di esportazione di 500 spazi di Chat per richiesta.

SitesUrlInfo

Gli URL pubblicati dei siti della nuova versione di Google Sites da cercare

Rappresentazione JSON 
{
  "urls": [
    string
  ]
}
Campi
urls[]

string

Un elenco di URL pubblicati dei siti.

DriveDocumentInfo

I documenti di Drive da cercare.

Rappresentazione JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Campi
Campo unione identifier. Il formato per recuperare i documenti di Drive. identifier può essere solo uno dei seguenti tipi:
documentIds

object (DriveDocumentIds)

Specifica i documenti di Drive in base all'ID documento.

DriveDocumentIds

Specifica i documenti di Drive in base all'ID documento.

Rappresentazione JSON 
{
  "ids": [
    string
  ]
}
Campi
ids[]

string

Obbligatorio. Un elenco di ID documento di Drive.

TeamDriveInfo

Drive del team in cui eseguire la ricerca

Rappresentazione JSON 
{
  "teamDriveIds": [
    string
  ]
}
Campi
teamDriveIds[]
(deprecated)

string

Elenco degli ID dei team drive, fornito dall'API Drive.

MailOptions

Opzioni aggiuntive per la ricerca in Gmail

Rappresentazione JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campi
excludeDrafts

boolean

Imposta il valore true per escludere le bozze.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Specifica se i risultati devono includere contenuti criptati, non criptati o entrambi. Per impostazione predefinita, sono inclusi entrambi.

ClientSideEncryptedOption

Se la tua organizzazione utilizza la crittografia lato client di Google Workspace, lo stato di crittografia dei contenuti

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Stato della crittografia non specificato. I risultati includono contenuti criptati e non criptati lato client.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Includi nei risultati sia i contenuti con crittografia lato client sia quelli non criptati.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Includi solo contenuti con crittografia lato client.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Includi solo contenuti non criptati.

DriveOptions

Opzioni aggiuntive per la ricerca in Drive.

Rappresentazione JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
Campi
versionDate

string (Timestamp format)

Cerca la versione corrente del file di Drive, ma esporta i contenuti dell'ultima versione salvata prima delle ore 00:00 UTC della data specificata. Inserisci la data in UTC.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Imposta su true per includere il Drive del team.
includeSharedDrives
(deprecated)

boolean

Imposta il valore su true per includere i Drive condivisi.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Imposta se i risultati includono solo contenuti criptati con la crittografia lato client di Google Workspace, solo contenuti non criptati o entrambi. Il valore predefinito è entrambi. Attualmente supportato per Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Facoltativo. Opzioni per includere o escludere i documenti nei Drive condivisi. Ti consigliamo di utilizzare questo campo anziché includeSharedDrives. Se impostato, questo campo sostituisce includeSharedDrives e includeTeamDrives.

SharedDrivesOption

Opzione sul tipo di documenti del Drive condiviso da includere.

Enum
SHARED_DRIVES_OPTION_UNSPECIFIED Nessuna opzione di Drive condiviso specificata.
NOT_INCLUDED Se una risorsa si trova in un Drive condiviso, non viene inclusa nella ricerca.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Le risorse del Drive condiviso sono incluse solo nei casi in cui l'account è un collaboratore di una risorsa, ma non è membro del Drive condiviso. Questa opzione corrisponde all'opzione "Incluso solo se i documenti sono condivisi direttamente (non perché l'account è membro del Drive condiviso)" nell'interfaccia utente di Vault. (in precedenza "includeSharedDrives" disattivato)
INCLUDED Le risorse nei Drive condivisi sono incluse nella ricerca. (in precedenza "includeSharedDrives" su)

HangoutsChatOptions

Opzioni aggiuntive per la ricerca di Google Chat

Rappresentazione JSON 
{
  "includeRooms": boolean
}
Campi
includeRooms

boolean

Per le ricerche per account o unità organizzativa, imposta il valore su true per includere le stanze virtuali.

VoiceOptions

Opzioni aggiuntive per la ricerca vocale

Rappresentazione JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campi
coveredData[]

enum (VoiceCoveredData)

Tipi di dati da cercare

CalendarOptions

Opzioni aggiuntive per la ricerca di Calendar

Rappresentazione JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Campi
locationQuery[]

string

Corrisponde solo agli eventi la cui posizione contiene tutte le parole del set specificato. Se la stringa contiene frasi tra virgolette, questo metodo corrisponde solo agli eventi la cui posizione contiene la frase esatta. Le voci nel set vengono considerate in "e".

Esempio di divisione delle parole: ["New Zealand"] e ["New","Zealand"] "New Zealand": corrisponde a "New and better Zealand" e "New Zealand". "New and better Zealand": corrisponde solo a "New and better Zealand".
peopleQuery[]

string

Corrisponde solo agli eventi i cui partecipanti contengono tutte le parole nel set specificato. Le voci nel set vengono considerate in "e".
minusWords[]

string

Corrisponde solo agli eventi che non contengono nessuna delle parole nel set specificato nel titolo, nella descrizione, nel luogo o nei partecipanti. Le voci nel set vengono considerate in "or".
responseStatuses[]

enum (AttendeeResponse)

Restituisce solo gli eventi per cui il custode ha dato una di queste risposte. Se il set è vuoto o contiene ATTENDEE_RESPONSE_UNSPECIFIED, non verrà applicato alcun filtro alle risposte.
versionDate

string (Timestamp format)

Cerca la versione corrente dell'evento di Calendar, ma esporta i contenuti dell'ultima versione salvata prima delle ore 00:00 UTC della data specificata. Inserisci la data in UTC.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AttendeeResponse

Risposta dell'utente a un invito.

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Risposta del partecipante non specificata. Se questa opzione è impostata, non verrà applicato alcun filtro alle risposte e tutte le altre risposte dei partecipanti che fanno parte delle opzioni di query verranno ignorate.
ATTENDEE_RESPONSE_NEEDS_ACTION Il partecipante è stato invitato, ma non ha ancora risposto.
ATTENDEE_RESPONSE_ACCEPTED Il partecipante prevede di partecipare.
ATTENDEE_RESPONSE_DECLINED Il partecipante non prevede di partecipare.
ATTENDEE_RESPONSE_TENTATIVE Il partecipante prevede di partecipare.

GeminiOptions

Questo tipo non contiene campi.

Opzioni aggiuntive per la ricerca di Gemini