Este guia explica como usar a API REST do Google Meet para conferir detalhes sobre os participantes de uma conferência passada ou de uma conferência ativa, além das informações da sessão.
Um participante é uma pessoa que participa de uma chamada ou usa o modo companion, assiste como espectador ou usa 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 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
com o mesmo par participante-dispositivo, cada entrada vai receber IDs de sessão exclusivos.
Se você for proprietário ou participante de um espaço de reunião, 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 deles.
Participantes
As seções a seguir detalham como receber informações sobre os participantes de uma gravação de conferência.
O recurso participants
faz uniões com o campo user
. Um user
pode ser apenas um dos seguintes objetos:
Um
signedinUser
é:Uma pessoa que participa usando um computador pessoal, um dispositivo móvel ou o 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 smartphone em que a identidade dele é desconhecida porque não fez login com uma Conta do Google.
Embora todos os três objetos retornem um displayName
, o 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 ID user
com a API People, consulte Recuperar detalhes do participante com a API People.
Receber detalhes sobre um participante
Para ver 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, liste todos os nomes de participantes usando o método list()
.
O método retorna os dados de um 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
Substitua o nome do participante pelo ID 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 a seguir mostra como listar todos os participantes em um registro de conferência:
Java
Node.js
Python
Substitua o valor "parent" 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 são automaticamente alterados para 250.pageToken
: um token de página recebido de uma chamada de lista anterior. Informe esse token para recuperar a página subsequente.filter
: opcional. Um filtro de consulta para recuperar itens específicos nos resultados do recursoparticipants
.Use os campos
earliestStartTime
oulatestEndTime
para filtrar usuários que entraram antes ou saíram depois de um determinado período. Os dois campos usam o formato Timestamp 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
.
Recuperar detalhes do participante com a API People
Para recuperar detalhes sobre um participante, use o
método get()
no
recurso people
da 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 as propriedades
READ_SOURCE_TYPE_PROFILE
,READ_SOURCE_TYPE_CONTACT
eREAD_SOURCE_TYPE_OTHER_CONTACT
ReadSourceType
. Isso garante que tanto os usuários internos de uma organização do Google Workspace quanto os contatos externos sejam incluídos na resposta.
O exemplo de código a seguir mostra como pesquisar perfis de organizações e 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.
Receber detalhes sobre uma sessão de participante
Para ver detalhes sobre uma sessão específica do participante, 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, liste 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 específica de um participante:
Java
Node.js
Python
Substitua o nome do participante pelo ID da sessão específica 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
descendente, 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
Substitua o valor "parent" 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 dos participantes
Transmita os seguintes parâmetros de consulta opcionais para personalizar a paginação ou filtrar sessões de participantes:
pageSize
: o número máximo de sessões de participantes 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 são automaticamente alterados para 250.pageToken
: um token de página recebido de uma chamada de lista anterior. Informe esse token para recuperar a página subsequente.filter
: opcional. Um filtro de consulta para recuperar itens específicos nos resultados do recursoparticipants
.Você pode usar os campos
startTime
ouendTime
para filtrar usuários que entraram antes ou saíram depois de um determinado período. Os dois campos usam o formato Timestamp 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 da conferência, use
endTime IS NULL
.