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)
  }
}
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)

Element do wyszukania. To pole zastępuje pole searchMethod, aby obsługiwać dyski współdzielone. Gdy wartość parametru searchMethod to TEAM_DRIVE, odpowiedź w tym polu to SHARED_DRIVE.
terms

string

Operatory wyszukiwania specyficzne dla usługi, które umożliwiają filtrowanie wyników wyszukiwania.
startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas w formacie GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

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 formacie GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

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)

Wymagany, gdy atrybut SearchMethod ma wartość 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 korzysta ze stref czasowych, znajdziesz w Centrum pomocy Vault.
Pole zbiorcze search_method_field. W razie potrzeby szczegóły jednostek do wyszukania search_method_field mogą być tylko jednym z tych elementów:
accountInfo

object (AccountInfo)

Wymagany, gdy wartość SearchMethod to ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wymagany, gdy SearchMethod ma wartość ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wymagany, gdy SearchMethod ma wartość SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Wymagany, gdy SearchMethod ma wartość ROOM. (tylko do odczytu)
sitesUrlInfo

object (SitesUrlInfo)

Wymagany, gdy atrybut SearchMethod ma wartość SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Wymagany, gdy SearchMethod ma wartość DRIVE_DOCUMENT.
Pole zbiorcze corpus_options_field. Dodatkowe opcje wyszukiwania w przypadku konkretnych usług. corpus_options_field może mieć tylko jedną z tych wartości:
mailOptions

object (MailOptions)

Ustaw opcje wyszukiwania w Gmailu.
driveOptions

object (DriveOptions)

Ustaw opcje wyszukiwania na Dysku.
hangoutsChatOptions

object (HangoutsChatOptions)

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

object (VoiceOptions)

Ustaw opcje wyszukiwania głosowego.
calendarOptions

object (CalendarOptions)

Ustaw opcje wyszukiwania w Kalendarzu.
geminiOptions

object (GeminiOptions)

Ustaw opcje wyszukiwania w Gemini.

DataScope

Źródło danych do przeszukiwania.

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 jednostki do wyszukiwania.

Wartości w polu enum
SEARCH_METHOD_UNSPECIFIED Musisz określić metodę wyszukiwania, w przeciwnym razie zostanie ona odrzucona.
ACCOUNT Wyszukuje dane kont określonych w parametrze AccountInfo.
ORG_UNIT Przeszukuje dane wszystkich kont w jednostce organizacyjnej określonej w elemencie OrgUnitInfo.
TEAM_DRIVE

Wyszukaj dane na Dysku zespołu określonym w parametrze teamDriveInfo.
ENTIRE_ORG przeszukiwanie danych wszystkich kont w organizacji, Obsługiwane tylko w Gmailu. Jeśli podasz tę wartość, nie musisz określać AccountInfo ani OrgUnitInfo.
ROOM Wyszukiwanie wiadomości w pokojach Google Chat określonych w HangoutsChatInfo.
SITES_URL Wyszukaj witryny według opublikowanych adresów URL określonych w SitesUrlInfo.
SHARED_DRIVE Wyszukuje pliki na dyskach współdzielonych określonych w SharedDriveInfo.
DRIVE_DOCUMENT Pobiera dokumenty określone w DriveDocumentInfo.

AccountInfo

Konta do przeszukania

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

string

Zestaw kont do przeszukania.

OrgUnitInfo

Jednostka organizacyjna, w której chcesz wyszukać.

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 mają być przeszukiwane

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

string

Lista identyfikatorów dysków współdzielonych podana przez Drive API.

HangoutsChatInfo

Pokoje czatu, w których chcesz wyszukiwać

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

string

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

SitesUrlInfo

URL-e opublikowanych stron w nowej wersji Witryn Google, które chcesz przeszukać.

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

string

Lista opublikowanych adresów URL witryny.

DriveDocumentInfo

Dokumenty na Dysku, w których chcesz wyszukiwać.

Zapis JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Pola
Pole zbiorcze identifier. Format, w którym mają zostać pobrane dokumenty z Dysku. identifier może mieć tylko jedną z tych wartości:
documentIds

object (DriveDocumentIds)

Określ dokumenty na Dysku za pomocą identyfikatora dokumentu.

DriveDocumentIds

Określ dokumenty na Dysku za pomocą 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łowych podana przez interfejs Drive API.

MailOptions

Dodatkowe opcje wyszukiwania w Gmailu

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

boolean

Ustaw wartość true, aby wykluczyć wersje robocze.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

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

ClientSideEncryptedOption

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

Wartości w polu enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Stan szyfrowania jest nieokreślony. Wyniki obejmują zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY uwzględniać 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ędniaj tylko nieszyfrowane treści.

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)

Wyszukiwanie obecnej wersji pliku na Dysku, ale eksportowanie zawartości 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ślnie są to oba typy. Obecnie obsługiwane w przypadku Dysku.
sharedDrivesOption

enum (SharedDrivesOption)

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

SharedDrivesOption

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

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 dysku współdzielonego są uwzględniane tylko w przypadkach, gdy konto jest współpracownikiem w przypadku zasobu, ale nie jest użytkownikiem 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” było wyłączone)
INCLUDED Wyszukiwanie obejmuje zasoby na dyskach współdzielonych. (Wcześniej „includeSharedDrives”)

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 danego zbioru. Jeśli ciąg znaków zawiera wyrażenia w cudzysłowie, ta metoda dopasowuje tylko te zdarzenia, których lokalizacja zawiera dokładne wyrażenie. Wpisy w zbiorze są traktowane jako „i”.

Przykład podziału słów: ["New Zealand"] vs ["New","Zealand"] „New Zealand”: pasuje do obu „New and better Zealand”: pasuje tylko do drugiego
peopleQuery[]

string

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

string

Pasuje tylko do tych wydarzeń, które nie zawierają żadnego ze słów z danego zbioru w tytule, opisie, lokalizacji ani uczestnikach. Wpisy w zbiorze są traktowane jako „lub”.
responseStatuses[]

enum (AttendeeResponse)

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

string (Timestamp format)

Wyszukiwanie bieżącej wersji wydarzenia w Kalendarzu, ale eksportowanie zawartości ostatniej wersji zapisanej przed godziną 12:00 czasu UTC w wybranym dniu. 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 Nieokreślona odpowiedź 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 w wydarzeniu.
ATTENDEE_RESPONSE_TENTATIVE Uczestnik prawdopodobnie weźmie udział.

GeminiOptions

Ten typ nie ma pól.

Dodatkowe opcje wyszukiwania w Gemini