Query

Définition de la requête utilisée pour la recherche et l'exportation.

Représentation 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)
  }
}
Champs
corpus

enum (CorpusType)

Service Google Workspace dans lequel effectuer la recherche.
dataScope

enum (DataScope)

Source de données dans laquelle effectuer la recherche.
searchMethod
(deprecated)

enum (SearchMethod)

Méthode de recherche à utiliser.
method

enum (SearchMethod)

Entité à rechercher. Ce champ remplace searchMethod pour prendre en charge les Drive partagés. Lorsque searchMethod est défini sur TEAM_DRIVE, la réponse de ce champ est SHARED_DRIVE.
terms

string

Des opérateurs de recherche spécifiques aux services pour filtrer les résultats de recherche.
startTime

string (Timestamp format)

Heure de début de la requête de recherche. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de la requête de recherche. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obligatoire lorsque SearchMethod est défini sur TEAM_DRIVE.
timeZone

string

Nom du fuseau horaire. Il doit s'agir d'un nom TZ IANA, tel que "America/Los_Angeles". Pour obtenir la liste des noms de fuseaux horaires, consultez Fuseau horaire. Pour en savoir plus sur la façon dont Vault utilise les fuseaux horaires, consultez le Centre d'aide Vault.
Champ d'union search_method_field. Le cas échéant, les détails des entités à rechercher search_method_field ne peuvent être que l'un des suivants :
accountInfo

object (AccountInfo)

Obligatoire lorsque SearchMethod est défini sur ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Obligatoire lorsque SearchMethod est défini sur ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Obligatoire lorsque SearchMethod est défini sur SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Obligatoire lorsque SearchMethod est défini sur ROOM. (lecture seule)
sitesUrlInfo

object (SitesUrlInfo)

Obligatoire lorsque SearchMethod est défini sur SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Obligatoire lorsque SearchMethod est défini sur DRIVE_DOCUMENT.
Champ d'union corpus_options_field. Options de recherche supplémentaires pour des services spécifiques. corpus_options_field ne peut être qu'un des éléments suivants :
mailOptions

object (MailOptions)

Définissez des options spécifiques à la recherche Gmail.
driveOptions

object (DriveOptions)

Définissez des options spécifiques à la recherche Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Définissez des options spécifiques à la recherche dans Chat. (lecture seule)
voiceOptions

object (VoiceOptions)

Définissez des options spécifiques à la recherche vocale.
calendarOptions

object (CalendarOptions)

Définissez les options spécifiques à la recherche dans Agenda.
geminiOptions

object (GeminiOptions)

Définissez des options spécifiques à la recherche Gemini.

DataScope

Source de données dans laquelle effectuer la recherche.

Enums
DATA_SCOPE_UNSPECIFIED Aucune source de données spécifiée.
ALL_DATA Toutes les données disponibles.
HELD_DATA Données conservées uniquement.
UNPROCESSED_DATA Seules les données qui n'ont pas encore été traitées par Vault. (Gmail et Groupes uniquement)

SearchMethod

Type d'entité pour la recherche.

Enums
SEARCH_METHOD_UNSPECIFIED Une méthode de recherche doit être spécifiée, sinon elle est refusée.
ACCOUNT Recherchez les données des comptes spécifiés dans AccountInfo.
ORG_UNIT Recherchez les données de tous les comptes de l'unité organisationnelle spécifiée dans OrgUnitInfo.
TEAM_DRIVE

Recherchez les données dans le Drive d'équipe spécifié dans teamDriveInfo.
ENTIRE_ORG Recherchez dans les données de tous les comptes de l'organisation. Disponible uniquement pour Gmail. Si vous le spécifiez, vous n'avez pas besoin de spécifier AccountInfo ni OrgUnitInfo.
ROOM Recherchez des messages dans les espaces Chat spécifiés dans HangoutsChatInfo.
SITES_URL Recherchez des sites en fonction des URL publiées spécifiées dans SitesUrlInfo.
SHARED_DRIVE Recherchez les fichiers dans les Drive partagés spécifiés dans SharedDriveInfo.
DRIVE_DOCUMENT Récupérez les documents spécifiés dans DriveDocumentInfo.

AccountInfo

Comptes à rechercher

Représentation JSON 
{
  "emails": [
    string
  ]
}
Champs
emails[]

string

Ensemble de comptes à rechercher.

OrgUnitInfo

Unité organisationnelle à rechercher

Représentation JSON 
{
  "orgUnitId": string
}
Champs
orgUnitId

string

Nom de l'unité organisationnelle à rechercher, tel qu'indiqué par l'API Directory du SDK Admin.

SharedDriveInfo

Les Drive partagés dans lesquels effectuer la recherche

Représentation JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Champs
sharedDriveIds[]

string

Liste des ID de Drive partagés, tels que fournis par l'API Drive.

HangoutsChatInfo

Espaces Chat dans lesquels effectuer la recherche

Représentation JSON 
{
  "roomId": [
    string
  ]
}
Champs
roomId[]

string

Liste des ID d'espaces Chat, tels que fournis par l'API Chat. Vous pouvez exporter les données de 500 espaces de discussion maximum par requête.

SitesUrlInfo

URL publiées des nouvelles versions de Google Sites à rechercher

Représentation JSON 
{
  "urls": [
    string
  ]
}
Champs
urls[]

string

Liste des URL publiées des sites.

DriveDocumentInfo

Documents Drive à rechercher.

Représentation JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Champs
Champ d'union identifier. Format dans lequel récupérer les documents Drive. identifier ne peut être qu'un des éléments suivants :
documentIds

object (DriveDocumentIds)

Spécifiez les documents Drive par ID de document.

DriveDocumentIds

Spécifiez les documents Drive par ID de document.

Représentation JSON 
{
  "ids": [
    string
  ]
}
Champs
ids[]

string

Obligatoire. Liste des ID de document Drive.

TeamDriveInfo

Drive d'équipe dans lesquels effectuer la recherche

Représentation JSON 
{
  "teamDriveIds": [
    string
  ]
}
Champs
teamDriveIds[]
(deprecated)

string

Liste des ID de Drive en équipe, tels que fournis par l'API Drive.

MailOptions

Options supplémentaires pour la recherche Gmail

Représentation JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Champs
excludeDrafts

boolean

Définissez la valeur sur true pour exclure les brouillons.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Indique si les résultats doivent inclure du contenu chiffré, non chiffré ou les deux. Par défaut, les deux sont inclus.

ClientSideEncryptedOption

Si votre organisation utilise le chiffrement côté client Google Workspace, l'état du chiffrement du contenu

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED L'état du chiffrement n'est pas spécifié. Les résultats incluent du contenu chiffré et non chiffré côté client.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluez dans les résultats le contenu chiffré côté client et le contenu non chiffré.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluez uniquement le contenu chiffré côté client.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Incluez uniquement du contenu non chiffré.

DriveOptions

Options supplémentaires pour la recherche Drive.

Représentation JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
Champs
versionDate

string (Timestamp format)

rechercher la version actuelle du fichier Drive, mais exporter le contenu de la dernière version enregistrée avant 00h00 UTC à la date spécifiée. Saisissez la date en UTC.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Définissez la valeur sur "true" pour inclure le Drive d'équipe.
includeSharedDrives
(deprecated)

boolean

Définissez la valeur sur true pour inclure les Drive partagés.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Indiquez si les résultats doivent inclure uniquement le contenu chiffré avec le chiffrement côté client Google Workspace, uniquement le contenu non chiffré ou les deux. La valeur par défaut est "both" (les deux). Actuellement disponible pour Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Facultatif. Options permettant d'inclure ou d'exclure des documents dans les Drive partagés. Nous vous recommandons d'utiliser ce champ plutôt qu'includeSharedDrives. Ce champ remplace includeSharedDrives et includeTeamDrives lorsqu'il est défini.

SharedDrivesOption

Option sur le type de documents Drive partagé à inclure.

Enums
SHARED_DRIVES_OPTION_UNSPECIFIED Aucune option de Drive partagé n'a été spécifiée.
NOT_INCLUDED Si les ressources se trouvent dans un Drive partagé, elles ne sont pas incluses dans la recherche.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Les ressources des Drive partagés ne sont incluses que lorsque le compte est collaborateur sur une ressource, mais qu'il n'est pas membre du Drive partagé. Cela correspond à l'option Inclus uniquement si les documents sont partagés directement (et non en raison de l'appartenance à un Drive partagé) dans l'interface utilisateur Vault. (auparavant, "includeSharedDrives" était désactivé)
INCLUDED Les ressources des Drive partagés sont incluses dans la recherche. (auparavant "includeSharedDrives")

HangoutsChatOptions

Options supplémentaires pour la recherche Google Chat

Représentation JSON 
{
  "includeRooms": boolean
}
Champs
includeRooms

boolean

Pour les recherches par compte ou unité organisationnelle, définissez la valeur sur true pour inclure les salons.

VoiceOptions

Options supplémentaires pour la recherche vocale

Représentation JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Champs
coveredData[]

enum (VoiceCoveredData)

Types de données à rechercher

CalendarOptions

Options supplémentaires pour la recherche dans l'Agenda

Représentation JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Champs
locationQuery[]

string

Ne correspond qu'aux événements dont le lieu contient tous les mots de l'ensemble donné. Si la chaîne contient des expressions entre guillemets, cette méthode ne correspond qu'aux événements dont le lieu contient l'expression exacte. Les entrées de l'ensemble sont considérées comme "et".

Exemple de fractionnement de mots : ["Nouvelle-Zélande"] vs ["Nouvelle","Zélande"] "Nouvelle-Zélande" : correspond à "Nouvelle-Zélande" et à "Nouvelle et meilleure Zélande" "Nouvelle et meilleure Zélande" : ne correspond qu'à "Nouvelle et meilleure Zélande"
peopleQuery[]

string

Ne correspond qu'aux événements dont les participants contiennent tous les mots de l'ensemble donné. Les entrées de l'ensemble sont considérées comme "et".
minusWords[]

string

Ne correspond qu'aux événements dont le titre, la description, le lieu ou les participants ne contiennent aucun des mots de l'ensemble donné. Les entrées de l'ensemble sont considérées comme des "ou".
responseStatuses[]

enum (AttendeeResponse)

Affiche uniquement les événements pour lesquels le responsable a donné l'une de ces réponses. Si l'ensemble est vide ou contient ATTENDEE_RESPONSE_UNSPECIFIED, aucune réponse ne sera filtrée.
versionDate

string (Timestamp format)

Rechercher la version actuelle de l'événement d'agenda, mais exporter le contenu de la dernière version enregistrée avant 00h00 UTC à la date spécifiée. Saisissez la date en UTC.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AttendeeResponse

Réponse de l'utilisateur à une invitation.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED La réponse du participant n'est pas spécifiée. Si cette option est définie, aucun filtrage des réponses ne sera effectué. Toutes les autres réponses des participants qui font partie des options de requête seront ignorées.
ATTENDEE_RESPONSE_NEEDS_ACTION Le participant a été invité, mais n'a pas encore répondu.
ATTENDEE_RESPONSE_ACCEPTED Le participant prévoit d'être présent.
ATTENDEE_RESPONSE_DECLINED Le participant ne prévoit pas d'y assister.
ATTENDEE_RESPONSE_TENTATIVE Le participant prévoit d'assister à l'événement.

GeminiOptions

Ce type ne comporte aucun champ.

Options supplémentaires pour la recherche Gemini