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