Este guia explica como receber detalhes sobre os participantes que estiveram em uma conferência anterior ou que estão em uma conferência ativa, além das informações da sessão, usando a API REST do Google Meet.
Um participante é uma pessoa
que participa de uma chamada ou usa o modo Companion, assistindo como espectador, ou
um dispositivo de sala conectado a uma chamada. Há um
participants
recurso para cada pessoa.
Uma sessão de participante
é um ID de sessão exclusivo criado para cada par participante-dispositivo que participa de uma
chamada. Há um
participantSessions
recurso para cada sessão. Se o participante participar da mesma chamada várias vezes com o mesmo par participante-dispositivo, cada um receberá IDs de sessão exclusivos.
Se você for proprietário ou participante de um espaço para reuniões, poderá chamar os métodos get e list nos recursos participants e participantSessions para recuperar registros de participantes.
A autenticação e a autorização com credenciais de usuário permitem que os apps do Google Meet acessem dados do usuário e realizem operações em nome do usuário autenticado. A autenticação com delegação em todo o domínio permite autorizar a conta de serviço de um aplicativo a acessar os dados dos usuários sem precisar pedir o consentimento de cada um.
Participantes
As seções a seguir detalham como receber informações sobre os participantes em um registro de conferência.
O recurso
participants
é unido ao campo user. Um user pode ser apenas um dos seguintes objetos:
Um
signedinUseré:Uma pessoa que participa de um computador pessoal, um dispositivo móvel ou pelo modo companion.
Uma conta de robô usada por dispositivos de sala de conferência.
Um
anonymousUseré um usuário não identificado que não fez login em uma Conta do Google.A
phoneUseré um usuário que liga de um telefone em que a identidade do usuário é desconhecida porque ele não fez login com uma Conta do Google.
Embora todos os três objetos retornem um displayName, signedinUser também retorna um ID user exclusivo que é interoperável com a API Admin SDK e a API People. Formato: users/{user}. Para mais informações sobre como usar o user
ID com a API People, consulte Recuperar detalhes do participante com a
API People.
Receber detalhes sobre um participante
Para receber detalhes sobre um participante específico, use o
get
método no
participants
recurso. Defina o parâmetro de caminho name usando o formato conferenceRecords/{conferenceRecord}/participants/{participantRecord}.
Se você não souber o nome do participante, poderá listar todos os nomes de participantes usando o método list.
O método retorna os dados do participante como uma instância de um recurso participants.
O exemplo de código a seguir mostra como recuperar um participante específico:
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"
Substitua ACCESS_TOKEN pelo token de acesso que concede acesso à API.
Substitua:
- O nome do registro de conferência pelo nome do ID da reunião específico em um registro de conferência.
- O nome do participante pelo nome do ID de participante específico em um registro de conferência.
Listar todos os participantes
Para listar detalhes sobre todos os participantes em um registro de conferência, use o
list
método no
participants
recurso. Defina o parâmetro de caminho parent usando o formato conferenceRecords/{conferenceRecord}.
O método retorna uma lista de participantes da conferência, ordenada por earliestStartTime em ordem decrescente, como uma instância de um recurso participants. Para ajustar o tamanho da página e filtrar os resultados da consulta, consulte Personalizar
a paginação ou filtrar a lista de participantes.
O exemplo de código a seguir mostra como listar todos os participantes em um registro de conferência:
Java
Node.js
Python
cURL
curl -X GET "https://meet.googleapis.com/v2/conferenceRecords/PARENT_NAME/participants" \
-H "Authorization: Bearer ACCESS_TOKEN"
Substitua ACCESS_TOKEN pelo token de acesso que concede acesso à API.
Substitua o nome pai pelo nome do ID da reunião específico em um registro de conferência.
Personalizar a paginação ou filtrar a lista de participantes
Transmita os seguintes parâmetros de consulta para personalizar a paginação ou filtrar os participantes:
pageSize: o número máximo de participantes a serem retornados. O serviço pode retornar um valor menor do que esse. Se não for especificado, no máximo 100 participantes serão retornados. O valor máximo é 250. Valores maiores que 250 são alterados automaticamente para 250.pageToken: um token de página, recebido de uma chamada de lista anterior. Forneça esse token para recuperar a página seguinte.filter: opcional. Um filtro de consulta para recuperar itens específicos nos resultados do recursoparticipants.É possível usar os campos
earliestStartTimeoulatestEndTimepara filtrar usuários que participaram antes ou saíram depois de um determinado horário. Os dois campos usam o formato de carimbo de data/hora no formato UTC "Zulu" RFC 3339, com resolução de nanossegundos e até nove dígitos fracionários:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Exemplo:earliestStartTime < 2023-10-01T15:01:23ZlatestEndTime < 2023-10-01T15:01:23Z
Para listar todos os participantes ativos em uma conferência, use
latestEndTime IS NULL.
Recuperar detalhes do participante com a API People
Para recuperar detalhes sobre um participante, use o
get método no
people recurso da API People.
Extraia o ID da pessoa do recurso
participantusando o componente final do caminho. Por exemplo, se o valor do recursoparticipantforconferenceRecords/abc-123/participants/12345o ID da API People é12345.Inclua
READ_SOURCE_TYPE_PROFILE,READ_SOURCE_TYPE_CONTACTeREAD_SOURCE_TYPE_OTHER_CONTACTReadSourceType. Isso garante que os usuários internos de uma organização do Google Workspace e os contatos externos sejam incluídos na resposta.
O exemplo de código a seguir mostra como pesquisar perfis e contatos da organização de uma pessoa:
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
Substitua:
- PERSON_ID: o ID da pessoa a ser encontrada.
- ACCESS_TOKEN: o token de acesso que concede acesso a várias APIs.
Sessões de participantes
As seções a seguir detalham como receber informações sobre as sessões de participantes de um participante em um registro de conferência.
Receber detalhes sobre uma sessão de participante
Para receber detalhes sobre uma sessão de participante específica, use o
get
método no
participantSessions
recurso. Defina o parâmetro de caminho name usando o formato conferenceRecords/{conferenceRecord}/participants/{participantRecord}/participantSessions/{participantSessionRecord}.
Se você não souber o nome da sessão do participante, poderá listar todas as sessões
de um participante usando o método list.
O método retorna um nome de participante como uma instância de um recurso participantSessions.
O exemplo de código a seguir mostra como recuperar uma sessão de participante específica:
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"
Substitua ACCESS_TOKEN pelo token de acesso que concede acesso à API.
Substitua:
- O nome do registro de conferência pelo nome do ID da reunião específico em um registro de conferência.
- O nome do participante pelo nome do ID de participante específico em um registro de conferência.
- O ID da sessão do participante pelo ID da sessão do participante específico.
Listar todas as sessões de participantes
Para listar detalhes sobre todas as sessões de participantes de um participante em um registro de conferência, use o
list()
método no
participantSessions
recurso. Defina o parâmetro de caminho parent usando o formato conferenceRecords/{conferenceRecord}/participants/{participantRecord}.
O método retorna uma lista de sessões de participantes, ordenada por startTime em ordem decrescente, como uma instância de um recurso participantSession. Para ajustar
o tamanho da página e filtrar os resultados da consulta, consulte Personalizar a paginação ou filtrar
a lista de sessões de participantes.
O exemplo de código a seguir mostra como listar todas as sessões de participantes em um registro de conferência:
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"
Substitua ACCESS_TOKEN pelo token de acesso que concede acesso à API.
Substitua:
- O nome do registro de conferência pelo nome do ID da reunião específico em um registro de conferência.
- O nome pai pelo nome das sessões de participantes de um participante em um registro de conferência.
Personalizar a paginação ou filtrar a lista de sessões de participantes
Transmita os seguintes parâmetros de consulta opcionais para personalizar a paginação ou filtrar as sessões de participantes:
pageSize: o número máximo de sessões de participantes a serem retornadas. O serviço pode retornar um valor menor do que esse. Se não for especificado, no máximo 100 sessões de participantes serão retornadas. O valor máximo é 250. Valores maiores que 250 são alterados automaticamente para 250.pageToken: um token de página, recebido de uma chamada de lista anterior. Forneça esse token para recuperar a página seguinte.filter: opcional. Um filtro de consulta para recuperar itens específicos nos resultados do recursoparticipants.É possível usar os campos
startTimeouendTimepara filtrar usuários que participaram antes ou saíram depois de um determinado horário. Os dois campos usam o formato de carimbo de data/hora no formato UTC "Zulu" RFC 3339, com resolução de nanossegundos e até nove dígitos fracionários:{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z. Exemplo:startTime < 2023-10-01T15:01:23ZendTime < 2023-10-01T15:01:23Z
Para listar todas as sessões de participantes ativas no registro de conferência, use
endTime IS NULL.