Method: spaces.messages.search

string

Obligatoire. Requête de recherche.

La requête peut spécifier un ou plusieurs mots clés de recherche, qui sont utilisés pour filtrer les résultats.

Vous pouvez également filtrer les résultats à l'aide des champs de message suivants :

• createTime : accepte un code temporel au format RFC-3339. Les opérateurs de comparaison compatibles sont < et >=.
• sender.name : nom de ressource de l'expéditeur (users/{user}). Ne prend en charge que =. Vous pouvez utiliser l'adresse e-mail comme alias pour {user}. Par exemple, users/example@gmail.com, où example@gmail.com est l'adresse e-mail de l'utilisateur Google Chat.
• space.name : nom de ressource de l'espace dans lequel le message est publié. (spaces/{space}). Ne prend en charge que =. Si ce filtre n'est pas défini, la recherche est effectuée dans tous les messages directs et espaces auxquels l'utilisateur a accès en tant que membre de l'espace.
• space.display_name : prend en charge l'opérateur : (contient) et filtre les espaces en fonction d'une correspondance partielle de leur nom à afficher. Les résultats sont limités aux cinq premiers espaces correspondants. Par exemple, space.display_name:Project recherche les messages dans les cinq premiers espaces dont le nom à afficher contient le mot "Project".
• attachment : prend en charge l'opérateur :* (contient) pour vérifier la présence de pièces jointes. Si attachment:* est spécifié, seuls les messages comportant au moins une pièce jointe sont renvoyés.
• annotations.user_mentions.user.name : nom de ressource de l'utilisateur mentionné (users/{user}). Ne prend en charge que : (contient). Exemple : annotations.user_mentions.user.name:"users/1234567890" ne renvoie que les messages contenant une mention à l'utilisateur spécifié. Vous pouvez également utiliser l'alias me pour filtrer les messages qui mentionnent l'utilisateur appelant. Exemple : annotations.user_mentions.user.name:users/me. Vous pouvez également utiliser l'adresse e-mail comme alias pour {user}. Exemple : users/example@gmail.com.

Pour un filtrage avancé, les fonctions suivantes sont également disponibles :

• has_link() : ne renvoie que les messages contenant au moins un lien hypertexte dans le texte du message.
• is_unread() : exclut les messages qui ont été lus par l'utilisateur appelant.

L'utilisation du filtre space.display_name nécessite que les identifiants d'appel incluent l'un des niveaux d'accès suivants :

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

L'utilisation du filtre is_unread() nécessite que les identifiants d'appel incluent l'un des niveaux d'accès suivants :

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

Seuls les opérateurs AND sont compatibles entre différents champs. Un exemple valide est sender.name = "users/1234567890" AND is_unread(). Le mot AND est facultatif et est implicite s'il est omis. Par exemple, sender.name = "users/1234567890" is_unread() est valide et équivalent à l'exemple précédent. Un exemple non valide est sender.name = "users/1234567890" OR is_unread() car OR n'est pas compatible entre différents champs.

Dans le même champ :

• createTime ne prend en charge que AND et ne peut être utilisé que pour représenter un intervalle, tel que createTime >= "2022-01-01T00:00:00+00:00" AND createTime < "2023-01-01T00:00:00+00:00".
• sender.name ne prend en charge que l'opérateur OR. Exemple : sender.name = "users/1234567890" OR sender.name = "users/0987654321".
• space.name ne prend en charge que l'opérateur OR. Exemple : space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
• space.display_name prend en charge les opérateurs AND et OR, mais pas une combinaison des deux. Par exemple, space.display_name:Project AND space.display_name:Tasks renvoie les messages qui se trouvent dans des espaces dont le nom à afficher contient à la fois Project et Tasks, tandis que space.display_name:Project OR space.display_name:Tasks renvoie les messages qui se trouvent dans des espaces dont le nom à afficher contient Project, Tasks ou les deux.
• annotations.user_mentions.user.name prend en charge les opérateurs AND et OR, mais pas une combinaison des deux. Par exemple, annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" ne renvoie que les messages qui mentionnent les deux utilisateurs, tandis que annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" renvoie les messages qui mentionnent l'un des utilisateurs ou les deux.

Les parenthèses sont obligatoires pour lever toute ambiguïté concernant la priorité des opérateurs lorsque vous combinez les opérateurs AND et OR dans la même requête. Exemple : (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). Sinon, les parenthèses sont facultatives.

Les exemples de requêtes suivants sont valides :

"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

La longueur maximale de la requête est de 1 000 caractères.

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

integer

Facultatif. Nombre maximal de résultats à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 25 résultats au maximum sont renvoyés.

La valeur maximale est 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100.

string

Facultatif. Jeton reçu de l'appel de messages de recherche précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.

string

Facultatif. Mode de tri de la liste de résultats.

Les attributs compatibles pour le tri sont les suivants :

• createTime : trie les résultats par heure de création du message. Valeur par défaut.
• relevance : trie les résultats par pertinence. (science Developer Preview)

Le tri par défaut est createTime desc. Une seule commande par requête (createTime ou relevance) est acceptée. Seul l'ordre décroissant (desc) est accepté, et il doit être spécifié après l'attribut de commande.

enum (SearchMessagesView)

Facultatif. Spécifie le type de vue des résultats de recherche à renvoyer. La valeur par défaut est SEARCH_MESSAGES_VIEW_BASIC.