Wymaga zakresu chat.admin.spaces.readonly lub chat.admin.spacesOAuth 2.0.
Ta metoda obsługuje obecnie tylko dostęp administracyjny, dlatego w tym polu akceptowana jest tylko wartość true.
pageSize
integer
Maksymalna liczba spacji do zwrócenia. Usługa może zwrócić mniej niż ta wartość.
Jeśli nie zostanie podany, zwróci się maksymalnie 100 miejsc.
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 metody searchSpaces. Podaj ten parametr, aby pobrać kolejną stronę.
Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, 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: =, <, >, <=, >=.
Pole customer jest wymagane i służy do wskazywania, od którego klienta mają zostać pobrane pokoje. customers/my_customer to jedyna obsługiwana wartość.
Funkcja displayName akceptuje tylko operator HAS (:). Tekst dopasowywania jest najpierw dzielony na tokeny, a każdy z nich jest dopasowywany do prefiksu niezależnie od wielkości liter. Na przykład Fun Eve pasuje do Fun event lub The
evening was fun, ale nie do notFun event ani even.
externalUserAllowed może przyjmować wartość 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śród tego samego pola spaceType nie obsługuje operatorów AND ani OR. Metody displayName, „spaceHistoryState” i „externalUserAllowed” obsługują tylko operatory OR. Atrybuty lastActiveTime i createTime obsługują operatory AND 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: Sposób porządkowania listy pokoi.
Obsługiwane atrybuty, według których należy 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 ostatnio dodano kwalifikujący się element do dowolnego tematu w tym pokoju.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2024-11-08 UTC."],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],[]]
