Method: spaces.search

Zwraca listę pokoi w organizacji Google Workspace na podstawie wyszukiwania administratora.

Wymaga uwierzytelniania użytkownika z uprawnieniami administratora. W prośbie ustaw wartość 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

Jeśli zasada jest true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

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

Wymaga zakresu chat.admin.spaces.readonly lub chat.admin.spaces OAuth 2.0.

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

integer

Maksymalna liczba miejsc do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

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 przestrzeni wyszukiwania. Podaj ten parametr, aby pobrać kolejną stronę.

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

string

Wymagane. Zapytanie.

Możesz wyszukiwać za pomocą 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: =, <, >, <= i >=.

Parametr customer jest wymagany i służy do wskazywania klienta, z którego mają być pobierane pokoje. customers/my_customer to jedyna obsługiwana wartość.

Funkcja displayName akceptuje tylko operator HAS (:). Tekst do dopasowania jest najpierw tokenizowany w tokeny. Każdy token jest dopasowywany z uwzględnieniem przedrostka bez rozróżniania wielkości liter i stanowi podłańcuch w dowolnym miejscu obiektu displayName pokoju. Na przykład reguła 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.

Wymagane jest pole spaceType, a jedyną prawidłową wartością jest SPACE.

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

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

Prawidłowe są te przykładowe zapytania:

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: kolejność 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 – oznacza czas, w którym ostatnio dodano kwalifikujący się element do dowolnego tematu w tym pokoju.
  • createTime – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji porządkowania to:

  • ASC w kolejności rosnącej. 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ących żądaniu wyszukiwania pokoi.

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 będzie kolejnych stron.
totalSize

integer

Łączna liczba pokoi pasujących do zapytania na wszystkich stronach. Jeśli wynik obejmuje więcej niż 10 000 pokoi, 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 dotyczącym autoryzacji.