Method: spaces.members.list

Répertorie les membres d'un espace. Pour obtenir un exemple, consultez la section Abonnements aux listes. Répertorier les adhésions avec l'authentification de l'application liste les membres dans les espaces auxquels l'application Chat a accès, mais exclut les membres de l'application Chat, y compris les siens. L'option Authentification des utilisateurs permet de lister les adhésions aux espaces auxquels l'utilisateur authentifié a accès.

Une authentification est requise. Prise en charge de l'authentification des applications et de 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: Spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de souscriptions à renvoyer. Le service peut renvoyer une valeur inférieure à cette valeur.

Si aucune valeur n'est spécifiée, la recherche renvoie 100 adhésions au maximum.

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 lors d'un appel précédent pour lister 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 en fonction du rôle d'un membre (role) et de son 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.

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.

Par exemple, les requêtes suivantes sont valides:

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

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 souscriptions associées à un Google Group, en plus d'autres types de souscriptions. Si un filter est défini, les membres Google Group qui ne correspondent pas aux critères de filtre ne sont pas renvoyés.

showInvited

boolean

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

Nécessite actuellement une authentification des utilisateurs.

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant 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 sur la première).
nextPageToken

string

Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page de résultats suivante. 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.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.