Method: spaces.search

boolean

Gdy true, metoda jest uruchamiana z użyciem uprawnień administratora Google Workspace użytkownika.

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

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

Ustawienie useAdminAccess na false jest dostępne w wersji przedpremierowej dla programistów.

integer

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

Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 miejsc.

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

Podczas paginacji wszystkie inne podane 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.

string

Wymagane. zapytanie.

Gdy parametr useAdminAccess ma wartość true, możesz wyszukiwać, korzystając z tych parametrów:

• createTime
• customer
• displayName
• externalUserAllowed
• lastActiveTime
• spaceHistoryState
• spaceType

Gdy useAdminAccess jest ustawione na false:

• displayName
• externalUserAllowed

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

Właściwość customer jest wymagana, gdy wartość useAdminAccess to true. Służy ona do wskazywania, od którego klienta należy pobrać pokoje. customers/my_customer to jedyna obsługiwana wartość.

displayName akceptuje tylko operatora HAS (:). Tekst do dopasowania jest najpierw dzielony na tokeny, a każdy token jest dopasowywany do prefiksu bez uwzględniania wielkości liter i niezależnie jako podciąg w dowolnym miejscu w displayName. Na przykład wzorzec Fun Eve pasuje do wzorców Fun event i The evening was fun, ale nie do wzorców notFun event i even. Gdy wartość useAdminAccess jest ustawiona na false, do uzyskania miarodajnych wyników wymagana jest wartość displayName. W przeciwnym razie domyślnie zwracana jest pusta odpowiedź.

externalUserAllowed akceptuje true lub false.

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

spaceType jest wymagany, gdy useAdminAccess ma wartość true, a jedyną prawidłową wartością jest 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 ramach tego samego pola spaceType nie obsługuje operatorów AND ani OR. displayName, „spaceHistoryState” i „externalUserAllowed” obsługują tylko operatory OR. Atrybuty lastActiveTime i createTime obsługują operatory AND i OR. Symbolu AND można używać tylko do reprezentowania przedziału, np. lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Te przykładowe zapytania są prawidłowe, gdy wartość useAdminAccess to true:

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

Te przykładowe zapytania są prawidłowe, gdy wartość useAdminAccess to false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Opcjonalnie. Sposób uporządkowania listy pokoi.

Obsługiwane atrybuty, według których można sortować:

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

Gdy wartość useAdminAccess to false, w przypadku kolejności obsługiwane są tylko wartości createTime i relevance. W przypadku tych pól w wyszukiwaniach nieadministracyjnych obsługiwana jest tylko wartość DESC.

Prawidłowe wartości operacji sortowania to:

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

• DESC – malejąco.

Obsługiwana składnia, gdy wartość useAdminAccess jest ustawiona na true:

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

Gdy useAdminAccess jest ustawione na false:

• createTime DESC
• relevance DESC

object (Space)

Tylko dane wyjściowe. Dopasowany pokój.