Method: spaces.search

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 uwierzytelnienia użytkownika z uprawnieniami administratora i jednego z tych zakresów autoryzacji:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

Żądanie HTTP

GET https://chat.googleapis.com/v1/spaces:search

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
useAdminAccess

boolean

Gdy true, metoda jest wykonywana 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 pokoju.

Wymaga chat.admin.spaces.readonly lub chat.admin.spaces zakresu 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.
  • createTime – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji sortowania to:

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

  • DESC – malejąco.

Obsługiwana składnia:

  • 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 przestrzeniami.
nextPageToken

string

Token, którego można użyć do pobrania następnej strony. Jeśli to pole jest puste, nie ma kolejnych stron.
totalSize

integer

Łączna liczba przestrzeni pasujących do zapytania na wszystkich stronach. Jeśli wynik przekracza 10 000 miejsc, ta wartość jest 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 po autoryzacji.