Method: spaces.findGroupChats

Renvoie tous les espaces avec spaceType == GROUP_CHAT, dont les membres humains contiennent exactement l'utilisateur appelant et les utilisateurs spécifiés dans FindGroupChatsRequest.memberships.

Si l'utilisateur appelant bloque certains utilisateurs ou est bloqué par certains utilisateurs, et qu'aucun espace ne contenant l'ensemble spécifié d'utilisateurs n'est trouvé, cette méthode renvoie des espaces qui n'incluent pas les utilisateurs bloqués ou bloquants.

L'ensemble d'utilisateurs spécifié ne doit contenir que des membres humains (et non des applications). Une requête qui contient des utilisateurs non humains ne renvoie aucun espace.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
user[]

string

Noms de ressources de tous les utilisateurs humains dans le chat de groupe avec l'utilisateur appelant. Les applications de chat ne peuvent pas être incluses dans la demande.

Format : users/{user}, où {user} correspond au id de la personne dans l'API People ou au id de l'utilisateur dans l'API Directory. Par exemple, pour trouver toutes les discussions de groupe avec l'utilisateur appelant et deux autres utilisateurs, avec les ID de profil de l'API People 123456789 et 987654321, vous pouvez utiliser users/123456789 et users/987654321. Vous pouvez également utiliser l'adresse e-mail comme alias pour {user}. Par exemple, users/example@gmail.comexample@gmail.com est l'adresse e-mail de l'utilisateur Google Chat.

Lorsque l'utilisateur appelant est un utilisateur Google Workspace, tous les utilisateurs demandés doivent être membres de la même organisation Google Workspace que l'utilisateur appelant.

pageSize

integer

Facultatif. Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés.

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

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

pageToken

string

Facultatif. Jeton de page reçu d'un appel précédent pour trouver des discussions de groupe. 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. Transmettre différentes valeurs peut entraîner des résultats inattendus.

spaceView

enum (SpaceView)

Type de vue de l'espace demandé. Si cette valeur n'est pas définie, la valeur par défaut est SPACE_VIEW_RESOURCE_NAME_ONLY. Les requêtes qui spécifient SPACE_VIEW_EXPANDED doivent inclure des habilitations permettant de lire les données d'espace, par exemple https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse contenant des espaces de discussion de groupe avec l'utilisateur appelant et les utilisateurs demandés.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Champs
spaces[]

object (Space)

Liste des espaces sur la page demandée (ou la première page).

nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.

SpaceView

Vue qui spécifie les champs à renseigner dans la ressource Space. Pour assurer la compatibilité avec les futures versions, nous vous recommandons de prévoir des valeurs supplémentaires dans votre code.

Enums
SPACE_VIEW_UNSPECIFIED Valeur par défaut / non définie.
SPACE_VIEW_RESOURCE_NAME_ONLY Ne renseigne que le nom de ressource de l'espace.
SPACE_VIEW_EXPANDED Renseigne les champs de la ressource "Space". Remarque : Le champ permissionSettings ne sera pas renseigné. Les requêtes qui spécifient SPACE_VIEW_EXPANDED doivent inclure des habilitations permettant de lire les données d'espace, par exemple https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.