Mit Konferenzräumen arbeiten

Google Meet REST API
illustration

In diesem Leitfaden wird beschrieben, wie Sie einen Besprechungsraum erstellen, abrufen und aktualisieren sowie eine aktive Konferenz über die spaces-Ressource der Google Meet REST API beenden.

Ein Konferenzraum ist ein virtueller Ort oder ein dauerhaftes Objekt (z. B. ein Konferenzraum), in dem Konferenzen stattfinden. In einem Gruppenbereich kann immer nur eine aktive Videokonferenz stattfinden. Ein Gruppenbereich hilft Nutzern auch, sich zu treffen und gemeinsam genutzte Ressourcen zu finden.

Informationen zum programmatischen Konfigurieren eines Besprechungsraums finden Sie unter Besprechungsräume und Mitglieder konfigurieren.

In der folgenden Tabelle sind die Besprechungsrollen aufgeführt, die für die Verwendung der Methoden für Besprechungsräume erforderlich sind:

Methode Inhaber Teilnehmer Sonstiges
endActiveConference() x
get() x x x
     mit Einstellungen x
     mit aktiver Konferenz x x
patch() x

Wenn Sie die Authentifizierung und Autorisierung mit Nutzeranmeldedaten durchführen, können Google Meet-Apps auf Nutzerdaten zugreifen und im Namen des authentifizierten Nutzers Vorgänge ausführen. Wenn Sie sich mit der domainweiten Delegierung authentifizieren, können Sie das Dienstkonto einer Anwendung für den Zugriff auf die Daten Ihrer Nutzer autorisieren, ohne dass jeder Nutzer seine Einwilligung geben muss.

So wird ein Konferenzraum in Google Meet erkannt

Die Google Meet REST API generiert für jeden Besprechungsraum eine spaces-Ressource. Das Feld name ist der Ressourcenname der Ressource.

Es gibt zwei wichtige Möglichkeiten, einen Besprechungsraum mit dem Feld name anzugeben:

  • space ist die Ressourcen-ID für den Gruppenbereich, formatiert als spaces/{space}. Es handelt sich um eine eindeutige, servergenerierte ID, bei der zwischen Groß- und Kleinschreibung unterschieden wird. Beispiel: spaces/jQCFfuBOdN5z

  • meetingCode ist ein Alias für den Gruppenbereich, der als spaces/{meetingCode} formatiert ist. Es ist ein eingabefähiger, eindeutiger Zeichenstring, bei dem die Groß- und Kleinschreibung nicht berücksichtigt wird. Beispiel: abc-mnop-xyz Die maximale Länge beträgt 128 Zeichen. Sie ist Teil des meetingUri: https://meet.google.com/abc-mnop-xyz.

Verwenden Sie die folgenden Werte für das Feld {name}, um einen Besprechungsraum zu verwalten:

  • Sie können entweder spaces/{space} oder den Alias spaces/{meetingCode} verwenden, um Details zu einem Besprechungsraum abzurufen. Weitere Informationen finden Sie unter Videokonferenzraum erhalten.

  • Zum Aktualisieren der Details eines Besprechungsraums können Sie nur spaces/{space} verwenden. Weitere Informationen finden Sie unter Konferenzraum aktualisieren.

  • Um eine aktive Konferenz in einem Besprechungsraum zu beenden, können Sie nur spaces/{space} verwenden. Weitere Informationen finden Sie unter Aktive Konferenz beenden.

Besprechungsraum erstellen

Verwenden Sie zum Erstellen eines Konferenzraums die Methode create() für die Ressource spaces.

Die Methode gibt eine Instanz einer spaces-Ressource zurück, die das Objekt SpaceConfig enthält, das die Konfiguration für den Besprechungsraum darstellt. Außerdem enthält sie das ActiveConference-Objekt, das einen Link zur aktuellen conferenceRecords-Ressource im Konferenzraum darstellt.

Das folgende Codebeispiel zeigt, wie ein Besprechungsraum erstellt wird:

Java

java-meet/samples/snippets/generated/com/google/apps/meet/v2/spacesservice/createspace/AsyncCreateSpace.java
import com.google.api.core.ApiFuture;
import com.google.apps.meet.v2.CreateSpaceRequest;
import com.google.apps.meet.v2.Space;
import com.google.apps.meet.v2.SpacesServiceClient;

public class AsyncCreateSpace {

  public static void main(String[] args) throws Exception {
    asyncCreateSpace();
  }

  public static void asyncCreateSpace() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
      CreateSpaceRequest request =
          CreateSpaceRequest.newBuilder().setSpace(Space.newBuilder().build()).build();
      ApiFuture<Space> future = spacesServiceClient.createSpaceCallable().futureCall(request);
      // Do something.
      Space response = future.get();
    }
  }
}

Node.js

packages/google-apps-meet/samples/generated/v2/spaces_service.create_space.js
/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Space to be created. As of May 2023, the input space can be empty. Later on
 *  the input space can be non-empty when space configuration is introduced.
 */
// const space = {}

// Imports the Meet library
const {SpacesServiceClient} = require('@google-apps/meet').v2;

// Instantiates a client
const meetClient = new SpacesServiceClient();

async function callCreateSpace() {
  // Construct request
  const request = {
  };

  // Run request
  const response = await meetClient.createSpace(request);
  console.log(response);
}

callCreateSpace();

Python

packages/google-apps-meet/samples/generated_samples/meet_v2_generated_spaces_service_create_space_async.py
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.apps import meet_v2


async def sample_create_space():
    # Create a client
    client = meet_v2.SpacesServiceAsyncClient()

    # Initialize request argument(s)
    request = meet_v2.CreateSpaceRequest(
    )

    # Make the request
    response = await client.create_space(request=request)

    # Handle the response
    print(response)

Details zu einem Besprechungsraum abrufen

Wenn Sie Details zu einem aktiven Besprechungsraum und seinen Einstellungen abrufen möchten, verwenden Sie die Methode get() für die Ressource spaces mit einer angegebenen name. Weitere Informationen finden Sie unter So wird in Google Meet ein Besprechungsraum identifiziert.

Die Methode gibt einen Besprechungsraum als Instanz der Ressource spaces zurück.

Im folgenden Codebeispiel wird gezeigt, wie ein Besprechungsraum abgerufen wird:

Java

java-meet/samples/snippets/generated/com/google/apps/meet/v2/spacesservice/getspace/AsyncGetSpace.java
import com.google.api.core.ApiFuture;
import com.google.apps.meet.v2.GetSpaceRequest;
import com.google.apps.meet.v2.Space;
import com.google.apps.meet.v2.SpaceName;
import com.google.apps.meet.v2.SpacesServiceClient;

public class AsyncGetSpace {

  public static void main(String[] args) throws Exception {
    asyncGetSpace();
  }

  public static void asyncGetSpace() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
      GetSpaceRequest request =
          GetSpaceRequest.newBuilder().setName(SpaceName.of("[SPACE]").toString()).build();
      ApiFuture<Space> future = spacesServiceClient.getSpaceCallable().futureCall(request);
      // Do something.
      Space response = future.get();
    }
  }
}

Node.js

packages/google-apps-meet/samples/generated/v2/spaces_service.get_space.js
/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  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/meet/api/guides/meeting-spaces#identify-meeting-space).
 */
// const name = 'abc123'

// Imports the Meet library
const {SpacesServiceClient} = require('@google-apps/meet').v2;

// Instantiates a client
const meetClient = new SpacesServiceClient();

async function callGetSpace() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await meetClient.getSpace(request);
  console.log(response);
}

callGetSpace();

Python

packages/google-apps-meet/samples/generated_samples/meet_v2_generated_spaces_service_get_space_async.py
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.apps import meet_v2


async def sample_get_space():
    # Create a client
    client = meet_v2.SpacesServiceAsyncClient()

    # Initialize request argument(s)
    request = meet_v2.GetSpaceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_space(request=request)

    # Handle the response
    print(response)

Ersetzen Sie den Wert „Raumname“ durch die eindeutige, servergenerierte ID für den Besprechungsraum.

Besprechungsraum aktualisieren

Wenn Sie die Details eines Besprechungsraums aktualisieren möchten, verwenden Sie die Methode patch() für die Ressource spaces mit einer angegebenen name. Weitere Informationen finden Sie unter So wird in Google Meet ein Besprechungsraum identifiziert.

Die Methode patch() akzeptiert auch den optionalen Abfrageparameter updateMask. Das Feld hat den Typ FieldMask. Dies ist eine durch Kommas getrennte Liste der Felder, die Sie im Gruppenbereich aktualisieren möchten.

Die Methode gibt einen Besprechungsraum als Instanz der Ressource spaces zurück.

Im folgenden Codebeispiel wird gezeigt, wie ein Besprechungsraum aktualisiert wird:

Java

java-meet/samples/snippets/generated/com/google/apps/meet/v2/spacesservice/updatespace/AsyncUpdateSpace.java
import com.google.api.core.ApiFuture;
import com.google.apps.meet.v2.Space;
import com.google.apps.meet.v2.SpacesServiceClient;
import com.google.apps.meet.v2.UpdateSpaceRequest;
import com.google.protobuf.FieldMask;

public class AsyncUpdateSpace {

  public static void main(String[] args) throws Exception {
    asyncUpdateSpace();
  }

  public static void asyncUpdateSpace() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
      UpdateSpaceRequest request =
          UpdateSpaceRequest.newBuilder()
              .setSpace(Space.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .build();
      ApiFuture<Space> future = spacesServiceClient.updateSpaceCallable().futureCall(request);
      // Do something.
      Space response = future.get();
    }
  }
}

Node.js

packages/google-apps-meet/samples/generated/v2/spaces_service.update_space.js
/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Space to be updated.
 */
// const space = {}
/**
 *  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.
 */
// const updateMask = {}

// Imports the Meet library
const {SpacesServiceClient} = require('@google-apps/meet').v2;

// Instantiates a client
const meetClient = new SpacesServiceClient();

async function callUpdateSpace() {
  // Construct request
  const request = {
    space,
  };

  // Run request
  const response = await meetClient.updateSpace(request);
  console.log(response);
}

callUpdateSpace();

Python

packages/google-apps-meet/samples/generated_samples/meet_v2_generated_spaces_service_update_space_async.py
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.apps import meet_v2


async def sample_update_space():
    # Create a client
    client = meet_v2.SpacesServiceAsyncClient()

    # Initialize request argument(s)
    request = meet_v2.UpdateSpaceRequest(
    )

    # Make the request
    response = await client.update_space(request=request)

    # Handle the response
    print(response)

Ersetzen Sie den Wert „Raumname“ durch die eindeutige, servergenerierte ID für den Besprechungsraum.

Aktive Konferenz beenden

Wenn Sie eine aktive Konferenz in einem Gruppenbereich beenden möchten (falls vorhanden), verwenden Sie die Methode endActiveConference() für die Ressource spaces. Sowohl der Anfragetext als auch der Antworttext sind leer. Weitere Informationen finden Sie unter So erkennt Google Meet einen Konferenzraum.

Im folgenden Codebeispiel wird gezeigt, wie eine aktive Konferenz beendet wird:

Java

java-meet/samples/snippets/generated/com/google/apps/meet/v2/spacesservice/endactiveconference/AsyncEndActiveConference.java
import com.google.api.core.ApiFuture;
import com.google.apps.meet.v2.EndActiveConferenceRequest;
import com.google.apps.meet.v2.SpaceName;
import com.google.apps.meet.v2.SpacesServiceClient;
import com.google.protobuf.Empty;

public class AsyncEndActiveConference {

  public static void main(String[] args) throws Exception {
    asyncEndActiveConference();
  }

  public static void asyncEndActiveConference() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
      EndActiveConferenceRequest request =
          EndActiveConferenceRequest.newBuilder()
              .setName(SpaceName.of("[SPACE]").toString())
              .build();
      ApiFuture<Empty> future =
          spacesServiceClient.endActiveConferenceCallable().futureCall(request);
      // Do something.
      future.get();
    }
  }
}

Node.js

packages/google-apps-meet/samples/generated/v2/spaces_service.end_active_conference.js
/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  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/meet/api/guides/meeting-spaces#identify-meeting-space).
 */
// const name = 'abc123'

// Imports the Meet library
const {SpacesServiceClient} = require('@google-apps/meet').v2;

// Instantiates a client
const meetClient = new SpacesServiceClient();

async function callEndActiveConference() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await meetClient.endActiveConference(request);
  console.log(response);
}

callEndActiveConference();

Python

packages/google-apps-meet/samples/generated_samples/meet_v2_generated_spaces_service_end_active_conference_async.py
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.apps import meet_v2


async def sample_end_active_conference():
    # Create a client
    client = meet_v2.SpacesServiceAsyncClient()

    # Initialize request argument(s)
    request = meet_v2.EndActiveConferenceRequest(
        name="name_value",
    )

    # Make the request
    await client.end_active_conference(request=request)

Ersetzen Sie den Wert „Raumname“ durch die eindeutige, servergenerierte ID für den Besprechungsraum.