- Représentation JSON
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
Définition de requête utilisée pour la recherche et l'exportation.
Représentation JSON |
---|
{ "corpus": enum ( |
Champs | |
---|---|
corpus |
Le service Google Workspace dans lequel effectuer la recherche. |
dataScope |
Source de données à rechercher. |
searchMethod |
Méthode de recherche à utiliser. |
method |
Entité à rechercher. Ce champ remplace searchMethod pour assurer la compatibilité avec les Drive partagés. Lorsque searchMethod est définie sur Team_DRIVE, la réponse de ce champ est SHARED_DRIVE. |
terms |
Opérateurs de recherche spécifiques au service pour filtrer les résultats de recherche. |
startTime |
Heure de début de la requête de recherche. À indiquer en GMT. La valeur est arrondie à minuit à la date spécifiée. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
endTime |
Heure de fin de la requête de recherche. À indiquer en GMT. La valeur est arrondie à minuit à la date spécifiée. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
teamDriveInfo |
Obligatoire lorsque SearchMethod est définie sur Team_DRIVE. |
timeZone |
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 plus d'informations 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 sur lesquelles rechercher search_method_field ne peuvent être que l'un des suivants: |
|
accountInfo |
Obligatoire lorsque SearchMethod est définie sur ACCOUNT. |
orgUnitInfo |
Obligatoire lorsque SearchMethod est définie sur ORG_UNIT. |
sharedDriveInfo |
Obligatoire lorsque SearchMethod est défini sur SHARED_DRIVE. |
hangoutsChatInfo |
Obligatoire lorsque SearchMethod est définie sur ROOM. (lecture seule) |
sitesUrlInfo |
Obligatoire lorsque SearchMethod est définie sur 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 |
Définissez les options spécifiques à la recherche Gmail. |
driveOptions |
Définissez les options spécifiques à la recherche Drive. |
hangoutsChatOptions |
Définissez les options spécifiques à la recherche Chat. (lecture seule) |
voiceOptions |
Définissez les options propres à la recherche vocale. |
calendarOptions |
Définissez les options de recherche dans Agenda. |
DataScope
Source de données à rechercher.
Enums | |
---|---|
DATA_SCOPE_UNSPECIFIED |
Aucune source de données spécifiée. |
ALL_DATA |
Toutes les données disponibles. |
HELD_DATA |
Uniquement les données sous obligation de conservation. |
UNPROCESSED_DATA |
Uniquement 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. Dans le cas contraire, elle sera refusée. |
ACCOUNT |
Recherchez les données des comptes spécifiés dans AccountInfo. |
ORG_UNIT |
Effectuez une recherche dans les données de tous les comptes de l'unité organisationnelle spécifiée dans OrgUnitInfo. |
TEAM_DRIVE |
rechercher les données du Drive d'équipe spécifié dans teamDriveInfo ; |
ENTIRE_ORG |
effectuer des recherches dans les données de tous les comptes de l'entreprise ; Compatible uniquement avec Gmail. Si vous spécifiez une valeur pour AccountInfo ou OrgUnitInfo, vous n'avez pas besoin de l'indiquer. |
ROOM |
Rechercher 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 des Drive partagés spécifiés dans SharedDriveInfo. |
AccountInfo
Les comptes dans lesquels effectuer la recherche
Représentation JSON |
---|
{ "emails": [ string ] } |
Champs | |
---|---|
emails[] |
Un ensemble de comptes dans lesquels effectuer des recherches. |
OrgUnitInfo
Unité organisationnelle dans laquelle effectuer la recherche
Représentation JSON |
---|
{ "orgUnitId": string } |
Champs | |
---|---|
orgUnitId |
Nom de l'unité organisationnelle à rechercher, tel que fourni par l'API Directory du SDK Admin. |
HangoutsChatInfo
Espaces Chat dans lesquels effectuer des recherches
Représentation JSON |
---|
{ "roomId": [ string ] } |
Champs | |
---|---|
roomId[] |
Une liste des ID d'espaces Chat fournie 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 sur lesquels effectuer des recherches
Représentation JSON |
---|
{ "urls": [ string ] } |
Champs | |
---|---|
urls[] |
Une liste des URL des sites publiés. |
TeamDriveInfo
Drive d'équipe dans lesquels effectuer des recherches
Représentation JSON |
---|
{ "teamDriveIds": [ string ] } |
Champs | |
---|---|
teamDriveIds[] |
Liste des ID de Drive d'équipe, fournie par l'API Drive. |
MailOptions
Options supplémentaires pour la recherche Gmail
Représentation JSON |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
Champs | |
---|---|
excludeDrafts |
Définissez la valeur sur true pour exclure les brouillons. |
clientSideEncryptedOption |
Indique si les résultats doivent inclure du contenu chiffré, du contenu non chiffré ou les deux. La valeur par défaut inclut les deux. |
ClientSideEncryptedOption
Si votre organisation utilise le chiffrement côté client Google Workspace, l'état de chiffrement du contenu
Enums | |
---|---|
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED |
État de chiffrement non spécifié. Les résultats incluent à la fois du contenu chiffré côté client et non chiffré. |
CLIENT_SIDE_ENCRYPTED_OPTION_ANY |
Inclure le contenu chiffré côté client et non chiffré dans les résultats |
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED |
N'incluez que le contenu chiffré côté client. |
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED |
Inclure uniquement le contenu non chiffré. |
DriveOptions
Options supplémentaires pour la recherche Drive
Représentation JSON |
---|
{
"versionDate": string,
"includeTeamDrives": boolean,
"includeSharedDrives": boolean,
"clientSideEncryptedOption": enum ( |
Champs | |
---|---|
versionDate |
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. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
includeTeamDrives |
Définissez la valeur sur "true" pour inclure le Drive d'équipe. |
includeSharedDrives |
Définissez la valeur sur true pour inclure les Drive partagés. |
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. Les deux valeurs par défaut sont les deux. Actuellement compatible avec Drive. |
HangoutsChatOptions
Options supplémentaires pour la recherche dans Google Chat
Représentation JSON |
---|
{ "includeRooms": boolean } |
Champs | |
---|---|
includeRooms |
Pour les recherches par compte ou unité organisationnelle, définissez la valeur sur true pour inclure les salles. |
VoiceOptions
Options supplémentaires pour la recherche vocale
Représentation JSON |
---|
{
"coveredData": [
enum ( |
Champs | |
---|---|
coveredData[] |
Types de données à rechercher |
CalendarOptions
Options supplémentaires pour la recherche dans Agenda
Représentation JSON |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
Champs | |
---|---|
locationQuery[] |
Ne renvoie que les é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 recherche que les événements dont l'emplacement contient l'expression exacte. Les entrées de l'ensemble sont prises en compte dans "et". Exemple de division des mots: ["Nouvelle-Zélande"] vs ["New","Zealand"] "Nouvelle-Zélande": correspondance avec "Nouvelle-Zélande et meilleure-Zélande": correspondance uniquement avec le plus tardif |
peopleQuery[] |
Recherche une correspondance uniquement avec les événements dont les participants contiennent tous les mots de l'ensemble donné. Les entrées de l'ensemble sont prises en compte dans "et". |
minusWords[] |
Renvoie uniquement les é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 prises en compte dans l'opérateur "or". |
responseStatuses[] |
Ne recherche que les événements pour lesquels le dépositaire a donné l'une de ces réponses. Si cet ensemble est vide ou contient la valeur ATTENDEE_ANSWER_UNSPECIFIED, les réponses ne seront pas filtrées. |
versionDate |
Rechercher la version actuelle de l'événement d'agenda, mais exporter le contenu de la dernière version enregistrée avant minuit (UTC) à la date spécifiée. Saisissez la date au format UTC. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
AttendeeResponse
Réponse de l'utilisateur à une invitation.
Enums | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
Réponse du participant non spécifiée. Si cette option est configurée, aucun filtrage des réponses n'est effectué, et toutes les autres réponses des participants incluses dans les 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 n'a pas l'intention d'y assister. |
ATTENDEE_RESPONSE_TENTATIVE |
Le participant s'attend à y assister. |