Zwraca listę przestrzeni w organizacji Google Workspace na podstawie wyszukiwania administratora. W prośbie ustaw wartość useAdminAccess na true. Przykład znajdziesz w artykule Wyszukiwanie pokoi i zarządzanie nimi.
Wymaga chat.admin.spaces.readonly lub chat.admin.spaceszakresu OAuth 2.0.
Ta metoda obsługuje obecnie tylko dostęp administracyjny, dlatego w tym polu akceptowana jest tylko wartość true.
pageSize
integer
Maksymalna liczba zwracanych przestrzeni. 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.
pageToken
string
Token otrzymany z poprzedniego wywołania przestrzeni wyszukiwania. Podaj ten parametr, aby pobrać następną stronę.
Podczas stronicowania 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.
query
string
Wymagany. Zapytanie.
Możesz wyszukiwać, korzystając z 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: =, <, >, <=, >=.
customer jest wymagany i służy do wskazywania, od którego klienta mają być pobierane 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 przestrzeni displayName. Na przykład wzorzec Fun Eve pasuje do wartości Fun event i The
evening was fun, ale nie do wartości notFun event ani even.
externalUserAllowed akceptuje true lub false.
spaceHistoryState akceptuje tylko wartości z pola historyState zasobu space.
Pole spaceType jest wymagane, 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 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 przedstawiania przedziału, np. lastActiveTime
< "2022-01-01T00:00:00+00:00" AND lastActiveTime >
"2023-01-01T00:00:00+00:00".
Poniższe przykłady zapytań 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 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.
[[["Ł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: 2025-08-20 UTC."],[[["\u003cp\u003eReturns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType.\u003c/p\u003e\n"],["\u003cp\u003eRequires administrator privileges and the \u003ccode\u003euseAdminAccess\u003c/code\u003e parameter set to \u003ccode\u003etrue\u003c/code\u003e in the request.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET https://chat.googleapis.com/v1/spaces:search\u003c/code\u003e HTTP request with query parameters for customization.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either the \u003ccode\u003echat.admin.spaces\u003c/code\u003e or \u003ccode\u003echat.admin.spaces.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces.\u003c/p\u003e\n"]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"],null,[]]
