REST Resource: spaces

資源:Space

舉辦會議的虛擬空間。一個空間在任何時間只能有一場進行中的會議。

JSON 表示法
{
  "name": string,
  "meetingUri": string,
  "meetingCode": string,
  "config": {
    object (SpaceConfig)
  },
  "activeConference": {
    object (ActiveConference)
  },
  "phoneAccess": [
    {
      object (PhoneAccess)
    }
  ],
  "gatewaySipAccess": [
    {
      object (GatewaySipAccess)
    }
  ]
}
欄位
name

string

不可變動。聊天室的資源名稱。

格式:spaces/{space}

{space} 是聊天室的資源 ID。這是伺服器產生的專屬 ID,且會區分大小寫。例如:jQCFfuBOdN5z

詳情請參閱「Meet 如何識別會議空間」。

meetingUri

string

僅供輸出。用於加入會議的 URI,由 https://meet.google.com/ 後接 meetingCode 組成。例如:https://meet.google.com/abc-mnop-xyz

meetingCode

string

僅供輸出。用於加入會議的易記專屬字串。

格式:[a-z]+-[a-z]+-[a-z]+。例如:abc-mnop-xyz

長度上限為 128 個字元。

只能做為聊天室名稱的別名,用來取得聊天室。

config

object (SpaceConfig)

會議空間的相關設定。

activeConference

object (ActiveConference)

進行中的通話 (如有)。

phoneAccess[]

object (PhoneAccess)

僅供輸出。這個會議空間的所有區域電話存取方法。可為空白。

gatewaySipAccess[]

object (GatewaySipAccess)

僅供輸出。可用於加入會議的 SIP 存取方法。可為空白。

SpaceConfig

會議空間的相關設定。

JSON 表示法
{
  "accessType": enum (AccessType),
  "entryPointAccess": enum (EntryPointAccess),
  "moderation": enum (Moderation),
  "moderationRestrictions": {
    object (ModerationRestrictions)
  },
  "attendanceReportGenerationType": enum (AttendanceReportGenerationType),
  "artifactConfig": {
    object (ArtifactConfig)
  }
}
欄位
accessType

enum (AccessType)

會議空間的存取類型,決定哪些人不必提出要求就能加入會議。預設:使用者的預設存取權設定。受企業使用者的管理員或 RESTRICTED 控制。

entryPointAccess

enum (EntryPointAccess)

定義可用於加入此會議空間所主辦會議的進入點。預設值:EntryPointAccess.ALL

moderation

enum (Moderation)

會議的預先設定管理模式。預設值:由使用者政策控管。

moderationRestrictions

object (ModerationRestrictions)

當「啟用控管」設為開啟時,這些限制就會在會議中生效。如果設為 OFF,系統會重設為預設的 ModerationRestrictions。

attendanceReportGenerationType

enum (AttendanceReportGenerationType)

會議空間是否已啟用出席狀況報告。

artifactConfig

object (ArtifactConfig)

會議支援的自動生成構件相關設定。

AccessType

會議空間的可能存取權類型。

列舉
ACCESS_TYPE_UNSPECIFIED 使用者所屬機構指定的預設值。注意:系統一律不會傳回這個值,而是傳回已設定的存取類型。
OPEN 只要有加入資訊 (例如網址或電話存取資訊),任何人都能加入會議,不必敲門。
TRUSTED 主辦人機構的成員、受邀的外部使用者和撥號加入的使用者,不必提出要求即可加入會議。其他人則必須要求加入。
RESTRICTED 只有受邀者可以直接加入會議,不必傳送加入要求。其他人則必須要求加入。

EntryPointAccess

可用於加入會議的進入點。例如:meet.google.com、Meet Embed SDK Web 或行動應用程式。

列舉
ENTRY_POINT_ACCESS_UNSPECIFIED 未使用。
ALL 可以存取所有進入點。
CREATOR_APP_ONLY 只有建立空間的 Google Cloud 雲端專案擁有的進入點,才能用於加入這個空間的會議。應用程式可以使用 Meet Embed SDK Web 或行動版 Meet SDK,建立自有進入點。

管理

會議的管理模式。開啟控管模式後,會議擁有者就能透過共同主辦人管理 (請參閱「成員」訊息) 和功能限制 (請參閱「ModerationRestrictions」訊息) 等功能,進一步控管會議。

列舉
MODERATION_UNSPECIFIED 未指定審核類型,這表示使用者未指定任何值,因為使用者不打算更新狀態。使用者不得將值設為未指定。
OFF 管理功能已關閉。
ON 已開啟內容審查功能。

ModerationRestrictions

定義會議設為控管模式時的功能限制。

JSON 表示法
{
  "chatRestriction": enum (RestrictionType),
  "reactionRestriction": enum (RestrictionType),
  "presentRestriction": enum (RestrictionType),
  "defaultJoinAsViewerType": enum (DefaultJoinAsViewerType)
}
欄位
chatRestriction

enum (RestrictionType)

定義哪些人可以在會議空間中傳送即時通訊訊息。

reactionRestriction

enum (RestrictionType)

定義誰有權在會議空間中傳送回應。

presentRestriction

enum (RestrictionType)

定義誰有權在會議空間中分享螢幕畫面。

defaultJoinAsViewerType

enum (DefaultJoinAsViewerType)

定義是否要將指派給使用者的預設角色限制為檢視者。

RestrictionType

決定誰有權使用特定功能。

列舉
RESTRICTION_TYPE_UNSPECIFIED 使用者政策指定的預設值。這個值絕不應傳回。
HOSTS_ONLY 會議擁有者和共同主辦人有權這麼做。
NO_RESTRICTION 所有參與者都具備權限。

DefaultJoinAsViewerType

根據預設,使用者會以共同編輯者身分加入。主辦人可以限制使用者只能以觀眾身分加入。注意:如果為 Member 資源中的使用者設定明確角色,使用者會以該角色加入。

列舉
DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED 使用者政策指定的預設值。這個值絕不應傳回。
ON 使用者預設會以檢視者身分加入。
OFF 使用者預設會以共同編輯者身分加入。

AttendanceReportGenerationType

會議空間是否啟用出席狀況報告的可能狀態。

列舉
ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED 使用者政策指定的預設值。這個值絕不應傳回。
GENERATE_REPORT 系統會產生出席狀況報告,並傳送至雲端硬碟/電子郵件。
DO_NOT_GENERATE 系統不會產生出席報表。

ArtifactConfig

與這個會議空間可能產生的會議構件相關的設定。

JSON 表示法
{
  "recordingConfig": {
    object (RecordingConfig)
  },
  "transcriptionConfig": {
    object (TranscriptionConfig)
  },
  "smartNotesConfig": {
    object (SmartNotesConfig)
  }
}
欄位
recordingConfig

object (RecordingConfig)

錄製設定。

transcriptionConfig

object (TranscriptionConfig)

自動轉錄設定。

smartNotesConfig

object (SmartNotesConfig)

自動智慧筆記的設定。

RecordingConfig

會議空間的錄製相關設定。

JSON 表示法
{
  "autoRecordingGeneration": enum (AutoGenerationType)
}
欄位
autoRecordingGeneration

enum (AutoGenerationType)

定義會議空間是否在有權錄製會議的使用者加入時自動錄製。

AutoGenerationType

決定是否可在會議空間中自動生成構件。

列舉
AUTO_GENERATION_TYPE_UNSPECIFIED 使用者政策指定的預設值。這個值絕不應傳回。
ON 系統會自動產生構件。
OFF 系統不會自動產生構件。

TranscriptionConfig

會議空間的轉錄功能相關設定。

JSON 表示法
{
  "autoTranscriptionGeneration": enum (AutoGenerationType)
}
欄位
autoTranscriptionGeneration

enum (AutoGenerationType)

定義有權轉錄會議的使用者加入會議時,是否要自動轉錄會議內容。

SmartNotesConfig

會議空間中的智慧筆記相關設定。如要進一步瞭解智慧筆記,請參閱「Google Meet 的『幫我做筆記』功能」一文。

JSON 表示法
{
  "autoSmartNotesGeneration": enum (AutoGenerationType)
}
欄位
autoSmartNotesGeneration

enum (AutoGenerationType)

定義當有權啟用智慧筆記的使用者加入會議時,是否要為機構中的所有受邀者自動產生會議摘要和重點回顧。

ActiveConference

進行中的會議。

JSON 表示法
{
  "conferenceRecord": string
}
欄位
conferenceRecord

string

僅供輸出。參照「ConferenceRecord」資源。格式:conferenceRecords/{conferenceRecord},其中 {conferenceRecord} 是空間內每次通話的專屬 ID。

PhoneAccess

電話存取權包含撥入電話會議所需的資訊,例如區域電話號碼和該電話號碼專用的 PIN 碼。

JSON 表示法
{
  "phoneNumber": string,
  "pin": string,
  "regionCode": string,
  "languageCode": string
}
欄位
phoneNumber

string

會議空間的撥入電話號碼,格式為 E.164。完整的電話號碼,開頭為「+」字元。

pin

string

使用者撥打指定號碼後必須輸入的 PIN 碼。PIN 碼只能包含十進位數字,長度可能有所不同。

regionCode

string

與這個電話存取權相關聯的國家/地區 CLDR/ISO 3166 區域代碼。供 i18n RegionCode 公用程式剖析。例如:瑞典的地區代碼為「SE」。

languageCode

string

與這項電話存取權相關聯的語言 BCP 47/LDML 語言代碼。供 i18n LanguageCode 公用程式剖析。例如:拉丁美洲西班牙文為「es-419」,加拿大法文為「fr-CA」。

GatewaySipAccess

詳細說明如何透過 SIP 閘道加入會議。

JSON 表示法
{
  "uri": string,
  "sipAccessCode": string
}
欄位
uri

string

可透過對話啟動協定 (SIP) URI 加入會議。

字串採用下列其中一種格式:

其中 USER_ID 是 13 位數的通用 PIN 碼 (未來也可能支援使用 Meet 會議代碼),GATEWAY_ADDRESS 則是可透過 DNS SRV 查詢解析的有效位址,或是以點分隔的四個八位元。

sipAccessCode

string

在特別設定的裝置上手動輸入的永久數字代碼。

方法

create

建立聊天室。

endActiveConference

結束進行中的會議 (如有)。

get

取得會議空間的詳細資料。

patch

更新會議空間的詳細資料。