このドキュメントでは、Google Workspace Events API を使用してアプリが登録できる Meet イベントについて説明します。必要なイベントの種類を決定したら、サブスクリプションを作成して、Meet からイベントの受信を開始します。
イベントをサブスクライブするだけでなく、Google Meet REST API を呼び出してイベントをクエリすることもできます。Meet REST API を呼び出して、定期的にイベントを取得したり、サービス停止が原因でサブスクリプションから見逃したイベントをキャッチアップしたりします。Meet イベントを受信して応答する方法については、Meet のドキュメントの Google Meet からのイベントに応答するをご覧ください。
Meet 用アプリの開発について詳しくは、 Meet REST API の概要をご覧ください。
サポートされている Meet イベント
Google Workspace サブスクリプションでは、Meet で行われた次の種類の変更に関するイベントを受信できます。
- 会議スペースで会議が開始または終了した。
- 参加者が会議に参加または会議から退出した。
- 会議の録画が開始または終了したとき、またはファイルが生成されたとき。
- 会議でスマートメモが開始または終了したとき、またはファイルが生成されたとき。
- 会議の文字起こしが開始または終了したとき、またはファイルが生成されたとき。
イベントをモニタリングできるリソース
イベントを受信するには、モニタリングする Meet リソースを指定します。これは、サブスクリプションのターゲット リソースと呼ばれます。
Google Workspace Events API は、Meet の次のターゲット リソースをサポートしています。
| ターゲット リソース | 形式 | 制限事項(該当する場合) |
|---|---|---|
| 会議スペース | //meet.googleapis.com/spaces/SPACE
ここで、SPACE は Meet REST API の |
|
| ユーザー | //cloudidentity.googleapis.com/users/USER
ここで、USER は Meet REST API |
サブスクリプションは、ユーザーが会議スペースのオーナーであるすべての会議スペースに関するイベントを受信します。通常、会議スペースのオーナーは、会議スペースに関連付けられている Google カレンダーの予定の主催者でもあります。 |
サブスクリプションを作成するためのイベントタイプ
Meet リソースへのサブスクリプションを作成するときに、eventTypes[] フィールドを使用して、受信するイベントのタイプを指定します。イベントタイプは、CloudEvents 仕様に従ってフォーマットされます(例: google.workspace.APPLICATION.RESOURCE.VERSION.ACTION)。
たとえば、Meet スペースの会議に新しい参加者が参加したときにイベントを受信するには、イベントタイプを google.workspace.meet.participant.v2.joined として指定します。イベントの仕組みについて詳しくは、Google Workspace イベントの構造をご覧ください。
次の表に、Meet リソースのサブスクリプションでサポートされているイベントタイプを示します。
| イベント タイプ | 形式 | リソースデータ |
|---|---|---|
| 会議スペースで会議が開始されます。 | google.workspace.meet.conference.v2.started |
conferenceRecord |
| 会議スペースで会議が終了した。 | google.workspace.meet.conference.v2.ended |
conferenceRecord |
| 参加者が会議スペースで進行中の会議に参加する。 | google.workspace.meet.participant.v2.joined |
conferenceRecord.participantSession |
| 参加者が会議スペースで進行中の会議から退出した。 | google.workspace.meet.participant.v2.left |
conferenceRecord.participantSession |
| 会議スペースで会議の録画が開始された。 | google.workspace.meet.recording.v2.started |
conferenceRecord.recording |
| 会議スペースでの会議の録画が終了した。 | google.workspace.meet.recording.v2.ended |
conferenceRecord.recording |
| 会議スペースの会議の録画ファイルが生成された。 | google.workspace.meet.recording.v2.fileGenerated |
conferenceRecord.recording |
| 会議スペースで会議のスマートメモが開始された。 | google.workspace.meet.smartNote.v2.started |
conferenceRecord.smartNote |
| 会議スペースでの会議のスマートメモが終了した。 | google.workspace.meet.smartNote.v2.ended |
conferenceRecord.smartNote |
| 会議スペースの会議用にスマートメモ ファイルが生成されます。 | google.workspace.meet.smartNote.v2.fileGenerated |
conferenceRecord.smartNote |
| 会議スペースで会議の文字起こしが開始された。 | google.workspace.meet.transcript.v2.started |
conferenceRecord.transcript |
| 会議スペースでの会議の文字起こしが終了した。 | google.workspace.meet.transcript.v2.ended |
conferenceRecord.transcript |
| 会議スペースでの会議の文字起こしファイルが生成された。 | google.workspace.meet.transcript.v2.fileGenerated |
conferenceRecord.transcript |
イベントデータ
このセクションでは、Meet の会議スペースでのイベントのイベントデータとペイロードの例について説明します。
Google Workspace サブスクリプションが Meet からイベントを受信すると、data フィールドにイベントのペイロードが含まれます。このペイロードには、変更された Google Workspace リソースに関する情報が含まれています。たとえば、スペース内の新しい文字起こしに関するイベントに登録している場合、これらのイベントのペイロードには、変更された transcripts リソースに関する情報が含まれます。
イベント ペイロードのリソースデータ
次の表に、Meet 会議スペースのサブスクリプションの JSON ペイロードの例を示します。この例では、会議レコード ID(conferenceRecords/kRyYx8b7vNDsLpR1tG_cNjFUQBoBRhHIMoGJAJkBCQ など)を使用して会議スペースを識別します。詳細については、Meet が会議スペースを識別する方法をご覧ください。
サブスクリプションが受信するイベントごとに、ペイロードがイベントの data フィールドに表示されます。
| イベントタイプ | JSON ペイロード |
|---|---|
Meet 会議スペースで会議が開始または終了した。
|
リソースデータを除外します。
{
"conferenceRecord":
{
"name": "conferenceRecords/ |
参加者が Meet の会議スペースで会議に参加または退出した。
|
リソースデータを除外します。
{
"participantSession":
{
"name": "conferenceRecords/ |
Meet 会議スペースで会議の録画が開始または終了した、またはファイルが生成された。
|
リソースデータを除外します。
{
"recording":
{
"name": "conferenceRecords/ |
Meet 会議スペースで会議のスマートメモが開始または終了したか、ファイルが生成されました。
|
リソースデータを除外します。
{
"smartNote":
{
"name": "conferenceRecords/ |
Meet 会議スペースで会議の文字起こしが開始、終了、またはファイルが生成された。
|
リソースデータを除外します。
{
"transcript":
{
"name": "conferenceRecords/ |
制限事項
- カレンダーの招待者と会議に招待された他の参加者が受信できるのは、
google.workspace.meet.conference.v2.startedとgoogle.workspace.meet.transcript.v2.fileGeneratedのイベントのみです。