REST Resource: spaces

Resource: Space

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

JSON representation
{
  "name": string,
  "meetingUri": string,
  "meetingCode": string,
  "config": {
    object (SpaceConfig)
  },
  "activeConference": {
    object (ActiveConference)
  }
}
Fields
name

string

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.

meetingUri

string

Output only. URI used to join meetings consisting of https://meet.google.com/ followed by the meetingCode. For example, https://meet.google.com/abc-mnop-xyz.

meetingCode

string

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.

config

object (SpaceConfig)

Configuration pertaining to the meeting space.

activeConference

object (ActiveConference)

Active conference, if it exists.

SpaceConfig

The configuration pertaining to a meeting space.

JSON representation
{
  "accessType": enum (AccessType),
  "entryPointAccess": enum (EntryPointAccess),
  "moderation": enum (Moderation),
  "moderationRestrictions": {
    object (ModerationRestrictions)
  },
  "attendanceReportGenerationType": enum (AttendanceReportGenerationType),
  "artifactConfig": {
    object (ArtifactConfig)
  }
}
Fields
accessType

enum (AccessType)

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.

entryPointAccess

enum (EntryPointAccess)

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

moderation

enum (Moderation)

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

moderationRestrictions

object (ModerationRestrictions)

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

attendanceReportGenerationType

enum (AttendanceReportGenerationType)

Whether attendance report is enabled for the meeting space.

artifactConfig

object (ArtifactConfig)

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

AccessType

Possible access types for a meeting space.

Enums
ACCESS_TYPE_UNSPECIFIED Default value specified by the user's organization. Note: This is never returned, as the configured access type is returned instead.
OPEN Anyone with the join information (for example, the URL or phone access information) can join without knocking.
TRUSTED Members of the host's organization, invited external users, and dial-in users can join without knocking. Everyone else must knock.
RESTRICTED Only invitees can join without knocking. Everyone else must knock.

EntryPointAccess

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

Enums
ENTRY_POINT_ACCESS_UNSPECIFIED Unused.
ALL All entry points are allowed.
CREATOR_APP_ONLY 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.

Moderation

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

Enums
MODERATION_UNSPECIFIED 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 Moderation is off.
ON Moderation is on.

ModerationRestrictions

Defines restrictions for features when the meeting is moderated.

JSON representation
{
  "chatRestriction": enum (RestrictionType),
  "reactionRestriction": enum (RestrictionType),
  "presentRestriction": enum (RestrictionType),
  "defaultJoinAsViewerType": enum (DefaultJoinAsViewerType)
}
Fields
chatRestriction

enum (RestrictionType)

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

reactionRestriction

enum (RestrictionType)

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

presentRestriction

enum (RestrictionType)

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

defaultJoinAsViewerType

enum (DefaultJoinAsViewerType)

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

RestrictionType

Determines who has permission to use a particular feature.

Enums
RESTRICTION_TYPE_UNSPECIFIED Default value specified by user policy. This should never be returned.
HOSTS_ONLY Meeting owner and co-host have the permission.
NO_RESTRICTION All Participants have permissions.

DefaultJoinAsViewerType

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

Enums
DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED Default value specified by user policy. This should never be returned.
ON Users will by default join as viewers.
OFF Users will by default join as contributors.

AttendanceReportGenerationType

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

Enums
ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED Default value specified by user policy. This should never be returned.
GENERATE_REPORT Attendance report will be generated and sent to drive/email.
DO_NOT_GENERATE Attendance report will not be generated.

ArtifactConfig

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

JSON representation
{
  "recordingConfig": {
    object (RecordingConfig)
  },
  "transcriptionConfig": {
    object (TranscriptionConfig)
  },
  "smartNotesConfig": {
    object (SmartNotesConfig)
  }
}
Fields
recordingConfig

object (RecordingConfig)

Configuration for recording.

transcriptionConfig

object (TranscriptionConfig)

Configuration for auto-transcript.

smartNotesConfig

object (SmartNotesConfig)

Configuration for auto-smart-notes.

RecordingConfig

Configuration related to recording in a meeting space.

JSON representation
{
  "autoRecordingGeneration": enum (AutoGenerationType)
}
Fields
autoRecordingGeneration

enum (AutoGenerationType)

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

AutoGenerationType

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

Enums
AUTO_GENERATION_TYPE_UNSPECIFIED Default value specified by user policy. This should never be returned.
ON The artifact is generated automatically.
OFF The artifact is not generated automatically.

TranscriptionConfig

Configuration related to transcription in a meeting space.

JSON representation
{
  "autoTranscriptionGeneration": enum (AutoGenerationType)
}
Fields
autoTranscriptionGeneration

enum (AutoGenerationType)

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

SmartNotesConfig

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

JSON representation
{
  "autoSmartNotesGeneration": enum (AutoGenerationType)
}
Fields
autoSmartNotesGeneration

enum (AutoGenerationType)

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.

ActiveConference

Active conference.

JSON representation
{
  "conferenceRecord": string
}
Fields
conferenceRecord

string

Output only. Reference to 'ConferenceRecord' resource. Format: conferenceRecords/{conferenceRecord} where {conferenceRecord} is a unique ID for each instance of a call within a space.

Methods

create

Creates a space.

endActiveConference

Ends an active conference (if there's one).

get

Gets details about a meeting space.

patch

Updates details about a meeting space.