Method: spaces.members.list

Liste les membres d'un espace. Pour obtenir un exemple, consultez Répertorier les utilisateurs et les applications Google Chat d'un espace. La liste des membres avec authentification des applications répertorie les membres des espaces auxquels l'application Chat a accès, mais exclut les membres de l'application Chat, y compris la sienne. Si vous répertoriez les adhésions avec l'authentification des utilisateurs, elles sont également répertoriées dans les espaces auxquels l'utilisateur authentifié a accès.

Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs.

Requête HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'espace pour lequel extraire une liste de membres.

Format: espaces/{espace}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'adhésions à renvoyer. Le service peut renvoyer moins que cette valeur.

Si aucune valeur n'est spécifiée, 100 adhésions au maximum sont renvoyées.

La valeur maximale est 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 répertorier les adhésions. Indiquez ce paramètre pour récupérer la page suivante.

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

string

Facultatif. Un filtre de requête.

Vous pouvez filtrer les adhésions par rôle (role) et type (member.type).

Pour filtrer par rôle, définissez role sur ROLE_MEMBER ou ROLE_MANAGER.

Pour filtrer par type, définissez member.type sur HUMAN ou BOT. Preview développeur: vous pouvez également filtrer member.type à l'aide de l'opérateur !=.

Pour filtrer par rôle et par type, utilisez l'opérateur AND. Pour filtrer par rôle ou par type, utilisez l'opérateur OR.

Lorsque useAdminAccess est défini sur "true", member.type = "HUMAN" ou member.type != "BOT" est obligatoire. Les autres filtres de type de membre seront refusés.

Par exemple, les requêtes suivantes sont valides:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Les requêtes suivantes ne sont pas valides:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

Facultatif. Lorsque true renvoie également les adhésions associées à un Google Group, en plus d'autres types d'adhésion. Si un filter est défini, les adhésions Google Group qui ne correspondent pas aux critères de filtrage ne sont pas renvoyées.
showInvited

boolean

Facultatif. Lorsque true renvoie les adhésions associées aux membres invited, en plus d'autres types d'adhésion. Si un filtre est défini, les adhésions invited qui ne correspondent pas aux critères de filtre ne sont pas renvoyées.

Cette fonctionnalité nécessite actuellement une authentification de l'utilisateur.
useAdminAccess

boolean

Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces.

Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships.

Il n'est pas possible de lister les abonnements à des applications dans un espace lorsque vous utilisez l'accès administrateur.

Corps de la requête

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

Corps de la réponse

Réponse à la liste des membres de l'espace.

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

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

object (Membership)

Liste à puces. Liste des adhésions sur la page demandée (ou la première page).
nextPageToken

string

Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page suivante des résultats. Si ce champ est vide, il n'y a pas de pages suivantes.

Champs d'application des autorisations

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

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.