package google.apps.meet.v2
Get desktop application:
View/edit binary Protocol Buffers messages
REST API for services dealing with conference records.
rpc GetConferenceRecord (, )
service.proto:97Gets a conference record by conference ID.
message
service.proto:286Request to get a conference record.
string name = 1
Required. Resource name of the conference.
Lists the conference records. By default, ordered by start time and in descending order.
message
service.proto:297Request to fetch list of conference records per user.
int32 page_size = 1
Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.
string page_token = 2
Optional. Page token returned from previous List Call.
string filter = 3
Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `space.meeting_code` * `space.name` * `start_time` * `end_time` For example, consider the following filters: * `space.name = "spaces/NAME"` * `space.meeting_code = "abc-mnop-xyz"` * `start_time>="2024-01-01T00:00:00.000Z" AND start_time<="2024-01-02T00:00:00.000Z"` * `end_time IS NULL`
message
service.proto:327Response of ListConferenceRecords method.
repeated conference_records = 1
List of conferences in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List does NOT include all the Conferences. Unset if all conferences have been returned.
rpc GetParticipant (, )
service.proto:115Gets a participant by participant ID.
message
service.proto:337Request to get a participant.
string name = 1
Required. Resource name of the participant.
rpc ListParticipants (, )
service.proto:127Lists the participants in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted, this API defaults to `'participants/*, next_page_token'`.
message
service.proto:348Request to fetch list of participants per conference.
string parent = 1
Required. Format: `conferenceRecords/{conference_record}`
int32 page_size = 2
Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.
string page_token = 3
Page token returned from previous List Call.
string filter = 4
Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `earliest_start_time` * `latest_end_time` For example, `latest_end_time IS NULL` returns active participants in the conference.
message
service.proto:380Response of ListParticipants method.
repeated participants = 1
List of participants in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.
int32 total_size = 3
Total, exact number of `participants`. By default, this field isn't included in the response. Set the field mask in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters) to receive this field in the response.
Gets a participant session by participant session ID.
message
service.proto:396Request to get a participant session.
string name = 1
Required. Resource name of the participant.
Lists the participant sessions of a participant in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted this API defaults to `'participantsessions/*, next_page_token'`.
message
service.proto:408Request to fetch list of participant sessions per conference record, per participant.
string parent = 1
Required. Format: `conferenceRecords/{conference_record}/participants/{participant}`
int32 page_size = 2
Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.
string page_token = 3
Optional. Page token returned from previous List Call.
string filter = 4
Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `start_time` * `end_time` For example, `end_time IS NULL` returns active participant sessions in the conference record.
message
service.proto:440Response of ListParticipants method.
repeated participant_sessions = 1
List of participants in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.
rpc GetRecording (, )
service.proto:158Gets a recording by recording ID.
message
service.proto:450Request message for GetRecording method.
string name = 1
Required. Resource name of the recording.
rpc ListRecordings (, )
service.proto:167Lists the recording resources from the conference record. By default, ordered by start time and in ascending order.
message
service.proto:459Request for ListRecordings method.
string parent = 1
Required. Format: `conferenceRecords/{conference_record}`
int32 page_size = 2
Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.
string page_token = 3
Page token returned from previous List Call.
message
service.proto:480Response for ListRecordings method.
repeated recordings = 1
List of recordings in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List doesn't include all the recordings. Unset if all recordings are returned.
rpc GetTranscript (, )
service.proto:175Gets a transcript by transcript ID.
message
service.proto:490Request for GetTranscript method.
string name = 1
Required. Resource name of the transcript.
rpc ListTranscripts (, )
service.proto:184Lists the set of transcripts from the conference record. By default, ordered by start time and in ascending order.
message
service.proto:499Request for ListTranscripts method.
string parent = 1
Required. Format: `conferenceRecords/{conference_record}`
int32 page_size = 2
Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.
string page_token = 3
Page token returned from previous List Call.
message
service.proto:520Response for ListTranscripts method.
repeated transcripts = 1
List of transcripts in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List doesn't include all the transcripts. Unset if all transcripts are returned.
rpc GetTranscriptEntry (, )
service.proto:197Gets a `TranscriptEntry` resource by entry ID. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.
message
service.proto:530Request for GetTranscriptEntry method.
string name = 1
Required. Resource name of the `TranscriptEntry`.
Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.
message
service.proto:541Request for ListTranscriptEntries method.
string parent = 1
Required. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`
int32 page_size = 2
Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.
string page_token = 3
Page token returned from previous List Call.
message
service.proto:563Response for ListTranscriptEntries method.
repeated transcript_entries = 1
List of TranscriptEntries in one page.
string next_page_token = 2
Token to be circulated back for further List call if current List doesn't include all the transcript entries. Unset if all entries are returned.
service SpacesService
service.proto:36REST API for services dealing with spaces.
rpc CreateSpace (, )
service.proto:44Creates a space.
message
service.proto:220Request to create a space.
optional space = 1
Space to be created. As of May 2023, the input space can be empty. Later on the input space can be non-empty when space configuration is introduced.
rpc GetSpace (, )
service.proto:56Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
message
service.proto:227Request to get a space.
string name = 1
Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
rpc UpdateSpace (, )
service.proto:67Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
message
service.proto:254Request to update a space.
optional space = 1
Required. Space to be updated.
optional update_mask = 2
Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request.
rpc EndActiveConference (, )
service.proto:79Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
message
service.proto:269Request to end an ongoing conference of a space.
string name = 1
Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
message
resource.proto:72Active conference.
Used in:
string conference_record = 1
Output only. Reference to 'ConferenceRecord' resource. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.
message
resource.proto:243User who joins anonymously (meaning not signed into a Google Account).
Used in:
string display_name = 1
Output only. User provided name when they join a conference anonymously.
message
resource.proto:132Single instance of a meeting held in a space.
Used as response type in: ConferenceRecordsService.GetConferenceRecord
Used as field type in:
string name = 1
Identifier. Resource name of the conference record. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.
optional start_time = 2
Output only. Timestamp when the conference started. Always set.
optional end_time = 3
Output only. Timestamp when the conference ended. Set for past conferences. Unset if the conference is ongoing.
optional expire_time = 4
Output only. Server enforced expiration time for when this conference record resource is deleted. The resource is deleted 30 days after the conference ends.
string space = 5
Output only. The space where the conference was held.
message
resource.proto:371Google Docs location where the transcript file is saved.
Used in:
string document = 1
Output only. The document ID for the underlying Google Docs transcript file. For example, "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use the `documents.get` method of the Google Docs API (https://developers.google.com/docs/api/reference/rest/v1/documents/get) to fetch the content.
string export_uri = 2
Output only. URI for the Google Docs transcript file. Use `https://docs.google.com/document/d/{$DocumentId}/view` to browse the transcript in the browser.
message
resource.proto:307Export location where a recording file is saved in Google Drive.
Used in:
string file = 1
Output only. The `fileId` for the underlying MP4 file. For example, "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use `$ GET https://www.googleapis.com/drive/v3/files/{$fileId}?alt=media` to download the blob. For more information, see https://developers.google.com/drive/api/v3/reference/files/get.
string export_uri = 2
Output only. Link used to play back the recording file in the browser. For example, `https://drive.google.com/file/d/{$fileId}/view`.
message
resource.proto:168User who attended or is attending a conference.
Used as response type in: ConferenceRecordsService.GetParticipant
Used as field type in:
oneof user
signedin_user = 4
Signed-in user.
anonymous_user = 5
Anonymous user.
phone_user = 6
User calling from their phone.
string name = 1
Output only. Resource name of the participant. Format: `conferenceRecords/{conference_record}/participants/{participant}`
optional earliest_start_time = 7
Output only. Time when the participant first joined the meeting.
optional latest_end_time = 8
Output only. Time when the participant left the meeting for the last time. This can be null if it's an active meeting.
message
resource.proto:206Refers to each unique join or leave session when a user joins a conference from a device. Note that any time a user joins the conference a new unique ID is assigned. That means if a user joins a space multiple times from the same device, they're assigned different IDs, and are also be treated as different participant sessions.
Used as response type in: ConferenceRecordsService.GetParticipantSession
Used as field type in:
string name = 1
Identifier. Session id.
optional start_time = 2
Output only. Timestamp when the user session starts.
optional end_time = 3
Output only. Timestamp when the user session ends. Unset if the user session hasn’t ended.
message
resource.proto:250User dialing in from a phone where the user's identity is unknown because they haven't signed in with a Google Account.
Used in:
string display_name = 1
Output only. Partially redacted user's phone number when calling.
message
resource.proto:256Metadata about a recording created during a conference.
Used as response type in: ConferenceRecordsService.GetRecording
Used as field type in:
oneof destination
drive_destination = 6
Output only. Recording is saved to Google Drive as an MP4 file. The `drive_destination` includes the Drive `fileId` that can be used to download the file using the `files.get` method of the Drive API.
string name = 1
Output only. Resource name of the recording. Format: `conferenceRecords/{conference_record}/recordings/{recording}` where `{recording}` is a 1:1 mapping to each unique recording session during the conference.
Recording.State state = 3
Output only. Current state.
optional start_time = 4
Output only. Timestamp when the recording started.
optional end_time = 5
Output only. Timestamp when the recording ended.
Current state of the recording session.
Used in:
STATE_UNSPECIFIED = 0
Default, never used.
STARTED = 1
An active recording session has started.
ENDED = 2
This recording session has ended, but the recording file hasn't been generated yet.
FILE_GENERATED = 3
Recording file is generated and ready to download.
message
resource.proto:231A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices.
Used in:
string user = 1
Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: `users/{user}`
string display_name = 2
Output only. For a personal device, it's the user's first name and last name. For a robot account, it's the administrator-specified device name. For example, "Altostrat Room".
message
resource.proto:33Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
Used as response type in: SpacesService.CreateSpace, SpacesService.GetSpace, SpacesService.UpdateSpace
Used as field type in: ,
string name = 1
Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
string meeting_uri = 2
Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.
string meeting_code = 3
Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.
optional config = 5
Configuration pertaining to the meeting space.
optional active_conference = 6
Active conference, if it exists.
message
resource.proto:85The configuration pertaining to a meeting space.
Used in:
SpaceConfig.AccessType access_type = 1
Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED.
SpaceConfig.EntryPointAccess entry_point_access = 2
Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
Possible access types for a meeting space.
Used in:
ACCESS_TYPE_UNSPECIFIED = 0
Default value specified by the user's organization. Note: This is never returned, as the configured access type is returned instead.
OPEN = 1
Anyone with the join information (for example, the URL or phone access information) can join without knocking.
TRUSTED = 2
Members of the host's organization, invited external users, and dial-in users can join without knocking. Everyone else must knock.
RESTRICTED = 3
Only invitees can join without knocking. Everyone else must knock.
Entry points that can be used to join a meeting. Example: `meet.google.com`, the Meet Embed SDK Web, or a mobile application.
Used in:
ENTRY_POINT_ACCESS_UNSPECIFIED = 0
Unused.
ALL = 1
All entry points are allowed.
CREATOR_APP_ONLY = 2
Only entry points owned by the Google Cloud project that created the space can be used to join meetings in this space. Apps can use the Meet Embed SDK Web or mobile Meet SDKs to create owned entry points.
message
resource.proto:322Metadata for a transcript generated from a conference. It refers to the ASR (Automatic Speech Recognition) result of user's speech during the conference.
Used as response type in: ConferenceRecordsService.GetTranscript
Used as field type in:
oneof destination
docs_destination = 6
Output only. Where the Google Docs transcript is saved.
string name = 1
Output only. Resource name of the transcript. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`, where `{transcript}` is a 1:1 mapping to each unique transcription session of the conference.
Transcript.State state = 3
Output only. Current state.
optional start_time = 4
Output only. Timestamp when the transcript started.
optional end_time = 5
Output only. Timestamp when the transcript stopped.
Current state of the transcript session.
Used in:
STATE_UNSPECIFIED = 0
Default, never used.
STARTED = 1
An active transcript session has started.
ENDED = 2
This transcript session has ended, but the transcript file hasn't been generated yet.
FILE_GENERATED = 3
Transcript file is generated and ready to download.
message
resource.proto:386Single entry for one user’s speech during a transcript session.
Used as response type in: ConferenceRecordsService.GetTranscriptEntry
Used as field type in:
string name = 1
Output only. Resource name of the entry. Format: "conferenceRecords/{conference_record}/transcripts/{transcript}/entries/{entry}"
string participant = 2
Output only. Refers to the participant who speaks.
string text = 3
Output only. The transcribed text of the participant's voice, at maximum 10K words. Note that the limit is subject to change.
string language_code = 4
Output only. Language of spoken text, such as "en-US". IETF BCP 47 syntax (https://tools.ietf.org/html/bcp47)
optional start_time = 5
Output only. Timestamp when the transcript entry started.
optional end_time = 6
Output only. Timestamp when the transcript entry ended.