Query

Définition de 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,

  // 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.
}
Champs
corpus

enum (CorpusType)

Service Google Workspace à rechercher.
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 a la valeur Team_Drive, la réponse de ce champ est SHARED_Drive.
terms

string

Opérateurs de recherche spécifiques au service pour filtrer les résultats de recherche
startTime

string (Timestamp format)

Heure de début de la requête de recherche. Indiquez l'heure GMT. La valeur est arrondie à minuit à la date spécifiée.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obligatoire lorsque la méthode SearchMethod est définie 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 la section Fuseau horaire. Pour en savoir plus sur la manière dont Vault utilise les fuseaux horaires, consultez le Centre d'aide Vault.
Champ d'union search_method_field. Lorsque cela est nécessaire, les détails des entités à rechercher dans search_method_field ne peuvent correspondre qu'à l'un des éléments suivants:
accountInfo

object (AccountInfo)

Obligatoire lorsque SearchMethod est défini sur ACCOUNT (COMPTE).
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 la propriété SearchMethod est définie sur ROOM. (lecture seule)
sitesUrlInfo

object (SitesUrlInfo)

Obligatoire lorsque SearchMethod a la valeur SITES_URL.
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éfinir 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 de recherche dans Agenda.

DataScope

Source des données dans lesquelles effectuer la recherche.

Enums
DATA_SCOPE_UNSPECIFIED Aucune source de données spécifiée.
ALL_DATA Toutes les données disponibles.
HELD_DATA Conservation uniquement sur les données.
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 Vous devez spécifier une méthode de recherche pour éviter tout refus.
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 des données dans tous les comptes de l'organisation. Compatible uniquement avec Gmail. Si vous spécifiez une valeur, 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 rechercher 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.

AccountInfo

Comptes dans lesquels effectuer des recherches

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

string

Ensemble de comptes à rechercher.

OrgUnitInfo

Unité organisationnelle dans laquelle effectuer la recherche

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

string

Nom de l'unité organisationnelle dans laquelle effectuer la recherche, tel que fourni par l'API Directory du SDK Admin.

SharedDriveInfo

Les Drive partagés dans lesquels effectuer des recherches

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

string

Une liste des ID de Drive partagés, fournie par l'API Drive.

HangoutsChatInfo

Espaces Chat dans lesquels effectuer des recherches

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

string

Liste des ID d'espaces Chat, tels que fournis par l'API Chat. Vous ne pouvez pas exporter plus de 500 espaces Chat par requête.

SitesUrlInfo

URL des sites publiés dans la nouvelle version de Google Sites dans lesquels effectuer des recherches

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

string

Liste des URL des sites publiés.

TeamDriveInfo

Drive d'équipe dans lesquels effectuer des recherches

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

string

Liste des ID de Drive d'équipe, telle que fournie 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é, du contenu 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 État du chiffrement non spécifié. Les résultats incluent à la fois du contenu chiffré côté client et du contenu non chiffré.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Inclure le contenu chiffré côté client et le contenu non chiffré dans les résultats.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Inclure le contenu chiffré côté client uniquement.
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)
}
Champs
versionDate

string (Timestamp format)

Recherchez la version actuelle du fichier Drive, mais exportez le contenu de la dernière version enregistrée avant minuit (UTC) à la date spécifiée. Saisissez la date au format UTC.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

Défini sur "true" pour inclure le Drive d'équipe.
includeSharedDrives

boolean

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

enum (ClientSideEncryptedOption)

Indiquez si les résultats doivent inclure uniquement du contenu chiffré avec le chiffrement côté client Google Workspace, uniquement du contenu non chiffré, ou les deux. La valeur par défaut est les deux. Actuellement compatible avec Drive.

HangoutsChatOptions

Autres options de recherche dans 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 salles.

VoiceOptions

Autres options pour la recherche vocale

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

enum (VoiceCoveredData)

Types de données à rechercher

CalendarOptions

Autres options de recherche dans 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 l'emplacement contient tous les mots de l'ensemble donné. Si la chaîne contient des expressions entre guillemets, cette méthode ne renvoie que les événements dont l'emplacement contient l'expression exacte. Les entrées de l'ensemble sont prises en compte dans "and".

Exemple de division des mots : ["Nouvelle-Zélande"] vs ["Nouvelle","Zélande"] "Nouvelle-Zélande" : correspondance avec "Nouvelle-Zélande" : correspondance uniquement avec "Nouvelle-Zélande" : correspondance
peopleQuery[]

string

Correspond aux événements dont les participants contiennent tous les mots de l'ensemble donné. Les entrées de l'ensemble sont prises en compte dans "and".
minusWords[]

string

Correspond aux événements qui ne contiennent aucun des mots de l'ensemble donné dans le titre, la description, le lieu ou les participants. Les entrées de l'ensemble sont considérées comme étant dans "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, les réponses ne seront pas filtrées.
versionDate

string (Timestamp format)

Recherchez la version actuelle de l'événement d'agenda, mais exportez le contenu de la dernière version enregistrée avant minuit (UTC) à la date spécifiée. Saisissez la date au format UTC.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Réponse de l'utilisateur à une invitation.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED Réponse des participants non spécifiée. Si cette option est définie, aucun filtrage des réponses n'est effectué. Toutes les autres réponses des participants qui font partie des options de requête sont 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'y assister.
ATTENDEE_RESPONSE_DECLINED Le participant ne prévoit pas d'y assister.
ATTENDEE_RESPONSE_TENTATIVE Le participant s'attend à y assister éventuellement.