Method: spaces.search

Zwraca listę pokoi w organizacji Google Workspace. Przykład znajdziesz w artykule Wyszukiwanie pokoi i zarządzanie nimi.

Gdy parametr useAdminAccess ma wartość false, wyniki są ograniczone do pokoi, w których użytkownik wywołujący jest członkiem. Aby wyszukiwać z uprawnieniami administratora, ustaw wartość useAdminAccess na true.

Obsługuje te typy uwierzytelniania:

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
useAdminAccess

boolean

Gdy ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

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

integer

Maksymalna liczba pokoi do zwrócenia. Usługa może zwrócić mniej niż tę wartość.

Jeśli nie zostanie określona, zwracanych jest maksymalnie 100 pokoi.

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 wyszukiwania pokoi. 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.
query

string

Wymagane. Zapytanie.

Gdy parametr useAdminAccess ma wartość true, możesz wyszukiwać za pomocą tych parametrów:

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

Gdy parametr useAdminAccess ma wartość false:

  • displayName
  • externalUserAllowed
  • spaceType

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

Parametr customer jest wymagany, gdy parametr useAdminAccess ma wartość true. Służy do wskazywania, od którego klienta mają być pobierane pokoje. Jedyną obsługiwaną wartością jest customers/my_customer.

Parametr displayName akceptuje tylko operator 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 polu displayName pokoju. Na przykład Fun Eve pasuje do Fun event lub The evening was fun, ale nie do notFun event ani even. Gdy parametr useAdminAccess ma wartość false, parametr displayName jest wymagany do uzyskania znaczących wyników. W przeciwnym razie domyślnie zwracana jest pusta odpowiedź.

Parametr externalUserAllowed akceptuje wartości true lub false.

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

Parametr spaceType jest wymagany, 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 tym samym polu parametr spaceType nie obsługuje operatorów AND ani OR. Parametry displayName, `spaceHistoryState` i `externalUserAllowed` obsługują tylko operatory OR. Parametry lastActiveTime i createTime obsługują operatory AND i OR. 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".

Te przykładowe zapytania są prawidłowe, gdy parametr useAdminAccess ma wartość 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 parametr useAdminAccess ma wartość false:

displayName:"Hello World" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

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

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
orderBy

string

Opcjonalnie. Sposób sortowania 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 dodania ostatniego kwalifikującego się elementu do dowolnego wątku w tym pokoju.
  • createTime – oznacza czas utworzenia pokoju.

Gdy parametr useAdminAccess ma wartość false, do sortowania obsługiwane są tylko parametry createTime i relevance. W przypadku wyszukiwań nieadministracyjnych te pola obsługują tylko wartość DESC.

Prawidłowe wartości operacji sortowania:

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

  • DESC – malejąco.

Obsługiwana składnia, gdy parametr useAdminAccess ma wartość true:

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

Gdy parametr useAdminAccess ma wartość false:

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z listą pokoi odpowiadającą żądaniu wyszukiwania pokoi.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
Pola
spaces[]
(deprecated)

object (Space)

Wycofane: zamiast tego użyj nowego pola results. Strona z żądanymi pokojami. To pole będzie wypełniane tylko wtedy, gdy parametr useAdminAccess ma wartość true. Zostało wycofane na rzecz nowego pola results.
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 pokoi pasujących do zapytania na wszystkich stronach. Jeśli wynik obejmuje ponad 10 tys. pokoi, ta wartość jest szacunkowa.
results[]

object (SearchSpaceResult)

Tylko dane wyjściowe. Lista wyników wyszukiwania pasujących do zapytania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • 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.

SearchSpaceResult

Pojedynczy element wyniku wyszukiwania pokoju.

Zapis JSON 
{
  "space": {
    object (Space)
  }
}
Pola
space

object (Space)

Tylko dane wyjściowe. Dopasowany pokój.