Method: spaces.messages.search

string

Wymagane. zapytanie.

Zapytanie może zawierać co najmniej jedno wyszukiwane słowo kluczowe, które służy do filtrowania wyników.

Możesz też filtrować wyniki za pomocą tych pól wiadomości:

• createTime: akceptuje sygnaturę czasową w formacie RFC-3339. Obsługiwane operatory porównania to: < i >=.
• sender.name: nazwa zasobu nadawcy (users/{user}). Obsługuje tylko =. Możesz użyć adresu e-mail jako aliasu dla {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.
• space.name: nazwa zasobu pokoju, w którym opublikowano wiadomość. (spaces/{space}). Obsługuje tylko wartość =. Jeśli ten filtr nie jest ustawiony, wyszukiwanie jest przeprowadzane we wszystkich wiadomościach czatu i pokojach, do których użytkownik ma dostęp jako członek pokoju.
• space.display_name: obsługuje operatora : (zawiera) i filtruje przestrzenie na podstawie częściowego dopasowania ich nazwy wyświetlanej. Wyniki są ograniczone do 5 najlepiej pasujących pokoi. Na przykład space.display_name:Project wyszukuje wiadomości w 5 najpopularniejszych przestrzeniach, których nazwy wyświetlane zawierają słowo „Project”.
• space.space_type: typ miejsca. Obsługuje tylko =. Na przykład space.space_type="DIRECT_MESSAGE" zwraca tylko wiadomości z czatów. Możliwe wartości to DIRECT_MESSAGE, GROUP_CHAT i SPACE.
• attachment: obsługuje operatora :* (ma dowolny), który umożliwia sprawdzenie, czy są załączniki. Jeśli podasz attachment:*, zwracane będą tylko wiadomości zawierające co najmniej 1 załącznik.
• annotations.user_mentions.user.name: nazwa zasobu wspomnianego użytkownika (users/{user}). Obsługuje tylko : (has). Na przykład: annotations.user_mentions.user.name:"users/1234567890" zwraca tylko wiadomości, które zawierają wzmiankę o określonym użytkowniku. Możesz też użyć aliasu me, aby filtrować wiadomości, w których jest wzmianka o użytkowniku dzwoniącym, np. annotations.user_mentions.user.name:users/me. Możesz też użyć adresu e-mail jako aliasu dla {user}, np. users/example@gmail.com.

W przypadku filtrowania zaawansowanego dostępne są też te funkcje:

• has_link(): zwraca tylko wiadomości, które zawierają co najmniej 1 hiperlink w tekście wiadomości.
• is_unread(): Filtruje wiadomości, które zostały przeczytane przez użytkownika wywołującego.

Korzystanie z filtrów space.display_name lub space.space_type wymaga, aby dane logowania do wywołania zawierały jeden z tych zakresów autoryzacji:

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

Użycie filtra is_unread() wymaga, aby dane logowania wywołującego zawierały jeden z tych zakresów autoryzacji:

• https://www.googleapis.com/auth/chat.users.readstate.readonly
• https://www.googleapis.com/auth/chat.users.readstate

W przypadku różnych pól obsługiwane są tylko operatory AND. Prawidłowy przykład to sender.name = "users/1234567890" AND is_unread(). Słowo AND jest opcjonalne i jest domyślnie używane, jeśli go nie podasz. Prawidłowa wartość to np. sender.name = "users/1234567890" is_unread(), która jest równoważna poprzedniemu przykładowi. Nieprawidłowy przykład to sender.name = "users/1234567890" OR is_unread(), ponieważ OR nie jest obsługiwany między różnymi polami.

W ramach tego samego pola:

• createTime obsługuje tylko AND i może być używany tylko do reprezentowania przedziału, np. createTime >= "2022-01-01T00:00:00+00:00" AND createTime < "2023-01-01T00:00:00+00:00".
• sender.name obsługuje tylko operator OR, np. sender.name = "users/1234567890" OR sender.name = "users/0987654321".
• space.name obsługuje tylko operator OR, np. space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
• space.display_name obsługuje operatory AND i OR, ale nie ich kombinację. Na przykład space.display_name:Project AND space.display_name:Tasks zwraca wiadomości z przestrzeni z wyświetlanymi nazwami zawierającymi zarówno Project, jak i Tasks, a space.display_name:Project OR space.display_name:Tasks zwraca wiadomości z przestrzeni z wyświetlanymi nazwami zawierającymi Project lub Tasks albo oba te słowa.
• space.space_type obsługuje tylko operator OR, np. space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
• annotations.user_mentions.user.name obsługuje operatory AND i OR, ale nie ich kombinację. Na przykład: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" zwraca tylko wiadomości, w których wspomniani są obaj użytkownicy, a annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" zwraca wiadomości, w których wspomniany jest jeden z użytkowników lub obaj.

Nawiasy są wymagane do rozróżnienia kolejności operatorów podczas łączenia operatorów AND i OR w tym samym zapytaniu. Przykład: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). W przeciwnym razie nawiasy są opcjonalne.

Poniższe przykłady zapytań są prawidłowe:

"Pending reports" AND createTime >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (createTime < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

Maksymalna długość zapytania to 1000 znaków.

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.

integer

Opcjonalnie: Maksymalna liczba wyników do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 25 wyników.

Maksymalna wartość to 100. Jeśli użyjesz wartości większej niż 100, zostanie ona automatycznie zmieniona na 100.

string

Opcjonalnie: Token otrzymany z poprzedniego wywołania wyszukiwania wiadomości. 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.

string

Opcjonalnie: Sposób sortowania listy wyników.

Obsługiwane atrybuty, według których można sortować:

• createTime: sortuje wyniki według czasu utworzenia wiadomości. Wartość domyślna.
• relevance: sortuje wyniki według trafności. (science wersja przedpremierowa dla programistów)

Domyślna kolejność to createTime desc. Obsługiwane jest tylko 1 zamówienie na zapytanie (createTime lub relevance). Obsługiwane jest tylko sortowanie malejące (desc), które musi być określone po atrybucie kolejności.

enum (MarkupSyntax)

Opcjonalnie: Określa żądaną składnię wyjściową pola wiadomości na czacie formattedText.

enum (SearchMessagesView)

Opcjonalnie: Określa, jaki rodzaj widoku wyników wyszukiwania ma być zwracany. Wartość domyślna to SEARCH_MESSAGES_VIEW_BASIC.