Query

Definicja zapytania używana do wyszukiwania i eksportowania.

Zapis 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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
Pola
corpus

enum (CorpusType)

Usługa Google Workspace, w której chcesz wyszukiwać.
dataScope

enum (DataScope)

Źródło danych do przeszukania.
searchMethod
(deprecated)

enum (SearchMethod)

Metoda wyszukiwania, której chcesz użyć.
method

enum (SearchMethod)

Encja do wyszukiwania. To pole zastępuje searchMethod, aby obsługiwać dyski współdzielone. Jeśli searchMethod to TEAM_DRIVE, odpowiedź w tym polu to SHARED_DRIVE.
terms

string

Operatory wyszukiwania dla poszczególnych usług, które umożliwiają filtrowanie wyników wyszukiwania.
startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 określonego dnia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Czas zakończenia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 określonego dnia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Wymagane, gdy SearchMethod to TEAM_DRIVE.
timeZone

string

Nazwa strefy czasowej. Powinna to być nazwa strefy czasowej IANA, np. „America/Los_Angeles”. Listę nazw stref czasowych znajdziesz w artykule Strefa czasowa. Więcej informacji o tym, jak Vault używa stref czasowych, znajdziesz w Centrum pomocy Vault.
W razie potrzeby określa szczegóły encji do wyszukania. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
accountInfo

object (AccountInfo)

Wymagane, gdy SearchMethod ma wartość ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wymagane, gdy SearchMethod to ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wymagane, gdy SearchMethod ma wartość SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Wymagane, gdy SearchMethod to ROOM. (tylko do odczytu)
sitesUrlInfo

object (SitesUrlInfo)

Wymagane, gdy SearchMethod to SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Wymagane, gdy SearchMethod to DRIVE_DOCUMENT.
Koniec pól wykluczających się wzajemnie.
Dodatkowe opcje wyszukiwania w przypadku konkretnych usług. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
mailOptions

object (MailOptions)

Ustaw opcje wyszukiwania w Gmailu.
driveOptions

object (DriveOptions)

ustawić opcje wyszukiwania na Dysku,
hangoutsChatOptions

object (HangoutsChatOptions)

Ustaw opcje wyszukiwania w Google Chat. (tylko do odczytu)
voiceOptions

object (VoiceOptions)

Skonfiguruj opcje wyszukiwania głosowego.
calendarOptions

object (CalendarOptions)

Ustaw opcje wyszukiwania w Kalendarzu.
geminiOptions

object (GeminiOptions)

Ustaw opcje wyszukiwania w aplikacji Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

ustawić opcje wyszukiwania Gemini w Workspace.
Koniec pól wykluczających się wzajemnie.

DataScope

Źródło danych do przeszukania.

Wartości w polu enum
DATA_SCOPE_UNSPECIFIED Nie określono źródła danych.
ALL_DATA Wszystkie dostępne dane.
HELD_DATA Tylko dane objęte blokadą.
UNPROCESSED_DATA Tylko dane, które nie zostały jeszcze przetworzone przez Vault. (tylko Gmail i Grupy dyskusyjne)

SearchMethod

Typ encji do wyszukiwania.

Wartości w polu enum
SEARCH_METHOD_UNSPECIFIED Metoda wyszukiwania musi być określona, w przeciwnym razie zostanie odrzucona.
ACCOUNT Wyszukaj dane kont określonych w AccountInfo.
ORG_UNIT Wyszukuje dane wszystkich kont w jednostce organizacyjnej określonej w OrgUnitInfo.
TEAM_DRIVE

Wyszukaj dane na dysku zespołu określonym w teamDriveInfo.
ENTIRE_ORG Przeszukaj dane wszystkich kont w organizacji. Obsługiwane tylko w Gmailu. Jeśli podasz ten parametr, nie musisz podawać parametrów AccountInfo ani OrgUnitInfo.
ROOM Wyszukaj wiadomości w pokojach czatu określonych w HangoutsChatInfo.
SITES_URL Wyszukaj witryny według opublikowanych adresów URL witryn określonych w SitesUrlInfo.
SHARED_DRIVE Wyszukaj pliki na dyskach współdzielonych określonych w SharedDriveInfo.
DRIVE_DOCUMENT Pobierz dokumenty określone w DriveDocumentInfo.

AccountInfo

Konta do przeszukania

Zapis JSON 
{
  "emails": [
    string
  ]
}
Pola
emails[]

string

zestaw kont do przeszukania;

OrgUnitInfo

Jednostka organizacyjna, którą chcesz przeszukać.

Zapis JSON 
{
  "orgUnitId": string
}
Pola
orgUnitId

string

Nazwa jednostki organizacyjnej do wyszukania, podana przez pakiet Admin SDK Directory API.

SharedDriveInfo

Dyski współdzielone, które chcesz przeszukać.

Zapis JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Pola
sharedDriveIds[]

string

Lista identyfikatorów dysków współdzielonych, które są udostępniane przez Drive API.

HangoutsChatInfo

Pokoje czatu, które chcesz przeszukać.

Zapis JSON 
{
  "roomId": [
    string
  ]
}
Pola
roomId[]

string

Lista identyfikatorów pokoi czatu dostarczanych przez interfejs Google Chat API. W ramach jednej prośby można wyeksportować maksymalnie 500 pokoi czatu.

SitesUrlInfo

Adresy URL opublikowanych witryn w nowej wersji Witryn Google, które chcesz wyszukać.

Zapis JSON 
{
  "urls": [
    string
  ]
}
Pola
urls[]

string

Lista adresów URL opublikowanych witryn.

DriveDocumentInfo

Dokumenty na Dysku, które mają zostać przeszukane.

Zapis JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Pola
Format, w którym mają być pobierane dokumenty z Dysku. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
documentIds

object (DriveDocumentIds)

Określ dokumenty na Dysku według identyfikatora dokumentu.
Koniec pól wykluczających się wzajemnie.

DriveDocumentIds

Określ dokumenty na Dysku według identyfikatora dokumentu.

Zapis JSON 
{
  "ids": [
    string
  ]
}
Pola
ids[]

string

Wymagane. lista identyfikatorów dokumentów na Dysku;

TeamDriveInfo

Dyski zespołu do przeszukania

Zapis JSON 
{
  "teamDriveIds": [
    string
  ]
}
Pola
teamDriveIds[]
(deprecated)

string

Lista identyfikatorów dysków zespołu podanych przez interfejs Drive API.

MailOptions

Dodatkowe opcje wyszukiwania w Gmailu

Zapis JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Pola
excludeDrafts

boolean

Aby wykluczyć wersje robocze, ustaw wartość true.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Określa, czy wyniki powinny obejmować treści zaszyfrowane, niezaszyfrowane czy oba rodzaje. Domyślnie uwzględniane są oba typy.

ClientSideEncryptedOption

Jeśli Twoja organizacja korzysta z szyfrowania po stronie klienta w Google Workspace, stan szyfrowania treści

Wartości w polu enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Stan szyfrowania nie został określony. Wyniki obejmują zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Uwzględnij w wynikach zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Uwzględniaj tylko treści zaszyfrowane po stronie klienta.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED uwzględnić tylko treści niezaszyfrowane;

DriveOptions

Dodatkowe opcje wyszukiwania na Dysku.

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

string (Timestamp format)

Wyszukaj bieżącą wersję pliku na Dysku, ale wyeksportuj zawartość ostatniej wersji zapisanej przed godziną 12:00 czasu UTC wybranego dnia. Wpisz datę w formacie UTC.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Ustaw wartość „true”, aby uwzględnić Dysk zespołu.
includeSharedDrives
(deprecated)

boolean

Ustaw wartość true, aby uwzględnić dyski współdzielone.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Określ, czy wyniki mają obejmować tylko treści zaszyfrowane za pomocą szyfrowania po stronie klienta Google Workspace, tylko treści niezaszyfrowane czy oba rodzaje treści. Domyślna wartość to obie opcje. Obecnie obsługiwane na Dysku.
sharedDrivesOption

enum (SharedDrivesOption)

Opcjonalnie: Opcje uwzględniania lub wykluczania dokumentów na dyskach współdzielonych. Zalecamy używanie tego pola zamiast includeSharedDrives. Jeśli to pole jest ustawione, zastępuje pola includeSharedDrives i includeTeamDrives.

SharedDrivesOption

Opcja dotycząca typu dokumentów z dysku współdzielonego, które mają zostać uwzględnione.

Wartości w polu enum
SHARED_DRIVES_OPTION_UNSPECIFIED Nie określono opcji dysku współdzielonego.
NOT_INCLUDED Jeśli zasób znajduje się na dysku współdzielonym, nie jest uwzględniany w wyszukiwaniu.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Zasoby na dysku współdzielonym są uwzględniane tylko w przypadkach, gdy konto jest współpracownikiem zasobu, ale nie należy do dysku współdzielonego. Odpowiada to opcji Uwzględniane tylko w przypadku dokumentów udostępnionych bezpośrednio (nie ze względu na przynależność do dysku współdzielonego) w interfejsie Vault. (wcześniej „includeSharedDrives” wyłączone)
INCLUDED Zasoby na dyskach współdzielonych są uwzględniane w wyszukiwaniu. (wcześniej „includeSharedDrives” włączone)

HangoutsChatOptions

Dodatkowe opcje wyszukiwania w Google Chat

Zapis JSON 
{
  "includeRooms": boolean
}
Pola
includeRooms

boolean

W przypadku wyszukiwania według konta lub jednostki organizacyjnej ustaw wartość true, aby uwzględnić pokoje.

VoiceOptions

Dodatkowe opcje wyszukiwania głosowego

Zapis JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Pola
coveredData[]

enum (VoiceCoveredData)

Typy danych do wyszukiwania

CalendarOptions

Dodatkowe opcje wyszukiwania w Kalendarzu

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

string

Zwraca tylko te wydarzenia, których lokalizacja zawiera wszystkie słowa z podanego zbioru. Jeśli ciąg znaków zawiera wyrażenia w cudzysłowie, ta metoda dopasowuje tylko te wydarzenia, których lokalizacja zawiera dokładne wyrażenie. Wpisy w zbiorze są rozpatrywane jako „i”.

Przykład podziału słów: ["Nowa Zelandia"] i ["Nowa","Zelandia"] „Nowa Zelandia”: pasuje do obu „Nowa i lepsza Zelandia”: pasuje tylko do drugiego
peopleQuery[]

string

Zwraca tylko te wydarzenia, których uczestnicy zawierają wszystkie słowa z podanego zbioru. Wpisy w zbiorze są traktowane jako „i”.
minusWords[]

string

Dopasowuje tylko te wydarzenia, które nie zawierają żadnego ze słów z danego zestawu w tytule, opisie, lokalizacji ani na liście uczestników. Wpisy w zbiorze są traktowane jako „lub”.
responseStatuses[]

enum (AttendeeResponse)

Dopasowuje tylko zdarzenia, na które opiekun udzielił jednej z tych odpowiedzi. Jeśli zbiór jest pusty lub zawiera wartość ATTENDEE_RESPONSE_UNSPECIFIED, odpowiedzi nie będą filtrowane.
versionDate

string (Timestamp format)

Wyszukaj bieżącą wersję wydarzenia w Kalendarzu, ale wyeksportuj zawartość ostatniej wersji zapisanej przed godziną 12:00 czasu UTC wybranego dnia. Wpisz datę w formacie UTC.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

AttendeeResponse

Odpowiedź użytkownika na zaproszenie.

Wartości w polu enum
ATTENDEE_RESPONSE_UNSPECIFIED Nie określono odpowiedzi uczestnika. Jeśli ta opcja jest ustawiona, odpowiedzi nie będą filtrowane, a wszystkie inne odpowiedzi uczestników, które są częścią opcji zapytania, zostaną zignorowane.
ATTENDEE_RESPONSE_NEEDS_ACTION Uczestnik został zaproszony, ale jeszcze nie odpowiedział.
ATTENDEE_RESPONSE_ACCEPTED Uczestnik planuje wziąć udział.
ATTENDEE_RESPONSE_DECLINED Uczestnik nie planuje wziąć udziału.
ATTENDEE_RESPONSE_TENTATIVE Uczestnik może wziąć udział w spotkaniu.

GeminiOptions

Ten typ nie ma pól.

Dodatkowe opcje wyszukiwania w aplikacji Gemini

GeminiInWorkspaceOptions

Ten typ nie ma pól.

Dodatkowe opcje wyszukiwania w Gemini w Workspace