In diesem Leitfaden wird beschrieben, wie Sie mit der Google Meet REST API Details zu Teilnehmern abrufen, die an einer vergangenen Videokonferenz teilgenommen haben oder sich in einer aktiven Videokonferenz befinden, sowie deren Sitzungsinformationen.
Ein Teilnehmer ist eine Person, die an einem Anruf teilnimmt, den Companion-Modus verwendet, als Zuschauer teilnimmt oder ein Raumgerät, 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 Teilnehmergerät erstellt wird, das an einem Anruf teilnimmt.
Für jede Sitzung gibt es eine participantSessions
-Ressource. Wenn der Teilnehmer mehrmals über dasselbe Teilnehmer-Geräte-Paar an demselben Anruf teilnimmt, wird ihm jeweils eine eindeutige Sitzungs-ID zugewiesen.
Als Inhaber oder Teilnehmer eines Besprechungsbereichs können Sie die Methoden get()
und list()
sowohl für die Ressource participants
als auch für die Ressource participantSessions
aufrufen, um Teilnehmerdatensätze abzurufen.
Durch die Authentifizierung und Autorisierung mit Nutzeranmeldedaten können Google Meet-Apps auf Nutzerdaten zugreifen und Vorgänge im Namen des authentifizierten Nutzers ausführen. Durch die Authentifizierung mit domainweiter Delegierung können Sie das Dienstkonto einer Anwendung autorisieren, auf die Daten Ihrer Nutzer zuzugreifen, ohne dass jeder Nutzer seine Einwilligung geben muss.
Teilnehmer
In den folgenden Abschnitten wird beschrieben, wie Sie Informationen zu Teilnehmern in einem Konferenzdatensatz abrufen.
Die Ressource participants
wird mit dem Feld user
zusammengeführt. Ein user
kann nur eines der folgenden Objekte sein:
Ein
signedinUser
kann Folgendes sein:Eine Person, die über einen Computer, ein Mobilgerät oder im Companion-Modus teilnimmt.
Ein Robot-Konto, das von Konferenzraumgeräten verwendet wird.
Ein
anonymousUser
ist ein nicht identifizierter Nutzer, der nicht in einem Google-Konto angemeldet ist.Ein
phoneUser
ist 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 zwar ein displayName
zurück, signedinUser
gibt aber 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 Methode get()
für die Ressource participants
mit dem Pfadparameter name
. Wenn Sie den Namen des Teilnehmers nicht kennen, können Sie mit der Methode list()
alle Namen der Teilnehmer 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
Ersetzen Sie den Namen des Teilnehmers durch den Namen der jeweiligen Teilnehmer-ID in einem Konferenzdatensatz.
Alle Teilnehmer auflisten
Wenn Sie Details zu allen Teilnehmern in einem Konferenzdatensatz auflisten möchten, verwenden Sie die Methode list()
für die Ressource participants
mit dem Pfadparameter parent
. Format:
conferenceRecords/{conferenceRecord}
.
Die Methode gibt eine Liste der Konferenzteilnehmer zurück, die nach earliestStartTime
in absteigender Reihenfolge sortiert sind, 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 eines Konferenzdatensatzes auflisten:
Java
Node.js
Python
Ersetzen Sie den übergeordneten Wert durch den Namen des Konferenzdatensatzes.
Paginierung anpassen oder Teilnehmerliste filtern
Übergeben Sie die folgenden Abfrageparameter, um die Paginierung von Teilnehmern 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 Höchstwert beträgt 250. Werte über 250 werden automatisch auf 250 geändert.pageToken
: Ein Seitentoken, das von einem vorherigen Listenaufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.filter
: Optional. Ein Abfragefilter zum Abrufen bestimmter Elemente in den Ergebnissen derparticipants
-Ressource.Mit den Feldern
earliestStartTime
oderlatestEndTime
können Sie nach Nutzern filtern, die vor oder nach einem bestimmten Zeitpunkt beigetreten oder gegangen sind. Für beide Felder wird das Zeitstempel-Format im RFC 3339-UTC-Format „Zulu“ mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen verwendet:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z
. Beispiel:earliestStartTime < 2023-10-01T15:01:23Z
latestEndTime < 2023-10-01T15:01:23Z
Verwenden Sie
latestEndTime IS NULL
, um alle aktiven Teilnehmer einer bestehenden Videokonferenz aufzulisten.
Teilnehmerdetails mit der People API abrufen
Wenn Sie Details zu einem Teilnehmer abrufen möchten, verwenden Sie die Methode get()
für die Ressource people
in der People API.
Extrahieren Sie die ID der Person aus der
participant
-Ressource mit der nachgestellten Komponente des Pfads. Wenn der Wert der Ressourceparticipant
beispielsweiseconferenceRecords/abc-123/participants/12345
ist, lautet die ID für die People API12345
.Fügen Sie die Attribute
READ_SOURCE_TYPE_PROFILE
,READ_SOURCE_TYPE_CONTACT
undREAD_SOURCE_TYPE_OTHER_CONTACT
ReadSourceType
hinzu. So wird sichergestellt, dass sowohl interne Nutzer einer Google Workspace-Organisation als auch externe Kontakte in die Antwort einbezogen werden.
Das folgende Codebeispiel zeigt, wie Sie sowohl Organisationsprofile als auch Kontakte nach einer Person durchsuchen:
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 den Teilnehmersitzungen eines Teilnehmers in einem Konferenzdatensatz abrufen.
Details zu einer Teilnehmersitzung abrufen
Wenn Sie Details zu einer bestimmten Teilnehmer-Sitzung abrufen möchten, verwenden Sie die Methode get()
für die Ressource participantSessions
mit dem Pfadparameter name
. Wenn Sie den Namen der Teilnehmersitzung nicht kennen, können Sie alle Teilnehmersitzungen eines Teilnehmers auflisten, indem Sie die Methode list()
verwenden.
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
Ersetzen Sie den Teilnehmernamen durch die ID der jeweiligen Teilnehmer-Sitzung in einer Teilnehmer-Sitzung.
Alle Sitzungen von Teilnehmern auflisten
Wenn Sie Details zu allen Teilnehmersitzungen eines Teilnehmers in einer Konferenzaufzeichnung auflisten möchten, verwenden Sie die Methode list()
für die Ressource participantSessions
mit dem Pfadparameter parent
. Format:
conferenceRecords/{conferenceRecord}/participants/{participant}
.
Die Methode gibt eine Liste von Teilnehmersitzungen zurück, die nach startTime
in absteigender Reihenfolge sortiert sind, als Instanz einer participantSession
-Ressource. Informationen zum Anpassen der Seitengröße und zum Filtern der Abfrageergebnisse finden Sie unter Paginierung anpassen oder Teilnehmer-Sitzungsliste filtern.
Das folgende Codebeispiel zeigt, wie Sie alle Teilnehmersitzungen in einem Konferenzdatensatz auflisten:
Java
Node.js
Python
Ersetzen Sie den übergeordneten Wert durch den Namen der Teilnehmersitzungen eines Teilnehmers in einem Konferenzdatensatz.
Paginierung anpassen oder die Liste der Teilnehmersitzungen filtern
Sie können die folgenden optionalen Abfrageparameter übergeben, um die Paginierung von Teilnehmersitzungen anzupassen oder sie zu filtern:
pageSize
: Die maximale Anzahl der zurückzugebenden Teilnehmersitzungen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Falls nicht angegeben, werden maximal 100 Teilnehmersitzungen zurückgegeben. Der Höchstwert beträgt 250. Werte über 250 werden automatisch auf 250 geändert.pageToken
: Ein Seitentoken, das von einem vorherigen Listenaufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.filter
: Optional. Ein Abfragefilter zum Abrufen bestimmter Elemente in den Ergebnissen derparticipants
-Ressource.Mit den Feldern
startTime
oderendTime
können Sie nach Nutzern filtern, die vor oder nach einem bestimmten Zeitpunkt beigetreten oder gegangen sind. Für beide Felder wird das Zeitstempel-Format im RFC 3339-UTC-Format „Zulu“ mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen verwendet:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z
. Beispiel:startTime < 2023-10-01T15:01:23Z
endTime < 2023-10-01T15:01:23Z
Verwenden Sie
endTime IS NULL
, um alle aktiven Teilnehmersitzungen im Konferenzdatensatz aufzulisten.