1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="meet_v2.html">Google Meet API</a> . <a href="meet_v2.spaces.html">spaces</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a space.</p>
<p class="toc_element">
<code><a href="#endActiveConference">endActiveConference(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#end-active-conference).</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space).</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#update-meeting-space).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a space.
Args:
body: object, The request body.
The object takes the form of:
{ # Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
"activeConference": { # Active conference. # Active conference, if it exists.
"conferenceRecord": "A String", # 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.
},
"config": { # The configuration pertaining to a meeting space. # Configuration pertaining to the meeting space.
"accessType": "A String", # 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.
"artifactConfig": { # Configuration related to meeting artifacts potentially generated by this meeting space. # Configuration pertaining to the auto-generated artifacts that the meeting supports.
"recordingConfig": { # Configuration related to recording in a meeting space. # Configuration for recording.
"autoRecordingGeneration": "A String", # Defines whether a meeting space is automatically recorded when someone with the privilege to record 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](https://support.google.com/meet/answer/14754931). # Configuration for auto-smart-notes.
"autoSmartNotesGeneration": "A String", # 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.
},
"transcriptionConfig": { # Configuration related to transcription in a meeting space. # Configuration for auto-transcript.
"autoTranscriptionGeneration": "A String", # Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.
},
},
"attendanceReportGenerationType": "A String", # Whether attendance report is enabled for the meeting space.
"entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
"moderation": "A String", # The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.
"moderationRestrictions": { # Defines restrictions for features when the meeting is moderated. # When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.
"chatRestriction": "A String", # Defines who has permission to send chat messages in the meeting space.
"defaultJoinAsViewerType": "A String", # Defines whether to restrict the default role assigned to users as viewer.
"presentRestriction": "A String", # Defines who has permission to share their screen in the meeting space.
"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space.
},
},
"meetingCode": "A 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.
"meetingUri": "A String", # 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`.
"name": "A 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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
"activeConference": { # Active conference. # Active conference, if it exists.
"conferenceRecord": "A String", # 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.
},
"config": { # The configuration pertaining to a meeting space. # Configuration pertaining to the meeting space.
"accessType": "A String", # 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.
"artifactConfig": { # Configuration related to meeting artifacts potentially generated by this meeting space. # Configuration pertaining to the auto-generated artifacts that the meeting supports.
"recordingConfig": { # Configuration related to recording in a meeting space. # Configuration for recording.
"autoRecordingGeneration": "A String", # Defines whether a meeting space is automatically recorded when someone with the privilege to record 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](https://support.google.com/meet/answer/14754931). # Configuration for auto-smart-notes.
"autoSmartNotesGeneration": "A String", # 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.
},
"transcriptionConfig": { # Configuration related to transcription in a meeting space. # Configuration for auto-transcript.
"autoTranscriptionGeneration": "A String", # Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.
},
},
"attendanceReportGenerationType": "A String", # Whether attendance report is enabled for the meeting space.
"entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
"moderation": "A String", # The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.
"moderationRestrictions": { # Defines restrictions for features when the meeting is moderated. # When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.
"chatRestriction": "A String", # Defines who has permission to send chat messages in the meeting space.
"defaultJoinAsViewerType": "A String", # Defines whether to restrict the default role assigned to users as viewer.
"presentRestriction": "A String", # Defines who has permission to share their screen in the meeting space.
"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space.
},
},
"meetingCode": "A 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.
"meetingUri": "A String", # 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`.
"name": "A 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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).
}</pre>
</div>
<div class="method">
<code class="details" id="endActiveConference">endActiveConference(name, body=None, x__xgafv=None)</code>
<pre>Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#end-active-conference).
Args:
name: string, 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/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
body: object, The request body.
The object takes the form of:
{ # Request to end an ongoing conference of a space.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space).
Args:
name: string, 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/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
"activeConference": { # Active conference. # Active conference, if it exists.
"conferenceRecord": "A String", # 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.
},
"config": { # The configuration pertaining to a meeting space. # Configuration pertaining to the meeting space.
"accessType": "A String", # 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.
"artifactConfig": { # Configuration related to meeting artifacts potentially generated by this meeting space. # Configuration pertaining to the auto-generated artifacts that the meeting supports.
"recordingConfig": { # Configuration related to recording in a meeting space. # Configuration for recording.
"autoRecordingGeneration": "A String", # Defines whether a meeting space is automatically recorded when someone with the privilege to record 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](https://support.google.com/meet/answer/14754931). # Configuration for auto-smart-notes.
"autoSmartNotesGeneration": "A String", # 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.
},
"transcriptionConfig": { # Configuration related to transcription in a meeting space. # Configuration for auto-transcript.
"autoTranscriptionGeneration": "A String", # Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.
},
},
"attendanceReportGenerationType": "A String", # Whether attendance report is enabled for the meeting space.
"entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
"moderation": "A String", # The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.
"moderationRestrictions": { # Defines restrictions for features when the meeting is moderated. # When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.
"chatRestriction": "A String", # Defines who has permission to send chat messages in the meeting space.
"defaultJoinAsViewerType": "A String", # Defines whether to restrict the default role assigned to users as viewer.
"presentRestriction": "A String", # Defines who has permission to share their screen in the meeting space.
"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space.
},
},
"meetingCode": "A 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.
"meetingUri": "A String", # 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`.
"name": "A 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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#update-meeting-space).
Args:
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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
body: object, The request body.
The object takes the form of:
{ # Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
"activeConference": { # Active conference. # Active conference, if it exists.
"conferenceRecord": "A String", # 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.
},
"config": { # The configuration pertaining to a meeting space. # Configuration pertaining to the meeting space.
"accessType": "A String", # 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.
"artifactConfig": { # Configuration related to meeting artifacts potentially generated by this meeting space. # Configuration pertaining to the auto-generated artifacts that the meeting supports.
"recordingConfig": { # Configuration related to recording in a meeting space. # Configuration for recording.
"autoRecordingGeneration": "A String", # Defines whether a meeting space is automatically recorded when someone with the privilege to record 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](https://support.google.com/meet/answer/14754931). # Configuration for auto-smart-notes.
"autoSmartNotesGeneration": "A String", # 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.
},
"transcriptionConfig": { # Configuration related to transcription in a meeting space. # Configuration for auto-transcript.
"autoTranscriptionGeneration": "A String", # Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.
},
},
"attendanceReportGenerationType": "A String", # Whether attendance report is enabled for the meeting space.
"entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
"moderation": "A String", # The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.
"moderationRestrictions": { # Defines restrictions for features when the meeting is moderated. # When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.
"chatRestriction": "A String", # Defines who has permission to send chat messages in the meeting space.
"defaultJoinAsViewerType": "A String", # Defines whether to restrict the default role assigned to users as viewer.
"presentRestriction": "A String", # Defines who has permission to share their screen in the meeting space.
"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space.
},
},
"meetingCode": "A 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.
"meetingUri": "A String", # 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`.
"name": "A 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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).
}
updateMask: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Virtual place where conferences are held. Only one active conference can be held in one space at any given time.
"activeConference": { # Active conference. # Active conference, if it exists.
"conferenceRecord": "A String", # 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.
},
"config": { # The configuration pertaining to a meeting space. # Configuration pertaining to the meeting space.
"accessType": "A String", # 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.
"artifactConfig": { # Configuration related to meeting artifacts potentially generated by this meeting space. # Configuration pertaining to the auto-generated artifacts that the meeting supports.
"recordingConfig": { # Configuration related to recording in a meeting space. # Configuration for recording.
"autoRecordingGeneration": "A String", # Defines whether a meeting space is automatically recorded when someone with the privilege to record 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](https://support.google.com/meet/answer/14754931). # Configuration for auto-smart-notes.
"autoSmartNotesGeneration": "A String", # 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.
},
"transcriptionConfig": { # Configuration related to transcription in a meeting space. # Configuration for auto-transcript.
"autoTranscriptionGeneration": "A String", # Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.
},
},
"attendanceReportGenerationType": "A String", # Whether attendance report is enabled for the meeting space.
"entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL
"moderation": "A String", # The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.
"moderationRestrictions": { # Defines restrictions for features when the meeting is moderated. # When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions.
"chatRestriction": "A String", # Defines who has permission to send chat messages in the meeting space.
"defaultJoinAsViewerType": "A String", # Defines whether to restrict the default role assigned to users as viewer.
"presentRestriction": "A String", # Defines who has permission to share their screen in the meeting space.
"reactionRestriction": "A String", # Defines who has permission to send reactions in the meeting space.
},
},
"meetingCode": "A 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.
"meetingUri": "A String", # 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`.
"name": "A 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](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).
}</pre>
</div>
</body></html>
|