Method: spaces.search

Zwraca listę pokoi na podstawie wyszukiwania użytkownika. Wymaga uwierzytelniania użytkownika. Użytkownik musi być administratorem organizacji Google Workspace. W żądaniu ustaw useAdminAccess na true.

Żądanie HTTP

GET https://chat.googleapis.com/v1/spaces:search

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
useAdminAccess

boolean

Gdy true, metoda uruchamia się z wykorzystaniem uprawnień administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu protokołu OAuth 2.0 chat.admin.spaces.readonly lub chat.admin.spaces.

Ta metoda obsługuje obecnie tylko dostęp administratora, więc w tym polu akceptowana jest tylko wartość true.
pageSize

integer

Maksymalna liczba spacji do zwrócenia. Usługa może zwrócić mniejszą wartość od tej wartości.

Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.
pageToken

string

Token otrzymany z poprzedniego wywołania dotyczącego pokoi wyszukiwania. Podaj ten parametr, aby pobrać kolejną stronę.

W przypadku podziału na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do pozostałych parametrów może prowadzić do nieoczekiwanych wyników.
query

string

Wymagane. Zapytanie.

Możesz wyszukiwać przy użyciu tych parametrów: - createTime - customer - displayName - externalUserAllowed - lastActiveTime - spaceHistoryState - spaceType

createTime i lastActiveTime akceptują sygnaturę czasową w formacie RFC-3339, a obsługiwane operatory porównania to: =, <, >, <= oraz >=.

Parametr customer jest wymagany i służy do wskazywania klienta, z którego mają zostać pobrane pokoje. Jedyną obsługiwaną wartością jest customers/my_customer.

displayName akceptuje tylko operator HAS (:). Dopasowany tekst jest najpierw tokenizowany do tokenów, a każdy token jest dopasowywany do prefiksu bez rozróżniania wielkości liter i niezależnie od siebie jako podłańcuch w dowolnym miejscu w elemencie displayName pokoju. Na przykład Fun Eve pasuje do Fun event lub The evening was fun, ale nie do notFun event ani even.

externalUserAllowed akceptuje true lub false.

spaceHistoryState akceptuje tylko wartości z pola historyState zasobu space.

Pole spaceType jest wymagane, a jedyna prawidłowa wartość to SPACE.

W przypadku różnych pól obsługiwane są tylko operatory AND. Prawidłowy przykład to spaceType = "SPACE" AND displayName:"Hello", a nieprawidłowy to spaceType = "SPACE" OR displayName:"Hello".

W tym samym polu spaceType nie obsługuje operatorów AND ani OR. displayName, „spaceHistoryState” i „externalUserAllowed” obsługują tylko operatory OR. Operatory lastActiveTime i createTime obsługują zarówno operatory AND, jak i OR. Funkcja AND może być używana tylko do reprezentowania interwału, np. lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Następujące przykładowe zapytania są prawidłowe:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

Opcjonalnie. Sposób porządkowania listy pokoi.

Obsługiwane atrybuty, według których należy sortować:

  • membershipCount.joined_direct_human_user_count – liczba użytkowników, którzy bezpośrednio dołączyli do pokoju.
  • lastActiveTime – wskazuje czas, kiedy ostatni kwalifikujący się element został dodany do dowolnego tematu w tym pokoju.
  • createTime – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji sortowania to:

  • ASC – rosnąco. Wartość domyślna.

  • DESC – malejąco.

Obsługiwana składnia to:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z listą pokoi odpowiadającą żądaniu dotyczące pokoi wyszukiwania.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Pola
spaces[]

object (Space)

Strona z żądanymi pokojami.
nextPageToken

string

Token, za pomocą którego można pobrać następną stronę. Jeśli to pole jest puste, nie ma kolejnych stron.
totalSize

integer

Łączna liczba pokoi pasujących do zapytania na wszystkich stronach. Jeśli wynik obejmuje więcej niż 10 tys. spacji, jest to wartość szacunkowa.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.