Method: spaces.messages.search

string

Erforderlich. Eine Suchanfrage.

Die Anfrage kann einen oder mehrere Suchbegriffe enthalten, mit denen die Ergebnisse gefiltert werden.

Sie können die Ergebnisse auch mit den folgenden Nachrichtenfeldern filtern:

• createTime: Akzeptiert einen Zeitstempel im RFC-3339-Format. Die unterstützten Vergleichsoperatoren sind < und >=.
• sender.name: Der Ressourcenname des Absenders (users/{user}). Unterstützt nur =. Sie können die E-Mail-Adresse als Alias für {user} verwenden. Beispiel: users/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.
• space.name: Der Ressourcenname des Gruppenbereichs, in dem die Nachricht gepostet wurde. (spaces/{space}). Unterstützt nur =. Wenn dieser Filter nicht festgelegt ist, wird die Suche in allen Direktnachrichten und Gruppenbereichen durchgeführt, auf die der Nutzer als Mitglied des Gruppenbereichs Zugriff hat.
• space.display_name: Unterstützt den Operator : (hat) und filtert Gruppenbereiche basierend auf einer teilweisen Übereinstimmung ihres Anzeigenamens. Die Ergebnisse sind auf die fünf besten Übereinstimmungen für Gruppenbereiche beschränkt. Mit space.display_name:Project wird beispielsweise nach Nachrichten in den fünf besten Gruppenbereichen gesucht, deren Anzeigenamen das Wort „Project“ enthalten.
• attachment: Unterstützt den Operator :* (hat beliebige), um nach dem Vorhandensein von Anhängen zu suchen. Wenn attachment:* angegeben ist, werden nur Nachrichten mit mindestens einem Anhang zurückgegeben.
• annotations.user_mentions.user.name: Der Ressourcenname des erwähnten Nutzers (users/{user}). Unterstützt nur : (hat). Beispiel: annotations.user_mentions.user.name:"users/1234567890" gibt nur Nachrichten zurück, die eine Erwähnung des angegebenen Nutzers enthalten. Alternativ kann das Alias me verwendet werden, um nach Nachrichten zu filtern, in denen der aufrufende Nutzer erwähnt wird, z. B. annotations.user_mentions.user.name:users/me. Sie können die E-Mail-Adresse auch als Alias für {user} verwenden, z. B. users/example@gmail.com.

Für die erweiterte Filterung sind auch die folgenden Funktionen verfügbar:

• has_link(): Gibt nur Nachrichten zurück, die mindestens einen Hyperlink im Nachrichtentext enthalten.
• is_unread(): Filtert Nachrichten heraus, die vom aufrufenden Nutzer gelesen wurden.

Für die Verwendung des Filters space.display_name müssen die Anmeldedaten des Aufrufers einen der folgenden Autorisierungsbereiche enthalten:

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

Für die Verwendung des Filters is_unread() müssen die Anmeldedaten des Aufrufers einen der folgenden Autorisierungsbereiche enthalten:

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

Für verschiedene Felder werden nur AND-Operatoren unterstützt. Ein gültiges Beispiel ist sender.name = "users/1234567890" AND is_unread(). Das Wort AND ist optional und wird impliziert, wenn es weggelassen wird. Beispielsweise ist sender.name = "users/1234567890" is_unread() gültig und entspricht dem vorherigen Beispiel. Ein ungültiges Beispiel ist sender.name = "users/1234567890" OR is_unread(), da OR zwischen verschiedenen Feldern nicht unterstützt wird.

Innerhalb desselben Felds:

• createTime unterstützt nur AND und kann nur verwendet werden, um ein Intervall darzustellen, z. B. createTime >= "2022-01-01T00:00:00+00:00" AND createTime < "2023-01-01T00:00:00+00:00".
• sender.name unterstützt nur den Operator OR, z. B. sender.name = "users/1234567890" OR sender.name = "users/0987654321".
• space.name unterstützt nur den Operator OR, z. B. space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
• space.display_name unterstützt die Operatoren AND und OR, aber keine Kombination aus beiden. Beispiel: space.display_name:Project AND space.display_name:Tasks gibt Nachrichten zurück, die sich in Gruppenbereichen befinden, deren Anzeigenamen sowohl Project als auch Tasks enthalten. space.display_name:Project OR space.display_name:Tasks gibt Nachrichten zurück, die sich in Gruppenbereichen befinden, deren Anzeigenamen entweder Project oder Tasks oder beides enthalten.
• annotations.user_mentions.user.name unterstützt die Operatoren AND und OR, aber keine Kombination aus beiden. Beispiel: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" gibt nur Nachrichten zurück, in denen beide Nutzer erwähnt werden. annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" gibt Nachrichten zurück, in denen einer der beiden Nutzer oder beide erwähnt werden.

Klammern sind erforderlich, um die Operatorpriorität zu verdeutlichen, wenn AND- und OR-Operatoren in derselben Abfrage kombiniert werden. Beispiel: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). Andernfalls sind Klammern optional.

Die folgenden Beispielabfragen sind gültig:

"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

Die maximale Abfragelänge beträgt 1.000 Zeichen.

Ungültige Abfragen werden vom Server mit einem INVALID_ARGUMENT-Fehler abgelehnt.

integer

Optional. Die maximale Anzahl von zurückzugebenden Ergebnissen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 25 Ergebnisse zurückgegeben.

Der Maximalwert ist 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch auf 100 geändert.

string

Optional. Ein Token, das vom vorherigen Aufruf zum Suchen von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann dies zu unerwarteten Ergebnissen führen.

string

Optional. Wie die Ergebnisliste sortiert wird.

Unterstützte Attribute für die Sortierung:

• createTime: Sortiert die Ergebnisse nach der Erstellungszeit der Nachricht. Standardwert.
• relevance: Sortiert die Ergebnisse nach Relevanz. (science Developer Preview)

Die Standardsortierung ist createTime desc. Pro Abfrage wird nur eine Sortierung (createTime oder relevance) unterstützt. Es wird nur die absteigende Sortierung (desc) unterstützt. Sie muss nach dem Sortierattribut angegeben werden.

enum (SearchMessagesView)

Optional. Gibt an, welche Art von Suchergebnisansicht zurückgegeben werden soll. Der Standardwert ist SEARCH_MESSAGES_VIEW_BASIC.