Este guia explica como conferir detalhes sobre os participantes que compareceram a 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 entrou em uma
chamada ou que usa o modo
companion, assistindo como espectador ou
um dispositivo de sala conectado a uma chamada. Há um recurso
participants
para cada pessoa.
Uma sessão de participante é um
ID de sessão exclusivo criado para cada par de participante-dispositivo que entra em uma chamada.
Há um recurso
participantSessions
para cada sessão. Se o participante entrar na mesma chamada várias vezes
do mesmo par de participante-dispositivo, cada um deles receberá IDs de sessão exclusivos.
Se você for proprietário ou participante do espaço de reunião, poderá chamar os métodos get()
e
list()
nos recursos participants
e participantSessions
para extrair os registros dos participantes.
A autenticação e autorização com credenciais do usuário permite 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 a delegação em todo o domínio permite autorizar a conta de serviço de um aplicativo a acessar os dados dos seus usuários sem precisar de consentimento.
Participantes
As seções a seguir detalham como receber informações sobre os participantes em um registro de conferência.
O recurso participants
é unificado com o campo user
. Um user
pode ser apenas um dos seguintes
objetos:
Um
signedinUser
pode ser: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ências.
Um
anonymousUser
é um usuário não identificado que não fez login em uma Conta do Google.Um
phoneUser
é um usuário que está ligando de um telefone em que a identidade é desconhecida porque ele não fez login com uma Conta do Google.
Embora os três objetos retornem um displayName
, o signedinUser
também
retorna um ID user
exclusivo que é compatível com a API Admin SDK e a
API People. Formato: users/{user}
. Para mais informações sobre como usar o ID user
com a API People, consulte Extrair detalhes do participante com a
API People.
Conferir detalhes sobre um participante
Para conferir detalhes sobre um participante específico, use o método get()
no recurso participants
com o parâmetro de caminho name
. Se você não souber o nome do participante,
listar todos os nomes dos participantes usando o método list()
.
O método retorna dados de participantes 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
Substitua o nome do participante pelo nome do ID do 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 método
list()
no recurso
participants
com o parâmetro de caminho parent
. 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 abaixo mostra como listar todos os participantes em um registro de conferência:
Java
Node.js
Python
Substitua o valor pai pelo nome do registro da 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 participantes:
pageSize
: o número máximo de participantes a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 100 participantes serão retornados. O valor máximo é 250. Valores maiores que 250 são automaticamente alterados para 250.pageToken
: um token de página recebido de uma chamada de lista anterior. Informe este 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
earliestStartTime
oulatestEndTime
para filtrar os usuários que entraram antes ou saíram depois de um determinado período. Ambos os campos usam o formato 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:23Z
latestEndTime < 2023-10-01T15:01:23Z
Para listar todos os participantes ativos em uma conferência, use
latestEndTime IS NULL
.
Extrair detalhes do participante com a API People
Para recuperar detalhes sobre um participante, use o método
get()
no recurso
people
na API People.
Extraia o ID da pessoa do recurso
participant
usando o componente final do caminho. Por exemplo, se o valor do recursoparticipant
forconferenceRecords/abc-123/participants/12345
, o ID da API People será12345
.Inclua
READ_SOURCE_TYPE_PROFILE
,READ_SOURCE_TYPE_CONTACT
eREAD_SOURCE_TYPE_OTHER_CONTACT
ReadSourceType
. 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 abaixo mostra como pesquisar os perfis de organização e os contatos 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 um participante em um registro de conferência.
Conferir detalhes sobre uma sessão de participante
Para conferir detalhes sobre uma sessão de participante específica, use o método
get()
no recurso
participantSessions
com o parâmetro de caminho name
. Se você não souber o nome da sessão
do participante, 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 abaixo mostra como recuperar uma sessão de participante específica:
Java
Node.js
Python
Substitua o nome do participante pelo nome do ID da sessão do participante específico em uma sessão de participante.
Listar todas as sessões de participantes
Para listar detalhes sobre todas as sessões de um participante em um registro de conferência, use o método
list()
no recurso
participantSessions
com o parâmetro de caminho parent
. Formato:
conferenceRecords/{conferenceRecord}/participants/{participant}
.
O método retorna uma lista de sessões de participantes, ordenadas 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 paginação ou filtrar
a lista de sessões de participantes.
O exemplo de código abaixo mostra como listar todas as sessões de participantes em um registro de conferência:
Java
Node.js
Python
Substitua o valor pai pelo nome das sessões 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 participante a serem retornadas. O serviço pode retornar menos que esse valor. 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. Informe este 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
startTime
ouendTime
para filtrar usuários que se inscreveram antes ou saíram após um determinado período. Ambos os campos usam o formato 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:23Z
endTime < 2023-10-01T15:01:23Z
Para listar todas as sessões de participantes ativas no registro de conferência, use
endTime IS NULL
.