Method: spaces.search

Zwraca listę pokoi w organizacji Google Workspace na podstawie wyszukiwania administratora.

Wymaga uwierzytelniania 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

W prośbie ustaw wartość useAdminAccess na true.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
useAdminAccess

boolean

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga zakresu chat.admin.spaces.readonly lub chat.admin.spaces 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 miejsc do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie zostanie podany, zwracane 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 metody searchSpaces. Aby pobrać kolejną stronę, podaj ten parametr.

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

customer jest wymagany i służy do wskazywania klienta, od którego mają być pobierane 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.displayName Na przykład reguła 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 tym samym polu funkcja spaceType nie obsługuje operatorów AND ani OR. Parametry displayName, „spaceHistoryState” i „externalUserAllowed” obsługują tylko operatory OR. Atrybuty lastActiveTime i createTime obsługują operatory AND i OR. AND może być używane tylko do reprezentowania przedziału, np. lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Poniżej znajdują się 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. kolejność 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 ostatnio dodano kwalifikujący się element 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 w kolejności malejącej.

Obsługiwane składnie:

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

string

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

integer

Łączna liczba miejsc pasujących do zapytania na wszystkich stronach. Jeśli wynik przekracza 10 tys. znaków, jest to wartość przybliżona.

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 dotyczącym autoryzacji.