A meeting space represents a virtual place or a persistent object (such as a meeting room) where conferences are held. Only one active conference can be held in one space at any time. A meeting space also helps users meet and find shared resources.
The following sections detail how to create, get, and update a meeting space.
How Meet identifies a meeting space
The Google Meet REST API generates a spaces
resource for each meeting space. The name
field is the resource name for the
resource.
The following are two important ways to identify a meeting space using the
name
field:
space
is the resource identifier for the space, formatted asspaces/{space}
. It's a unique, server-generated ID and is case sensitive. For example,spaces/jQCFfuBOdN5z
.meetingCode
is an alias for the space, formatted asspaces/{meetingCode}
. It's a typeable, unique character string and is non-case sensitive. For example,abc-mnop-xyz
. The maximum length is 128 characters. It forms part of themeetingUri
:https://meet.google.com/abc-mnop-xyz
.
To manage a meeting space, use the following values for the {name}
field:
To get details about a meeting space, you can use either
spaces/{space}
or the aliasspaces/{meetingCode}
. For more information, see Get a meeting space.To update the details of a meeting space, you can only use
spaces/{space}
. For more information, see Update a meeting space.To end an active conference within a meeting space, you can only use
spaces/{space}
. For more information, see End active conference.
Create a meeting space
To create a meeting space, use the
create
method on the
spaces
resource.
The method returns an instance of a spaces
resource, which includes the
SpaceConfig
object that's
the configuration for the meeting space. It also contains the
ActiveConference
object
that's a link to the current
conferenceRecords
resource
within the meeting space.
The following code sample shows how to create a meeting space:
Java
Node.js
Python
Get a meeting space
To get details about a meeting space, use the
get
method on the
spaces
resource with a specified name
.
For more information, see How Meet identifies a meeting
space.
The method returns a meeting space as an instance of the
space
resource.
The following code sample shows how to retrieve a meeting space:
Java
Node.js
Python
Replace the space name with the unique server-generated ID for the meeting space.
Update a meeting space
To update the details of a meeting space, use the
patch
method on the
spaces
resource with a specified name
.
For more information, see How Meet identifies a meeting
space.
The patch
method also takes an optional updateMask
parameter. The field is
of type
FieldMask
.
This is a comma-delimited list of fields you want to update in the space.
The method returns a meeting space as an instance of the
spaces
resource.
The following code sample shows how to update a meeting space:
Java
Node.js
Python
Replace the space name with the unique server-generated ID for the meeting space.
End active conference
To end an active conference within a meeting space, use the
spaces.endActiveConference
method on the spaces
resource. Both the
request and response body are empty. For more information, see How
Meet identifies a meeting space.
The following code sample shows how to end an active conference:
Java
Node.js
Python
Replace the space name with the unique server-generated ID for the meeting space.