Method: spaces.search

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 OAuth 2.0 chat.admin.spaces.readonly lub chat.admin.spaces.

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

integer

Maksymalna liczba spacji 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.

string

Token otrzymany z poprzedniego wywołania pokoi 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 innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

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: =, <, >, <=, >=.

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

Funkcja displayName akceptuje tylko operator HAS (:). Tekst do dopasowania jest najpierw tokenizowany na tokeny, a każdy token jest dopasowywany w postaci prefiksu bez uwzględniania wielkości liter i jest traktowany niezależnie 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 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 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śród tego samego pola 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")

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 dodania ostatniego kwalifikującego się elementu do dowolnego tematu w tym pokoju.
• createTime – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji sortowania:

• 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