Method: spaces.members.list

Répertorie les adhésions dans un espace. Pour obtenir un exemple, consultez Lister les adhésions. La liste des adhésions avec l'authentification des applications répertorie les adhésions aux espaces auxquels l'application Chat a accès, mais exclut les adhésions aux applications Chat, y compris les leurs. Pour lister les adhésions avec l'authentification des utilisateurs, répertoriez les adhésions dans les espaces auxquels l'utilisateur authentifié a accès.

Nécessite une authentification. Entièrement compatible avec l'authentification du compte de service et l'authentification des utilisateurs. L'authentification de l'utilisateur nécessite le champ d'application de l'autorisation chat.memberships ou chat.memberships.readonly.

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 d'adhésion.

Format: spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

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

Si aucune valeur n'est spécifiée, la limite affiche 100 souscriptions.

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

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Jeton de page, reçu lors 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 ayant 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. Filtre de requête.

Vous pouvez filtrer les adhésions en fonction du rôle (role) et du 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 refusées par le serveur avec une erreur INVALID_ARGUMENT.
showGroups

boolean

Facultatif. Lorsque true, renvoie également les souscriptions associées à une Google Group, en plus des autres types de souscriptions. Si une filter est définie, les adhésions Google Group qui ne correspondent pas aux critères de filtre ne sont pas renvoyées.

showInvited

boolean

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

Nécessite actuellement l'authentification de l'utilisateur.

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 des adhésions sur la page demandée (ou première page).
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, aucune page suivante n'existe.

Champs d'application des autorisations

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

  • 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 sur les autorisations.