Ce guide explique comment obtenir des informations sur les participants qui ont assisté à une conférence passée ou qui participent à une conférence active, ainsi que sur leur session, à l'aide de l'API REST Google Meet.
Un participant est une personne qui a rejoint un appel, qui utilise le mode Compagnon, qui regarde en tant que spectateur ou qui utilise un appareil de salle connecté à un appel. Il existe une
participants
ressource pour chaque personne.
Une session de participant
est un ID de session unique créé pour chaque paire participant-appareil qui rejoint un
appel. Il existe une
participantSessions
ressource pour chaque session. Si le participant rejoint le même appel plusieurs fois à partir de la même paire participant-appareil, un ID de session unique lui est attribué à chaque fois.
Si vous êtes propriétaire ou participant d'un espace de réunion, vous pouvez appeler les méthodes get et list sur les ressources participants et participantSessions pour récupérer les enregistrements des participants.
L'authentification et l'autorisation avec identifiants utilisateur permettent aux applications Google Meet d'accéder aux données utilisateur et d'effectuer des opérations pour le compte de l'utilisateur authentifié. L'authentification avec délégation à l'échelle du domaine vous permet d'autoriser le compte de service d'une application à accéder aux données de vos utilisateurs sans que chacun d'entre eux ait à donner son consentement.
Participants
Les sections suivantes expliquent comment obtenir des informations sur les participants dans un enregistrement de conférence.
La
participants
ressource est associée au user champ. Un user ne peut être que l'un des objets suivants :
Un
signedinUserest l'un des éléments suivants :Une personne qui participe depuis un ordinateur personnel, un appareil mobile ou via le mode Compagnon.
Un compte de robot utilisé par les appareils de salle de conférence.
Un
anonymousUserest un utilisateur non identifié qui n'est pas connecté à un compte Google.Un
phoneUserest un utilisateur qui appelle depuis un téléphone et dont l'identité est inconnue car il ne s'est pas connecté avec un compte Google.
Notez que, bien que les trois objets renvoient un displayName, signedinUser renvoie également un identifiant unique user qui est interopérable avec l'API SDK Admin et l'API People. Format: users/{user}. Pour en savoir plus sur l'utilisation de l'user
ID avec l'API People, consultez Récupérer les informations sur les participants avec l'
API People.
Obtenir des informations sur un participant
Pour obtenir des informations sur un participant spécifique, utilisez la
get
méthode sur la
participants
ressource. Définissez le paramètre de chemin name au format conferenceRecords/{conferenceRecord}/participants/{participantRecord}.
Si vous ne connaissez pas le nom du participant, vous pouvez lister tous les noms des participants à l'aide de la méthode list.
La méthode renvoie les données d'un participant sous la forme d'une instance d'une ressource participants.
L'exemple de code suivant montre comment récupérer un participant spécifique :
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/CONFERENCE_RECORD_NAME/participants/PARTICIPANT_NAME" \
-H "Authorization: Bearer ACCESS_TOKEN"
Remplacez ACCESS_TOKEN par le jeton d'accès qui autorise l'accès à l'API.
Remplacez les éléments suivants :
- Le nom de l'enregistrement de la conférence par le nom de l'ID de conférence spécifique dans un enregistrement de conférence.
- Le nom du participant par le nom de l'ID de participant spécifique dans un enregistrement de conférence.
Lister tous les participants
Pour lister les informations sur tous les participants dans un enregistrement de conférence, utilisez la
list
méthode sur la
participants
ressource. Définissez le paramètre de chemin parent au format conferenceRecords/{conferenceRecord}.
La méthode renvoie une liste des participants à la conférence, classés par ordre décroissant de earliestStartTime, sous la forme d'une instance d'une ressource participants. Pour ajuster la taille de la page et filtrer les résultats de la requête, consultez Personnaliser
la pagination ou filtrer la liste des participants.
L'exemple de code suivant montre comment lister tous les participants dans un enregistrement de conférence :
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/PARENT_NAME/participants" \
-H "Authorization: Bearer ACCESS_TOKEN"
Remplacez ACCESS_TOKEN par le jeton d'accès qui autorise l'accès à l'API.
Remplacez le nom parent par le nom de l'ID de conférence spécifique dans un enregistrement de conférence.
Personnaliser la pagination ou filtrer la liste des participants
Transmettez les paramètres de requête suivants pour personnaliser la pagination ou filtrer les participants :
pageSize: nombre maximal de participants à renvoyer. Le service peut renvoyer une valeur inférieure. Si aucune valeur n'est spécifiée, 100 participants au maximum sont renvoyés. La valeur maximale est 250. Les valeurs supérieures à 250 sont automatiquement remplacées par 250.pageToken: jeton de page reçu lors d'un appel de liste précédent. Fournissez ce jeton pour récupérer la page suivante.filter: facultatif. Filtre de requête permettant de récupérer des éléments spécifiques dans les résultats de la ressourceparticipants.Vous pouvez utiliser les champs
earliestStartTimeoulatestEndTimepour filtrer les utilisateurs qui ont rejoint la conférence avant ou qui l'ont quittée après une certaine heure. Les deux champs utilisent le format Timestamp au format RFC 3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux :{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Exemple :earliestStartTime < 2023-10-01T15:01:23ZlatestEndTime < 2023-10-01T15:01:23Z
Pour lister tous les participants actifs dans une conférence existante, utilisez
latestEndTime IS NULL.
Récupérer les informations sur les participants avec l'API People
Pour récupérer des informations sur un participant, utilisez la
get méthode sur la
people ressource de l'API People.
Extrayez l'ID de la personne à partir de la ressource
participantà l'aide du composant final du chemin d'accès. Par exemple, si la ressourceparticipantvaleur estconferenceRecords/abc-123/participants/12345, l'ID de l'API People est12345.Incluez le
READ_SOURCE_TYPE_PROFILE, leREAD_SOURCE_TYPE_CONTACT, etREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceType. Cela permet de s'assurer que les utilisateurs internes d'une organisation Google Workspace et les contacts externes sont inclus dans la réponse.
L'exemple de code suivant montre comment rechercher une personne dans les profils et les contacts de l'organisation :
cURL
curl \
'https://people.googleapis.com/v1/people/PERSON_ID?personFields=names%2CemailAddresses&sources=READ_SOURCE_TYPE_OTHER_CONTACT&sources=READ_SOURCE_TYPE_PROFILE&sources=READ_SOURCE_TYPE_CONTACT' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed
Remplacez les éléments suivants :
- PERSON_ID : ID de la personne à trouver.
- ACCESS_TOKEN : jeton d'accès qui autorise l'accès à plusieurs API.
Sessions de participants
Les sections suivantes expliquent comment obtenir des informations sur les sessions d'un participant dans un enregistrement de conférence.
Obtenir des informations sur une session de participant
Pour obtenir des informations sur une session de participant spécifique, utilisez la
get
méthode sur la
participantSessions
ressource. Définissez le paramètre de chemin name au format conferenceRecords/{conferenceRecord}/participants/{participantRecord}/participantSessions/{participantSessionRecord}.
Si vous ne connaissez pas le nom de la session du participant, vous pouvez lister toutes les sessions
d'un participant à l'aide de la méthode list.
La méthode renvoie le nom d'un participant sous la forme d'une instance d'une ressource participantSessions.
L'exemple de code suivant montre comment récupérer une session de participant spécifique :
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/CONFERENCE_RECORD_NAME/participants/PARTICIPANT_NAME/participantSessions/PARTICIPANT_SESSION_ID" \
-H "Authorization: Bearer ACCESS_TOKEN"
Remplacez ACCESS_TOKEN par le jeton d'accès qui autorise l'accès à l'API.
Remplacez les éléments suivants :
- Le nom de l'enregistrement de la conférence par le nom de l'ID de conférence spécifique dans un enregistrement de conférence.
- Le nom du participant par le nom de l'ID de participant spécifique dans un enregistrement de conférence.
- L'ID de session du participant par l'ID de la session de participant spécifique.
Lister toutes les sessions de participants
Pour lister les informations sur toutes les sessions d'un participant dans un enregistrement de conférence, utilisez la
list()
méthode sur la
participantSessions
ressource. Définissez le paramètre de chemin parent au format conferenceRecords/{conferenceRecord}/participants/{participantRecord}.
La méthode renvoie une liste des sessions de participants, classées par ordre décroissant de startTime, sous la forme d'une instance d'une ressource participantSession. Pour ajuster
la taille de la page et filtrer les résultats de la requête, consultez Personnaliser la pagination ou filtrer
la liste des sessions de participants.
L'exemple de code suivant montre comment lister toutes les sessions de participants dans un enregistrement de conférence :
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/CONFERENCE_RECORD_NAME/participants/PARENT_NAME/participantSessions" \
-H "Authorization: Bearer ACCESS_TOKEN"
Remplacez ACCESS_TOKEN par le jeton d'accès qui autorise l'accès à l'API.
Remplacez les éléments suivants :
- Le nom de l'enregistrement de la conférence par le nom de l'ID de conférence spécifique dans un enregistrement de conférence.
- Le nom parent par le nom des sessions d'un participant dans un enregistrement de conférence.
Personnaliser la pagination ou filtrer la liste des sessions de participants
Transmettez les paramètres de requête facultatifs suivants pour personnaliser la pagination ou filtrer les sessions de participants :
pageSize: nombre maximal de sessions de participants à renvoyer. Le service peut renvoyer une valeur inférieure. Si aucune valeur n'est spécifiée, 100 sessions de participants au maximum sont renvoyées. La valeur maximale est 250. Les valeurs supérieures à 250 sont automatiquement remplacées par 250.pageToken: jeton de page reçu lors d'un appel de liste précédent. Fournissez ce jeton pour récupérer la page suivante.filter: facultatif. Filtre de requête permettant de récupérer des éléments spécifiques dans les résultats de la ressourceparticipants.Vous pouvez utiliser les champs
startTimeouendTimepour filtrer les utilisateurs qui ont rejoint la conférence avant ou qui l'ont quittée après une certaine heure. Les deux champs utilisent le format Timestamp au format RFC 3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux :{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Exemple :startTime < 2023-10-01T15:01:23ZendTime < 2023-10-01T15:01:23Z
Pour lister toutes les sessions de participants actives dans l'enregistrement de la conférence, utilisez
endTime IS NULL.