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,

  // 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)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }
  // 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.
}
Pola
corpus

enum (CorpusType)

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

enum (DataScope)

Źródło danych, które chcesz przeszukać.
searchMethod
(deprecated)

enum (SearchMethod)

Metoda wyszukiwania.
method

enum (SearchMethod)

Element do wyszukania. To pole zastępuje pole searchMethod, aby obsługiwać dyski współdzielone. Jeśli searchMethod to TEAM_DRIVE, odpowiedź tego pola to SHARED_DRIVE.
terms

string

Operatory wyszukiwania specyficzne dla usługi do filtrowania wyników wyszukiwania.
startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w dniu wskazanym w odwołaniu.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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 wyszukiwania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w dniu wskazanym w odwołaniu.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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 parametr SearchMethod ma wartość TEAM_DRIVE.
timeZone

string

Nazwa strefy czasowej. Musi to być nazwa strefy czasowej IANA, np. „Ameryka/Los_Angeles”. Listę nazw stref czasowych znajdziesz w sekcji Strefa czasowa. Więcej informacji o tym, jak Vault używa stref czasowych, znajdziesz w Centrum pomocy Vault.
Pole unii search_method_field. W razie potrzeby szczegóły elementów do wyszukiwania search_method_field mogą mieć tylko jedną z tych wartości:
accountInfo

object (AccountInfo)

Wymagane, gdy SearchMethod ma wartość ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wymagane, gdy wartość atrybutu SearchMethod to ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wymagane, gdy atrybut SearchMethod ma wartość SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

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

object (SitesUrlInfo)

Wymagane, gdy parametr SearchMethod ma wartość SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Wymagane, gdy parametr SearchMethod ma wartość DRIVE_DOCUMENT.
Pole unii corpus_options_field. dodatkowe opcje wyszukiwania w przypadku niektórych usług. corpus_options_field może być tylko jednym z tych elementów:
mailOptions

object (MailOptions)

Ustaw opcje wyszukiwania w Gmailu.
driveOptions

object (DriveOptions)

Ustaw opcje wyszukiwania na Dysku.
hangoutsChatOptions

object (HangoutsChatOptions)

Ustawianie opcji wyszukiwania w Google Chat (tylko do odczytu)
voiceOptions

object (VoiceOptions)

Ustaw opcje dotyczące wyszukiwania głosowego.
calendarOptions

object (CalendarOptions)

Ustaw opcje wyszukiwania w Kalendarzu.
geminiOptions

object (GeminiOptions)

Ustaw opcje wyszukiwania w Gemini.

DataScope

Źródło danych, które mają być wyszukiwane.

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

SearchMethod

Typ elementu do wyszukania.

Wartości w polu enum
SEARCH_METHOD_UNSPECIFIED Musisz określić metodę wyszukiwania, w przeciwnym razie reklama zostanie odrzucona.
ACCOUNT Przeszukiwanie danych na kontach określonych w AccountInfo.
ORG_UNIT Przeszukuje dane ze wszystkich kont w jednostce organizacyjnej określonej w parametrze OrgUnitInfo.
TEAM_DRIVE

Wyszukaj dane na Dysku zespołu określonym w teamDriveInfo.
ENTIRE_ORG wyszukiwanie danych na wszystkich kontach w organizacji, Obsługiwane tylko w Gmailu. Jeśli jest on określony, nie musisz podawać informacji AccountInfo ani OrgUnitInfo.
ROOM wyszukiwać wiadomości w pokojach Google Chat określonych w HangoutsChatInfo;
SITES_URL Szukaj witryn na podstawie opublikowanych adresów URL określonych w SitesUrlInfo.
SHARED_DRIVE wyszukiwać pliki na dyskach współdzielonych określonych w SharedDriveInfo;
DRIVE_DOCUMENT pobierać dokumenty określone w DriveDocumentInfo;

AccountInfo

Konta, które mają być przeszukane

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

string

zestaw kont do przeszukania;

OrgUnitInfo

Jednostka organizacyjna, w której chcesz przeprowadzić wyszukiwanie

Zapis JSON 
{
  "orgUnitId": string
}
Pola
orgUnitId

string

Nazwa jednostki organizacyjnej, której dotyczy wyszukiwanie, podana przez interfejs Admin SDK Directory API.

SharedDriveInfo

Dyski współdzielone, które mają być wyszukiwane

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

string

Lista identyfikatorów dysków współdzielonych, jak podano w interfejsie Drive API.

HangoutsChatInfo

Pokoje czatu, w których chcesz przeprowadzić wyszukiwanie

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

string

Lista identyfikatorów pokoi czatu, które są udostępniane przez interfejs Chat API. Limit eksportowania z 500 pokojów czatu na prośbę.

SitesUrlInfo

Adresy URL opublikowanych stron w nowej wersji Witryn Google, które chcesz przeszukać

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

string

Lista opublikowanych adresów URL witryn.

DriveDocumentInfo

dokumenty na Dysku, w których chcesz przeprowadzić wyszukiwanie;

Zapis JSON 
{

  // Union field identifier can be only one of the following:
  "documentIds": {
    object (DriveDocumentIds)
  }
  // End of list of possible types for union field identifier.
}
Pola
Pole unii identifier. Format, w jakim mają być pobierane dokumenty z Dysku. identifier może być tylko jednym z tych elementów:
documentIds

object (DriveDocumentIds)

Określanie dokumentów na Dysku za pomocą identyfikatora dokumentu.

DriveDocumentIds

Określanie dokumentów 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, które chcesz przeszukać

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

string

Lista identyfikatorów Dysku zespołowego, jak podano w interfejsie Drive API.

MailOptions

Dodatkowe opcje wyszukiwania w Gmailu

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

boolean

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

enum (ClientSideEncryptedOption)

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

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 Dołącz tylko treści zaszyfrowane po stronie klienta.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Uwzględniaj 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)

Wyszukiwanie obecnej wersji pliku na Dysku, ale eksportowanie zawartości ostatniej wersji zapisanej przed godziną 12:00 czasu UTC w wybranym dniu. Podaj datę w UTC.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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 jako true, aby uwzględnić Dysk zespołu.
includeSharedDrives
(deprecated)

boolean

Aby uwzględnić dyski współdzielone, ustaw wartość na true.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Określ, czy wyniki mają zawierać tylko treści zaszyfrowane za pomocą szyfrowania po stronie klienta Google Workspace, tylko treści niezaszyfrowane czy oba rodzaje. Domyślnie są zaznaczone oba pola. Obecnie obsługiwane na Dysku.
sharedDrivesOption

enum (SharedDrivesOption)

Opcjonalnie. Opcje uwzględniania lub wykluczania dokumentów na dyskach współdzielonych. Zalecamy użycie tego pola zamiast includeSharedDrives. Gdy to pole jest ustawione, zastępuje ono opcje includeSharedDrives i includeTeamDrives.

SharedDrivesOption

Opcja wyboru typu dokumentów z dysku współdzielonego do uwzględnienia.

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 z dysku współdzielonego są uwzględniane tylko wtedy, gdy konto jest współtwórcą 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 opcja „includeSharedDrives” była wyłączona)
INCLUDED Zasoby na dyskach współdzielonych są uwzględniane w wyszukiwaniu. (wcześniej „includeSharedDrives” było 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

Dopasowuje tylko te zdarzenia, których lokalizacja zawiera wszystkie słowa z danego zbioru. Jeśli ciąg znaków zawiera cudzysłów, ta metoda pasuje tylko do tych zdarzeń, których lokalizacja zawiera dokładne wyrażenie. Wpisy w zbiorze są traktowane jako „i”.

Przykład dzielenia wyrazów: ["Nowa Zelandia"] vs ["Nowa","Zelandia"] "Nowa Zelandia": pasuje do obu słów "Nowa i lepsza Zelandia": pasuje tylko do drugiego
peopleQuery[]

string

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

string

pasuje tylko do wydarzeń, które nie zawierają żadnych słów z danego zbioru w tytule, opisie, lokalizacji lub 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ę zdarzenia w kalendarzu, ale wyeksportuj zawartość ostatniej wersji zapisanej przed godziną 12:00 czasu UTC w wybranym dniu. Podaj datę w UTC.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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 udziału.
ATTENDEE_RESPONSE_TENTATIVE Uczestnik prawdopodobnie weźmie udział.

GeminiOptions

Ten typ nie ma pól.

Dodatkowe opcje wyszukiwania w Gemini