Inscreva-se em eventos do Google Meet

Este documento descreve os eventos do Google Meet que seu app pode assinar usando a API Google Workspace Events. Depois de decidir quais tipos de eventos você precisa, crie uma assinatura para começar a receber eventos do Meet.

Além de se inscrever em eventos, você também pode consultar eventos chamando a API REST do Google Meet. Chame a API REST do Meet para recuperar eventos periodicamente ou recupere eventos que você perdeu de uma assinatura devido a uma interrupção. Para saber como receber e responder a eventos do Meet, consulte Responder a eventos do Google Meet na documentação do Meet.

Para saber mais sobre como desenvolver apps para o Meet, consulte a visão geral da API REST do Google Meet.

Eventos do Meet compatíveis

Com as assinaturas do Google Workspace, você recebe eventos sobre os seguintes tipos de mudanças no Meet:

  • Uma conferência começa ou termina em um espaço de reunião.
  • Um participante entra ou sai de uma conferência.
  • Uma gravação começa ou termina, ou um arquivo é gerado para uma conferência.
  • Uma transcrição começa ou termina, ou um arquivo é gerado para uma conferência.

Recursos que podem ser monitorados para eventos

Para receber eventos, especifique um recurso do Meet para monitorar, que é chamado de recurso de destino da assinatura.

A API Google Workspace Events é compatível com os seguintes recursos de destino do Meet:

Recurso de destino Formato Limitações (se aplicável)
Espaço para reuniões //meet.googleapis.com/spaces/SPACE

em que SPACE é o ID no nome do recurso do recurso spaces da API REST do Meet. Para mais detalhes, consulte Como o Meet identifica um espaço de reunião.
Usuário //cloudidentity.googleapis.com/users/USER

em que USER é o ID no campo signedinUser.user do recurso participants da API REST do Meet. Para mais detalhes, consulte Trabalhar com participantes.

A assinatura recebe eventos sobre todos os espaços de reunião em que o usuário é o proprietário. Normalmente, o proprietário do espaço de reunião também é o organizador do evento do Google Agenda associado ao espaço.

Tipos de eventos para criar assinaturas

Ao criar uma assinatura de um recurso do Meet, use o campo eventTypes[] para especificar os tipos de eventos que você quer receber. Os tipos de eventos são formatados de acordo com a especificação CloudEvents, como google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

Por exemplo, para receber eventos sobre novos participantes em uma conferência de um espaço do Meet, especifique o tipo de evento como google.workspace.meet.participant.v2.joined. Para saber mais sobre como os eventos funcionam, consulte Estrutura dos eventos do Google Workspace.

A tabela a seguir mostra quais tipos de eventos são compatíveis com assinaturas de recursos do Meet:

Tipo de evento Formato Dados de recursos
Uma conferência começa no espaço de reunião. google.workspace.meet.conference.v2.started conferenceRecord
Uma conferência termina no espaço de reunião. google.workspace.meet.conference.v2.ended conferenceRecord
Um participante entra em uma conferência ativa no espaço de reunião. google.workspace.meet.participant.v2.joined conferenceRecord.participantSession
Um participante sai de uma conferência ativa no espaço de reunião. google.workspace.meet.participant.v2.left conferenceRecord.participantSession
Uma gravação é iniciada para uma conferência no espaço de reunião. google.workspace.meet.recording.v2.started conferenceRecord.recording
Uma gravação termina em uma conferência no espaço de reunião. google.workspace.meet.recording.v2.ended conferenceRecord.recording
Um arquivo de gravação é gerado para uma conferência no espaço de reunião. google.workspace.meet.recording.v2.fileGenerated conferenceRecord.recording
Uma transcrição é iniciada para uma conferência no espaço de reunião. google.workspace.meet.transcript.v2.started conferenceRecord.transcript
Uma transcrição termina para uma conferência no espaço de reunião. google.workspace.meet.transcript.v2.ended conferenceRecord.transcript
Um arquivo de transcrição é gerado para uma conferência no espaço de reunião. google.workspace.meet.transcript.v2.fileGenerated conferenceRecord.transcript

Dados do evento

Esta seção descreve os dados de eventos e exemplos de payloads para eventos em espaços de reunião do Meet.

Quando sua assinatura do Google Workspace recebe um evento do Meet, o campo data contém a carga útil do evento. Esse payload tem informações sobre o recurso do Google Workspace que mudou. Por exemplo, se você se inscreveu para receber eventos sobre novas transcrições em um espaço, o payload desses eventos contém informações sobre o recurso transcripts que mudou.

Dados de recursos no payload do evento

A tabela a seguir mostra exemplos de payloads JSON para uma assinatura de um espaço de reunião do Meet. Os exemplos usam o ID do registro da conferência (por exemplo, conferenceRecords/kRyYx8b7vNDsLpR1tG_cNjFUQBoBRhHIMoGJAJkBCQ) para identificar o espaço para reuniões. Para mais informações, consulte Como o Meet identifica um espaço de reunião.

Para cada evento que a assinatura recebe, o payload aparece no campo data do evento:

Exemplo Tipo de evento Payload JSON

Uma conferência começa ou termina no espaço de reunião do Meet.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended

Exclui dados de recursos:

{
    "conferenceRecord":
    {
        "name": "conferenceRecords/CONFERENCE_RECORD_ID"
    }
}
Um participante entra ou sai de uma conferência no espaço de reunião do Meet.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left

Exclui dados de recursos:

{
    "participantSession":
    {
        "name": "conferenceRecords/CONFERENCE_RECORD_ID/participants/PARTICIPANT_ID/participantSessions/PARTICIPANT_SESSION_ID"
    }
}
Uma gravação é iniciada ou encerrada, ou um arquivo é gerado para uma conferência no espaço de reunião do Meet.
  • google.workspace.meet.recording.v2.started
  • google.workspace.meet.recording.v2.ended
  • google.workspace.meet.recording.v2.fileGenerated

Exclui dados de recursos:

{
    "recording":
    {
        "name": "conferenceRecords/CONFERENCE_RECORD_ID/recordings/RECORDING_ID"
    }
}
Uma transcrição começa, termina ou um arquivo é gerado para uma conferência no espaço de reunião do Meet.
  • google.workspace.meet.transcript.v2.started
  • google.workspace.meet.transcript.v2.ended
  • google.workspace.meet.transcript.v2.fileGenerated

Exclui dados de recursos:

{
    "transcript":
    {
        "name": "conferenceRecords/CONFERENCE_RECORD_ID/transcripts/TRANSCRIPT_ID"
    }
}

Limitações
  • Os convidados do Google Agenda e outros participantes de uma videoconferência só podem receber os seguintes eventos: google.workspace.meet.conference.v2.started e google.workspace.meet.transcript.v2.fileGenerated.