As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Apps Meet v2 API

class google.apps.meet_v2.types.ActiveConference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Active conference.

conference_record

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.

Type

str

class google.apps.meet_v2.types.AnonymousUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

User who joins anonymously (meaning not signed into a Google Account).

display_name

Output only. User provided name when they join a conference anonymously.

Type

str

class google.apps.meet_v2.types.BatchUpdateMembersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to update members of one space within a batch.

parent

Required. The parent resource shared by all Members being updated. Format: spaces/{space}

Type

str

requests

Required. The request message specifying the resources to update. A maximum of 500 members can be modified in a batch.

Type

MutableSequence[google.apps.meet_v2.types.UpdateMemberRequest]

update_mask

Optional. Top-level field mask used to specify the fields to be updated in the member for all UpdateMemberRequests. There are 4 possible scenarios for top-level and child field mask:

  1. top-level and child field mask is absent:

    All fields provided in the requests are

updated, including deleting fields not set in the requests. 2. top-level field mask is present but child

field mask is absent:

The fields specified in the top-level field

mask are updated. 3. top-level and child field mask is present:

The child field mask must be the same as the

top-level field mask. 4. top-level field mask is absent but child

field mask is present:

It isn’t supported and will return an error.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.apps.meet_v2.types.BatchUpdateMembersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of batch update members.

members

Members updated.

Type

MutableSequence[google.apps.meet_v2.types.Member]

class google.apps.meet_v2.types.ConferenceRecord(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Single instance of a meeting held in a space.

name

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.

Type

str

start_time

Output only. Timestamp when the conference started. Always set.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the conference ended. Set for past conferences. Unset if the conference is ongoing.

Type

google.protobuf.timestamp_pb2.Timestamp

expire_time

Output only. Server enforced expiration time for when this conference record resource is deleted. The resource is deleted 30 days after the conference ends.

Type

google.protobuf.timestamp_pb2.Timestamp

space

Output only. The space where the conference was held.

Type

str

class google.apps.meet_v2.types.CreateMemberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to create a member for a space.

parent

Required. Format: spaces/{space}

Type

str

member

Required. The member to be created.

Type

google.apps.meet_v2.types.Member

class google.apps.meet_v2.types.CreateSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to create a space.

space

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.

Type

google.apps.meet_v2.types.Space

class google.apps.meet_v2.types.DeleteMemberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to delete a member from a space.

name

Required. Format: “spaces/{space}/members/{member}”

Type

str

class google.apps.meet_v2.types.DocsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Google Docs location where the transcript file is saved.

document

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.

Type

str

export_uri

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.

Type

str

class google.apps.meet_v2.types.DriveDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Export location where a recording file is saved in Google Drive.

file

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.

Type

str

export_uri

Output only. Link used to play back the recording file in the browser. For example, https://drive.google.com/file/d/{$fileId}/view.

Type

str

class google.apps.meet_v2.types.EndActiveConferenceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to end an ongoing conference of a space.

name

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.

Type

str

class google.apps.meet_v2.types.GetConferenceRecordRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to get a conference record.

name

Required. Resource name of the conference.

Type

str

class google.apps.meet_v2.types.GetMemberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to get a member from a space.

name

Required. Format: “spaces/{space}/members/{member}”

Type

str

class google.apps.meet_v2.types.GetParticipantRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to get a participant.

name

Required. Resource name of the participant.

Type

str

class google.apps.meet_v2.types.GetParticipantSessionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to get a participant session.

name

Required. Resource name of the participant.

Type

str

class google.apps.meet_v2.types.GetRecordingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for GetRecording method.

name

Required. Resource name of the recording.

Type

str

class google.apps.meet_v2.types.GetSmartNoteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for GetSmartNote method.

name

Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}

Type

str

class google.apps.meet_v2.types.GetSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to get a space.

name

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.

For more information, see How Meet identifies a meeting space.

Type

str

class google.apps.meet_v2.types.GetTranscriptEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for GetTranscriptEntry method.

name

Required. Resource name of the TranscriptEntry.

Type

str

class google.apps.meet_v2.types.GetTranscriptRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for GetTranscript method.

name

Required. Resource name of the transcript.

Type

str

class google.apps.meet_v2.types.ListConferenceRecordsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to fetch list of conference records per user.

page_size

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.

Type

int

page_token

Optional. Page token returned from previous List Call.

Type

str

filter

Optional. User specified filtering condition in EBNF format. 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

Type

str

class google.apps.meet_v2.types.ListConferenceRecordsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of ListConferenceRecords method.

conference_records

List of conferences in one page.

Type

MutableSequence[google.apps.meet_v2.types.ConferenceRecord]

next_page_token

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.

Type

str

class google.apps.meet_v2.types.ListMembersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to list all members of a space.

parent

Required. Format: spaces/{space}

Type

str

page_size

Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified or set to 0, at most 250 members are returned. The maximum value is 500; values above 500 are coerced to 500. Maximum might change in the future.

Type

int

page_token

Optional. Page token returned from previous List Call.

Type

str

class google.apps.meet_v2.types.ListMembersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of list members.

members

The list of members for the current page.

Type

MutableSequence[google.apps.meet_v2.types.Member]

next_page_token

Token to be circulated back for further list call if current list doesn’t include all the members. Unset if all members are returned.

Type

str

class google.apps.meet_v2.types.ListParticipantSessionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to fetch list of participant sessions per conference record, per participant.

parent

Required. Format: conferenceRecords/{conference_record}/participants/{participant}

Type

str

page_size

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.

Type

int

page_token

Optional. Page token returned from previous List Call.

Type

str

filter

Optional. User specified filtering condition in EBNF format. The following are the filterable fields:

  • start_time

  • end_time

For example, end_time IS NULL returns active participant sessions in the conference record.

Type

str

class google.apps.meet_v2.types.ListParticipantSessionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of ListParticipants method.

participant_sessions

List of participants in one page.

Type

MutableSequence[google.apps.meet_v2.types.ParticipantSession]

next_page_token

Token to be circulated back for further List call if current List doesn’t include all the participants. Unset if all participants are returned.

Type

str

class google.apps.meet_v2.types.ListParticipantsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to fetch list of participants per conference.

parent

Required. Format: conferenceRecords/{conference_record}

Type

str

page_size

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.

Type

int

page_token

Page token returned from previous List Call.

Type

str

filter

Optional. User specified filtering condition in EBNF format. 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.

Type

str

class google.apps.meet_v2.types.ListParticipantsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of ListParticipants method.

participants

List of participants in one page.

Type

MutableSequence[google.apps.meet_v2.types.Participant]

next_page_token

Token to be circulated back for further List call if current List doesn’t include all the participants. Unset if all participants are returned.

Type

str

total_size

Total, exact number of participants. By default, this field isn’t included in the response. Set the field mask in SystemParameterContext to receive this field in the response.

Type

int

class google.apps.meet_v2.types.ListRecordingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for ListRecordings method.

parent

Required. Format: conferenceRecords/{conference_record}

Type

str

page_size

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.

Type

int

page_token

Page token returned from previous List Call.

Type

str

class google.apps.meet_v2.types.ListRecordingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for ListRecordings method.

recordings

List of recordings in one page.

Type

MutableSequence[google.apps.meet_v2.types.Recording]

next_page_token

Token to be circulated back for further List call if current List doesn’t include all the recordings. Unset if all recordings are returned.

Type

str

class google.apps.meet_v2.types.ListSmartNotesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for ListSmartNotes method.

parent

Required. Format: conferenceRecords/{conference_record}

Type

str

page_size

Optional. Maximum number of smart notes to return. The service might return fewer than this value. If unspecified, at most 10 smart notes are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.

Type

int

page_token

Optional. Page token returned from previous List Call.

Type

str

class google.apps.meet_v2.types.ListSmartNotesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for ListSmartNotes method.

smart_notes

List of smart notes in one page.

Type

MutableSequence[google.apps.meet_v2.types.SmartNote]

next_page_token

Token to be circulated back for further List call if current List doesn’t include all the smart notes. Unset if all smart notes are returned.

Type

str

class google.apps.meet_v2.types.ListTranscriptEntriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for ListTranscriptEntries method.

parent

Required. Format: conferenceRecords/{conference_record}/transcripts/{transcript}

Type

str

page_size

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.

Type

int

page_token

Page token returned from previous List Call.

Type

str

class google.apps.meet_v2.types.ListTranscriptEntriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for ListTranscriptEntries method.

transcript_entries

List of TranscriptEntries in one page.

Type

MutableSequence[google.apps.meet_v2.types.TranscriptEntry]

next_page_token

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.

Type

str

class google.apps.meet_v2.types.ListTranscriptsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for ListTranscripts method.

parent

Required. Format: conferenceRecords/{conference_record}

Type

str

page_size

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.

Type

int

page_token

Page token returned from previous List Call.

Type

str

class google.apps.meet_v2.types.ListTranscriptsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for ListTranscripts method.

transcripts

List of transcripts in one page.

Type

MutableSequence[google.apps.meet_v2.types.Transcript]

next_page_token

Token to be circulated back for further List call if current List doesn’t include all the transcripts. Unset if all transcripts are returned.

Type

str

class google.apps.meet_v2.types.Member(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Users who are configured to have a role in the space. These users can join the space without knocking.

name

Identifier. Resource name of the member. Format: spaces/{space}/members/{member}

Type

str

email

Email for the member. This is required for creating the member.

Type

str

role

The meeting role assigned to the member.

Type

google.apps.meet_v2.types.Member.Role

class Role(value)[source]

Bases: proto.enums.Enum

Role of this member in the space.

Values:
ROLE_UNSPECIFIED (0):

This is used to indicate the user hasn’t specified any value and the user’s role will be determined upon joining the meetings between ‘contributor’ and ‘viewer’ role depending on meeting configuration. For more information about the viewer role, see Assign View only roles in Google Meet.

COHOST (1):

Co-host role.

class google.apps.meet_v2.types.Participant(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

User who attended or is attending a conference.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

signedin_user

Signed-in user.

This field is a member of oneof user.

Type

google.apps.meet_v2.types.SignedinUser

anonymous_user

Anonymous user.

This field is a member of oneof user.

Type

google.apps.meet_v2.types.AnonymousUser

phone_user

User calling from their phone.

This field is a member of oneof user.

Type

google.apps.meet_v2.types.PhoneUser

name

Output only. Resource name of the participant. Format: conferenceRecords/{conference_record}/participants/{participant}

Type

str

earliest_start_time

Output only. Time when the participant first joined the meeting.

Type

google.protobuf.timestamp_pb2.Timestamp

latest_end_time

Output only. Time when the participant left the meeting for the last time. This can be null if it’s an active meeting.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.meet_v2.types.ParticipantSession(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Refers 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.

name

Identifier. Session id.

Type

str

start_time

Output only. Timestamp when the user session starts.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the user session ends. Unset if the user session hasn’t ended.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.meet_v2.types.PhoneUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

User dialing in from a phone where the user’s identity is unknown because they haven’t signed in with a Google Account.

display_name

Output only. Partially redacted user’s phone number when calling.

Type

str

class google.apps.meet_v2.types.Recording(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata about a recording created during a conference.

drive_destination

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.

This field is a member of oneof destination.

Type

google.apps.meet_v2.types.DriveDestination

name

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.

Type

str

state

Output only. Current state.

Type

google.apps.meet_v2.types.Recording.State

start_time

Output only. Timestamp when the recording started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the recording ended.

Type

google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]

Bases: proto.enums.Enum

Current state of the recording session.

Values:
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.

class google.apps.meet_v2.types.SignedinUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A 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.

user

Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: users/{user}

Type

str

display_name

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”.

Type

str

class google.apps.meet_v2.types.SmartNote(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata for a smart note generated from a conference. It refers to the notes generated from Take Notes with Gemini during the conference.

docs_destination

Output only. The Google Doc destination where the smart notes are saved.

This field is a member of oneof destination.

Type

google.apps.meet_v2.types.DocsDestination

name

Output only. Identifier. Resource name of the smart notes. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}, where {smart_note} is a 1:1 mapping to each unique smart notes session of the conference.

Type

str

state

Output only. Current state.

Type

google.apps.meet_v2.types.SmartNote.State

start_time

Output only. Timestamp when the smart notes started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the smart notes stopped.

Type

google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]

Bases: proto.enums.Enum

Current state of the smart notes session.

Values:
STATE_UNSPECIFIED (0):

Default, never used.

STARTED (1):

An active smart notes session has started.

ENDED (2):

This smart notes session has ended, but the smart notes file hasn’t been generated yet.

FILE_GENERATED (3):

Smart notes file is generated and ready to download.

class google.apps.meet_v2.types.Space(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Virtual place where conferences are held. Only one active conference can be held in one space at any given time.

name

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.

Type

str

meeting_uri

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.

Type

str

meeting_code

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.

Type

str

config

Configuration pertaining to the meeting space.

Type

google.apps.meet_v2.types.SpaceConfig

active_conference

Active conference, if it exists.

Type

google.apps.meet_v2.types.ActiveConference

phone_access

Output only. All regional phone access methods for this meeting space. Can be empty.

Type

MutableSequence[google.apps.meet_v2.types.Space.PhoneAccess]

gateway_sip_access

Output only. The SIP-based access methods that can be used to join the conference. Can be empty.

Type

MutableSequence[google.apps.meet_v2.types.Space.GatewaySipAccess]

class GatewaySipAccess(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details how to join the conference through a SIP gateway.

uri

The Session Initiation Protocol (SIP) URI the conference can be reached through.

The string is in one of these formats:

where USER_ID is the 13-digit universal pin (with the future option to support using a Meet meeting code as well), and GATEWAY_ADDRESS is a valid address to be resolved using a DNS SRV lookup, or a dotted quad.

Type

str

sip_access_code

The permanent numeric code for manual entry on specially configured devices.

Type

str

class PhoneAccess(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number.

phone_number

The phone number to dial for this meeting space in E.164 format. Full phone number with a leading ‘+’ character.

Type

str

pin

The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary.

Type

str

region_code

The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: “SE” for Sweden.

Type

str

language_code

The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: “es-419” for Latin American Spanish, “fr-CA” for Canadian French.

Type

str

class google.apps.meet_v2.types.SpaceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The configuration pertaining to a meeting space.

access_type

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.

Type

google.apps.meet_v2.types.SpaceConfig.AccessType

entry_point_access

Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL

Type

google.apps.meet_v2.types.SpaceConfig.EntryPointAccess

moderation

The pre-configured moderation mode for the Meeting. Default: Controlled by the user’s policies.

Type

google.apps.meet_v2.types.SpaceConfig.Moderation

moderation_restrictions

When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.

Type

google.apps.meet_v2.types.SpaceConfig.ModerationRestrictions

attendance_report_generation_type

Whether attendance report is enabled for the meeting space.

Type

google.apps.meet_v2.types.SpaceConfig.AttendanceReportGenerationType

artifact_config

Configuration pertaining to the auto-generated artifacts that the meeting supports.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig

class AccessType(value)[source]

Bases: proto.enums.Enum

Possible access types for a meeting space.

Values:
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.

class ArtifactConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration related to meeting artifacts potentially generated by this meeting space.

recording_config

Configuration for recording.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.RecordingConfig

transcription_config

Configuration for auto-transcript.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.TranscriptionConfig

smart_notes_config

Configuration for auto-smart-notes.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.SmartNotesConfig

class AutoGenerationType(value)[source]

Bases: proto.enums.Enum

Determines whether an artifact can be automatically generated in the meeting space.

Values:
AUTO_GENERATION_TYPE_UNSPECIFIED (0):

Default value specified by user policy. This should never be returned.

ON (1):

The artifact is generated automatically.

OFF (2):

The artifact is not generated automatically.

class RecordingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration related to recording in a meeting space.

auto_recording_generation

Defines whether a meeting space is automatically recorded when someone with the privilege to record joins the meeting.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.AutoGenerationType

class SmartNotesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration related to smart notes in a meeting space. For more information about smart notes, see “Take notes for me” in Google Meet.

auto_smart_notes_generation

Defines whether to automatically generate a summary and recap of the meeting for all invitees in the organization when someone with the privilege to enable smart notes joins the meeting.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.AutoGenerationType

class TranscriptionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration related to transcription in a meeting space.

auto_transcription_generation

Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.

Type

google.apps.meet_v2.types.SpaceConfig.ArtifactConfig.AutoGenerationType

class AttendanceReportGenerationType(value)[source]

Bases: proto.enums.Enum

Possible states of whether attendance report is enabled for the meeting space.

Values:
ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED (0):

Default value specified by user policy. This should never be returned.

GENERATE_REPORT (1):

Attendance report will be generated and sent to drive/email.

DO_NOT_GENERATE (2):

Attendance report will not be generated.

class EntryPointAccess(value)[source]

Bases: proto.enums.Enum

Entry points that can be used to join a meeting. Example: meet.google.com, the Meet Embed SDK Web, or a mobile application.

Values:
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.

class Moderation(value)[source]

Bases: proto.enums.Enum

The moderation mode for a meeting. When the moderation mode is on, the meeting owner has more control over the meeting with features such as co-host management (see message Member) and feature restrictions (see message ModerationRestrictions).

Values:
MODERATION_UNSPECIFIED (0):

Moderation type is not specified. This is used to indicate the user hasn’t specified any value as the user does not intend to update the state. Users are not allowed to set the value as unspecified.

OFF (1):

Moderation is off.

ON (2):

Moderation is on.

class ModerationRestrictions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Defines restrictions for features when the meeting is moderated.

chat_restriction

Defines who has permission to send chat messages in the meeting space.

Type

google.apps.meet_v2.types.SpaceConfig.ModerationRestrictions.RestrictionType

reaction_restriction

Defines who has permission to send reactions in the meeting space.

Type

google.apps.meet_v2.types.SpaceConfig.ModerationRestrictions.RestrictionType

present_restriction

Defines who has permission to share their screen in the meeting space.

Type

google.apps.meet_v2.types.SpaceConfig.ModerationRestrictions.RestrictionType

default_join_as_viewer_type

Defines whether to restrict the default role assigned to users as viewer.

Type

google.apps.meet_v2.types.SpaceConfig.ModerationRestrictions.DefaultJoinAsViewerType

class DefaultJoinAsViewerType(value)[source]

Bases: proto.enums.Enum

By default users will join as contributors. Hosts can restrict users to join as viewers. Note: If an explicit role is set for a user in the Member resource, the user will join as that role.

Values:
DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED (0):

Default value specified by user policy. This should never be returned.

ON (1):

Users will by default join as viewers.

OFF (2):

Users will by default join as contributors.

class RestrictionType(value)[source]

Bases: proto.enums.Enum

Determines who has permission to use a particular feature.

Values:
RESTRICTION_TYPE_UNSPECIFIED (0):

Default value specified by user policy. This should never be returned.

HOSTS_ONLY (1):

Meeting owner and co-host have the permission.

NO_RESTRICTION (2):

All Participants have permissions.

class google.apps.meet_v2.types.Transcript(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata for a transcript generated from a conference. It refers to the ASR (Automatic Speech Recognition) result of user’s speech during the conference.

docs_destination

Output only. Where the Google Docs transcript is saved.

This field is a member of oneof destination.

Type

google.apps.meet_v2.types.DocsDestination

name

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.

Type

str

state

Output only. Current state.

Type

google.apps.meet_v2.types.Transcript.State

start_time

Output only. Timestamp when the transcript started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the transcript stopped.

Type

google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]

Bases: proto.enums.Enum

Current state of the transcript session.

Values:
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.

class google.apps.meet_v2.types.TranscriptEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Single entry for one user’s speech during a transcript session.

name

Output only. Resource name of the entry. Format: “conferenceRecords/{conference_record}/transcripts/{transcript}/entries/{entry}”.

Type

str

participant

Output only. Refers to the participant who speaks.

Type

str

text

Output only. The transcribed text of the participant’s voice, at maximum 10K words. Note that the limit is subject to change.

Type

str

language_code

Output only. Language of spoken text, such as “en-US”. IETF BCP 47 syntax (https://tools.ietf.org/html/bcp47)

Type

str

start_time

Output only. Timestamp when the transcript entry started.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Timestamp when the transcript entry ended.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.meet_v2.types.UpdateMemberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to update a member.

member

Required. The Member to update. Format: spaces/{space}/members/{member}

Type

google.apps.meet_v2.types.Member

update_mask

Optional. Field mask used to specify the fields to be updated in the member. 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. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.apps.meet_v2.types.UpdateSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request to update a space.

space

Required. Space to be updated.

Type

google.apps.meet_v2.types.Space

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask