In diesem Leitfaden wird erläutert, wie Sie mit der Google Meet REST API Details zu Teilnehmern abrufen, die an einer vergangenen Konferenz teilgenommen haben oder sich in einer aktiven Konferenz befinden, sowie Informationen zu ihren Sitzungen.
Ein Teilnehmer ist eine Person,
die an einem Anruf teilgenommen hat oder den Companion
Modus verwendet, als Zuschauer teilnimmt oder
ein Raumgerät verwendet, das mit einem Anruf verbunden ist. Für jede Person gibt es eine
participants
Ressource.
Eine Teilnehmersitzung
ist eine eindeutige Sitzungs-ID, die für jedes Teilnehmer-Gerät-Paar erstellt wird, das an einem
Anruf teilnimmt. Für jede Sitzung gibt es eine
participantSessions
Ressource. Wenn der Teilnehmer mehrmals über dasselbe Teilnehmer-Gerät-Paar an demselben Anruf teilnimmt, werden ihm jeweils eindeutige Sitzungs-IDs zugewiesen.
Als Inhaber oder Teilnehmer eines Besprechungsraums können Sie die Methoden get und list sowohl für die Ressourcen participants als auch für participantSessions aufrufen, um Teilnehmerdatensätze abzurufen.
Durch die Authentifizierung und Autorisierung mit Nutzer anmeldedaten können Google Meet-Apps auf Nutzerdaten zugreifen und Vorgänge im Namen des authentifizierten Nutzers ausführen. Durch die Authentifizierung mit der domainweiten Übertragung können Sie das Dienstkonto einer Anwendung autorisieren, auf die Daten Ihrer Nutzer zuzugreifen, ohne dass diese einzeln ihre Einwilligung geben müssen.
Teilnehmer
In den folgenden Abschnitten wird beschrieben, wie Sie Informationen zu Teilnehmern in einem Konferenzdatensatz abrufen.
Die
participants
Ressource wird mit dem user Feld verknüpft. Ein user kann nur eines der folgenden Objekte sein:
Ein
signedinUserist entweder:Eine Person, die über einen Computer, ein Mobilgerät oder den Companion-Modus teilnimmt.
Ein Roboterkonto, das von Konferenzraumgeräten verwendet wird.
Ein
anonymousUserist ein nicht identifizierter Nutzer, der nicht in einem Google-Konto angemeldet ist.A
phoneUserist ein Nutzer, der sich über ein Telefon einwählt, bei dem die Identität des Nutzers unbekannt ist, da er sich nicht mit einem Google-Konto angemeldet hat.
Alle drei Objekte geben einen displayName zurück, aber signedinUser gibt auch eine eindeutige user-ID zurück, die mit der Admin SDK API und der People API kompatibel ist. Format: users/{user}. Weitere Informationen zur Verwendung der user
ID mit der People API finden Sie unter Teilnehmerdetails mit der
People API abrufen.
Details zu einem Teilnehmer abrufen
Wenn Sie Details zu einem bestimmten Teilnehmer abrufen möchten, verwenden Sie die
get
Methode für die
participants
Ressource. Legen Sie den Pfadparameter name im Format conferenceRecords/{conferenceRecord}/participants/{participantRecord} fest.
Wenn Sie den Namen des Teilnehmers nicht kennen, können Sie alle Teilnehmer
namen mit der Methode list auflisten.
Die Methode gibt Teilnehmerdaten als Instanz einer participants-Ressource zurück.
Das folgende Codebeispiel zeigt, wie Sie einen bestimmten Teilnehmer abrufen:
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"
Ersetzen Sie ACCESS_TOKEN durch das Zugriffstoken, das Zugriff auf die API gewährt.
Ersetzen Sie Folgendes:
- Den Namen des Konferenzdatensatzes durch den Namen der spezifischen Konferenz-ID in einem Konferenzdatensatz.
- Den Namen des Teilnehmers durch den Namen der spezifischen Teilnehmer-ID in einem Konferenzdatensatz.
Alle Teilnehmer auflisten
Wenn Sie Details zu allen Teilnehmern in einem Konferenzdatensatz auflisten möchten, verwenden Sie die
list
Methode für die
participants
Ressource. Legen Sie den Pfadparameter parent im Format conferenceRecords/{conferenceRecord} fest.
Die Methode gibt eine Liste der Konferenzteilnehmer zurück, sortiert nach earliestStartTime in absteigender Reihenfolge, als Instanz einer participants-Ressource. Informationen zum Anpassen der Seitengröße und zum Filtern der Abfrageergebnisse finden Sie unter Paginierung anpassen
oder Teilnehmerliste filtern.
Das folgende Codebeispiel zeigt, wie Sie alle Teilnehmer in einem Konferenzdatensatz auflisten:
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/PARENT_NAME/participants" \
-H "Authorization: Bearer ACCESS_TOKEN"
Ersetzen Sie ACCESS_TOKEN durch das Zugriffstoken, das Zugriff auf die API gewährt.
Ersetzen Sie den übergeordneten Namen durch den Namen der spezifischen Konferenz-ID in einem Konferenzdatensatz.
Paginierung anpassen oder Teilnehmerliste filtern
Übergeben Sie die folgenden Abfrageparameter, um die Paginierung anzupassen oder Teilnehmer zu filtern:
pageSize: Die maximale Anzahl der zurückzugebenden Teilnehmer. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Teilnehmer zurückgegeben. Der Maximalwert ist 250. Werte über 250 werden automatisch in 250 geändert.pageToken: Ein Seitentoken, das von einem vorherigen Listenaufruf empfangen wurde. Geben Sie dieses Token an, um die nächste Seite abzurufen.filter: Optional. Ein Abfragefilter, um bestimmte Elemente in den Ergebnissen der Ressourceparticipantsabzurufen.Mit den Feldern
earliestStartTimeoderlatestEndTimekönnen Sie nach Nutzern filtern, die vor einem bestimmten Zeitpunkt beigetreten sind oder nach einem bestimmten Zeitpunkt gegangen sind. Beide Felder verwenden das Zeitstempelformat im RFC 3339 UTC „Zulu“- Format mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Beispiel:earliestStartTime < 2023-10-01T15:01:23ZlatestEndTime < 2023-10-01T15:01:23Z
Verwenden Sie
latestEndTime IS NULL, um alle aktiven Teilnehmer in einer vorhandenen Konferenz aufzulisten.
Teilnehmerdetails mit der People API abrufen
Wenn Sie Details zu einem Teilnehmer abrufen möchten, verwenden Sie die
get Methode für die
people Ressource in der People API.
Extrahieren Sie die ID der Person aus der Ressource
participantmit der letzten Komponente des Pfads. Wenn der Wert der RessourceparticipantbeispielsweiseconferenceRecords/abc-123/participants/12345ist, lautet die ID für die People API12345.Fügen Sie
READ_SOURCE_TYPE_PROFILE,READ_SOURCE_TYPE_CONTACTundREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceTypeein. So wird sichergestellt, dass sowohl interne Nutzer einer Google Workspace-Organisation als auch externe Kontakte in der Antwort enthalten sind.
Das folgende Codebeispiel zeigt, wie Sie sowohl in Organisationsprofilen als auch in Kontakten nach einer Person suchen:
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
Ersetzen Sie Folgendes:
- PERSON_ID: die ID der Person, die gesucht werden soll.
- ACCESS_TOKEN: das Zugriffstoken, das Zugriff auf mehrere APIs gewährt.
Teilnehmersitzungen
In den folgenden Abschnitten wird beschrieben, wie Sie Informationen zu Teilnehmersitzungen eines Teilnehmers in einem Konferenzdatensatz abrufen.
Details zu einer Teilnehmersitzung abrufen
Wenn Sie Details zu einer bestimmten Teilnehmersitzung abrufen möchten, verwenden Sie die
get
Methode für die
participantSessions
Ressource. Legen Sie den Pfadparameter name im Format conferenceRecords/{conferenceRecord}/participants/{participantRecord}/participantSessions/{participantSessionRecord} fest.
Wenn Sie den Namen der Teilnehmersitzung nicht kennen, können Sie alle Teilnehmersitzungen eines Teilnehmers mit der Methode list auflisten.
Die Methode gibt einen Teilnehmernamen als Instanz einer participantSessions-Ressource zurück.
Das folgende Codebeispiel zeigt, wie Sie eine bestimmte Teilnehmersitzung abrufen:
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"
Ersetzen Sie ACCESS_TOKEN durch das Zugriffstoken, das Zugriff auf die API gewährt.
Ersetzen Sie Folgendes:
- Den Namen des Konferenzdatensatzes durch den Namen der spezifischen Konferenz-ID in einem Konferenzdatensatz.
- Den Namen des Teilnehmers durch den Namen der spezifischen Teilnehmer-ID in einem Konferenzdatensatz.
- Die ID der Teilnehmersitzung durch die ID der spezifischen Teilnehmersitzung.
Alle Teilnehmersitzungen auflisten
Wenn Sie Details zu allen Teilnehmersitzungen eines Teilnehmers in einem Konferenz
datensatz auflisten möchten, verwenden Sie die
list()
Methode für die
participantSessions
Ressource. Legen Sie den Pfadparameter parent im Format conferenceRecords/{conferenceRecord}/participants/{participantRecord} fest.
Die Methode gibt eine Liste der Teilnehmersitzungen zurück, sortiert nach startTime in absteigender Reihenfolge, als Instanz einer participantSession-Ressource. Informationen zum Anpassen
der Seitengröße und zum Filtern der Abfrageergebnisse finden Sie unter Paginierung anpassen oder filtern
Sie die Liste der Teilnehmersitzungen.
Das folgende Codebeispiel zeigt, wie Sie alle Teilnehmersitzungen in einem Konferenzdatensatz auflisten:
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"
Ersetzen Sie ACCESS_TOKEN durch das Zugriffstoken, das Zugriff auf die API gewährt.
Ersetzen Sie Folgendes:
- Den Namen des Konferenzdatensatzes durch den Namen der spezifischen Konferenz-ID in einem Konferenzdatensatz.
- Den übergeordneten Namen durch den Namen der Teilnehmersitzungen eines Teilnehmers in einem Konferenzdatensatz.
Paginierung anpassen oder Liste der Teilnehmersitzungen filtern
Übergeben Sie die folgenden optionalen Abfrageparameter, um die Paginierung anzupassen oder Teilnehmersitzungen zu filtern:
pageSize: Die maximale Anzahl der zurückzugebenden Teilnehmersitzungen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Teilnehmersitzungen zurückgegeben. Der Maximalwert ist 250. Werte über 250 werden automatisch in 250 geändert.pageToken: Ein Seitentoken, das von einem vorherigen Listenaufruf empfangen wurde. Geben Sie dieses Token an, um die nächste Seite abzurufen.filter: Optional. Ein Abfragefilter, um bestimmte Elemente in den Ergebnissen der Ressourceparticipantsabzurufen.Mit den Feldern
startTimeoderendTimekönnen Sie nach Nutzern filtern, die vor einem bestimmten Zeitpunkt beigetreten sind oder nach einem bestimmten Zeitpunkt gegangen sind. Beide Felder verwenden das Zeitstempelformat im RFC 3339 UTC „Zulu“- Format mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Beispiel:startTime < 2023-10-01T15:01:23ZendTime < 2023-10-01T15:01:23Z
Verwenden Sie
endTime IS NULL, um alle aktiven Teilnehmersitzungen im Konferenzdatensatz aufzulisten.