Query

Die Abfragedefinition, die für die Suche und den Export verwendet wird.

JSON-Darstellung 
{
  "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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Felder
corpus

enum (CorpusType)

Der Google Workspace-Dienst, in dem gesucht werden soll.
dataScope

enum (DataScope)

Die Datenquelle, in der gesucht werden soll.
searchMethod
(deprecated)

enum (SearchMethod)

Die zu verwendende Suchmethode.
method

enum (SearchMethod)

Die zu suchende Entität. Dieses Feld ersetzt searchMethod und unterstützt geteilte Ablagen. Wenn searchMethod TEAM_DRIVE ist, lautet die Antwort dieses Felds SHARED_DRIVE.
terms

string

Dienstspezifische Suchoperatoren zum Filtern von Suchergebnissen.
startTime

string (Timestamp format)

Der Beginn der Suchanfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Die Endzeit der Suchanfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Erforderlich, wenn SearchMethod TEAM_DRIVE ist.
timeZone

string

Der Zeitzonenname. Dieser sollte ein IANA-TZ-Name sein, beispielsweise „America/Los_Angeles“. Eine Liste der Zeitzonennamen finden Sie unter Zeitzone. Weitere Informationen dazu, wie Zeitzonen in Vault verwendet werden, finden Sie in der Vault-Hilfe.
Union-Feld search_method_field. Bei Bedarf kann für die Details der Entitäten, nach denen in search_method_field gesucht werden soll, nur einer der folgenden Werte verwendet werden:
accountInfo

object (AccountInfo)

Erforderlich, wenn SearchMethod ACCOUNT ist.
orgUnitInfo

object (OrgUnitInfo)

Erforderlich, wenn SearchMethod ORG_UNIT ist.
sharedDriveInfo

object (SharedDriveInfo)

Erforderlich, wenn Suchmethode SHARED_DRIVE ist.
hangoutsChatInfo

object (HangoutsChatInfo)

Erforderlich, wenn SearchMethod ROOM ist. (schreibgeschützt)
sitesUrlInfo

object (SitesUrlInfo)

Erforderlich, wenn SearchMethod SITES_URL ist.
Union-Feld corpus_options_field. Zusätzliche Suchoptionen für bestimmte Dienste. Für corpus_options_field ist nur einer der folgenden Werte zulässig:
mailOptions

object (MailOptions)

Legen Sie Optionen für die Gmail-Suche fest.
driveOptions

object (DriveOptions)

Optionen für die Google Drive-Suche festlegen
hangoutsChatOptions

object (HangoutsChatOptions)

Legen Sie Optionen für die Chatsuche fest. (schreibgeschützt)
voiceOptions

object (VoiceOptions)

Sprachsuchspezifische Optionen festlegen
calendarOptions

object (CalendarOptions)

Legen Sie Optionen für die Kalendersuche fest.
geminiOptions

object (GeminiOptions)

Gemini-spezifische Suchoptionen festlegen

DataScope

Die Datenquelle, in der gesucht werden soll.

Enums
DATA_SCOPE_UNSPECIFIED Es wurde keine Datenquelle angegeben.
ALL_DATA Alle verfügbaren Daten.
HELD_DATA Nur Daten mit einem Hold.
UNPROCESSED_DATA Nur Daten, die noch nicht von Vault verarbeitet wurden. (Nur Gmail und Groups)

SearchMethod

Der Entitätstyp für die Suche.

Enums
SEARCH_METHOD_UNSPECIFIED Es muss eine Suchmethode angegeben werden, andernfalls wird die Anfrage abgelehnt.
ACCOUNT In den Daten der in AccountInfo angegebenen Konten suchen.
ORG_UNIT Es wird in den Daten aller Konten in der in OrgUnitInfo angegebenen Organisationseinheit gesucht.
TEAM_DRIVE

In den Daten in der in teamDriveInfo angegebenen Teamablage suchen
ENTIRE_ORG In den Daten aller Konten in der Organisation suchen Nur für Gmail unterstützt. Wenn Sie diese Angabe machen, müssen Sie AccountInfo oder OrgUnitInfo nicht angeben.
ROOM In den in HangoutsChatInfo angegebenen Google Chat-Gruppenbereichen nach Nachrichten suchen
SITES_URL Suchen Sie nach Websites anhand der in SitesUrlInfo angegebenen veröffentlichten Website-URLs.
SHARED_DRIVE In den in SharedDriveInfo angegebenen geteilten Ablagen nach Dateien suchen

AccountInfo

Die Konten, in denen gesucht werden soll

JSON-Darstellung 
{
  "emails": [
    string
  ]
}
Felder
emails[]

string

Eine Reihe von Konten, in denen gesucht werden soll.

OrgUnitInfo

Die zu durchsuchende Organisationseinheit

JSON-Darstellung 
{
  "orgUnitId": string
}
Felder
orgUnitId

string

Der Name der zu durchsuchenden Organisationseinheit, wie von der Admin SDK Directory API angegeben.

SharedDriveInfo

Die geteilten Ablagen, in denen gesucht werden soll

JSON-Darstellung 
{
  "sharedDriveIds": [
    string
  ]
}
Felder
sharedDriveIds[]

string

Eine Liste der IDs der geteilten Ablagen, wie sie von der Drive API bereitgestellt werden.

HangoutsChatInfo

Die zu durchsuchenden Chatbereiche

JSON-Darstellung 
{
  "roomId": [
    string
  ]
}
Felder
roomId[]

string

Eine Liste der Chatbereichs-IDs, die von der Chat API bereitgestellt wird. Pro Anfrage können maximal 500 Chatbereiche exportiert werden.

SitesUrlInfo

Die veröffentlichten Website-URLs der neuen Google Sites, nach denen gesucht werden soll

JSON-Darstellung 
{
  "urls": [
    string
  ]
}
Felder
urls[]

string

Eine Liste der URLs der veröffentlichten Website.

TeamDriveInfo

Zu durchsuchende Teamablagen

JSON-Darstellung 
{
  "teamDriveIds": [
    string
  ]
}
Felder
teamDriveIds[]
(deprecated)

string

Liste der Team Drive-IDs, wie von der Drive API bereitgestellt.

MailOptions

Zusätzliche Optionen für die Gmail-Suche

JSON-Darstellung 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Felder
excludeDrafts

boolean

Setzen Sie den Wert auf true, um Entwürfe auszuschließen.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Gibt an, ob die Ergebnisse verschlüsselte, unverschlüsselte oder beide Arten von Inhalten enthalten sollen. Standardmäßig sind beide enthalten.

ClientSideEncryptedOption

Wenn Ihre Organisation die clientseitige Verschlüsselung von Google Workspace verwendet, wird der Verschlüsselungsstatus von Inhalten

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Verschlüsselungsstatus nicht angegeben. Die Ergebnisse umfassen sowohl clientseitig verschlüsselte als auch nicht verschlüsselte Inhalte.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Fügen Sie in den Ergebnissen sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte ein.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Fügen Sie nur clientseitig verschlüsselte Inhalte hinzu.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Fügen Sie nur unverschlüsselte Inhalte hinzu.

DriveOptions

Zusätzliche Optionen für die Drive-Suche.

JSON-Darstellung 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Felder
versionDate

string (Timestamp format)

In diesem Fall wird in der aktuellen Version der Drive-Datei gesucht, aber der Inhalt der vor 00:00 Uhr (UTC) des angegebenen Datums zuletzt gespeicherten Version exportiert. Geben Sie das Datum in UTC ein.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Legen Sie „wahr“ fest, um Teamablagen einzubeziehen.
includeSharedDrives
(deprecated)

boolean

Legen Sie true fest, um geteilte Ablagen einzubeziehen.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Legen Sie fest, ob die Ergebnisse nur Inhalte enthalten sollen, die mit der clientseitigen Verschlüsselung von Google Workspace verschlüsselt wurden, nur unverschlüsselte Inhalte oder beides. Standardmäßig sind beide aktiviert. Wird derzeit für Google Drive unterstützt.

HangoutsChatOptions

Zusätzliche Optionen für die Google Chat-Suche

JSON-Darstellung 
{
  "includeRooms": boolean
}
Felder
includeRooms

boolean

Wenn Sie nach Konto oder Organisationseinheit suchen, setzen Sie wahr, um Chatrooms einzubeziehen.

VoiceOptions

Zusätzliche Optionen für die Sprachsuche

JSON-Darstellung 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Felder
coveredData[]

enum (VoiceCoveredData)

Zu suchende Datentypen

CalendarOptions

Zusätzliche Optionen für die Kalendersuche

JSON-Darstellung 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Felder
locationQuery[]

string

Es werden nur Ereignisse berücksichtigt, deren Ort alle Wörter in der angegebenen Gruppe enthält. Wenn der String zitierte Wortgruppen enthält, werden mit dieser Methode nur Ereignisse abgeglichen, deren Standort genau die Wortgruppe enthält. Einträge im Satz werden bei „und“ berücksichtigt.

Beispiel für die Worttrennung: [„Neuseeland“] im Vergleich zu [„Neu“, „Seeland“] „Neuseeland“: stimmt sowohl mit „Neu und besseres Neuseeland“ als auch mit „Neuseeland“ überein
peopleQuery[]

string

Es werden nur Ereignisse berücksichtigt, deren Teilnehmer alle Wörter im angegebenen Satz enthalten. Einträge im Satz werden bei „und“ berücksichtigt.
minusWords[]

string

Es werden nur Ereignisse gefunden, die im Titel, in der Beschreibung, am Veranstaltungsort oder unter den Teilnehmern keines der Wörter aus dem angegebenen Satz enthalten. Einträge im Satz werden als „oder“ betrachtet.
responseStatuses[]

enum (AttendeeResponse)

Ordnet nur Termine zu, für die der Erziehungsberechtigte eine dieser Antworten gegeben hat. Wenn die Gruppe leer ist oder ATTENDEE_RESPONSE_UNSPECIFIED enthält, werden die Antworten nicht gefiltert.
versionDate

string (Timestamp format)

In der aktuellen Version des Kalendertermins suchen, aber den Inhalt der vor 00:00 Uhr UTC des angegebenen Datums zuletzt gespeicherten Version exportieren Geben Sie das Datum in UTC ein.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

AttendeeResponse

Nutzerantwort auf eine Einladung

Enums
ATTENDEE_RESPONSE_UNSPECIFIED Antwort des Teilnehmers nicht angegeben. Wenn diese Option festgelegt ist, werden keine Antworten gefiltert. Alle anderen Antworten der Teilnehmer, die Teil der Abfrageoptionen sind, werden ignoriert.
ATTENDEE_RESPONSE_NEEDS_ACTION Der Teilnehmer wurde eingeladen, hat aber noch nicht geantwortet.
ATTENDEE_RESPONSE_ACCEPTED Der Teilnehmer plant, teilzunehmen.
ATTENDEE_RESPONSE_DECLINED Der Teilnehmer plant nicht, teilzunehmen.
ATTENDEE_RESPONSE_TENTATIVE Der Teilnehmer erwartet, dass er möglicherweise teilnimmt.

GeminiOptions

Dieser Typ hat keine Felder.

Zusätzliche Optionen für die Gemini-Suche