Diese Seite wurde von der Cloud Translation API übersetzt.

Konferenzen mit Drittanbietern erstellen

Kurs

Jeder Konferenzlösung, die Sie im Manifest Ihres Skriptprojekts definiert haben, ist ein onCreateFunction verknüpft. Das Add-on ruft diese Funktion zum Erstellen einer Konferenz immer dann auf, wenn ein Nutzer versucht, diese Konferenzlösung als Ereignis auszuwählen.

Sie müssen jeden onCreateFunction implementieren, der in Ihrem Add-on-Manifest beschrieben ist. Im Allgemeinen müssen diese Funktionen Folgendes erfüllen:

Rufen Sie alle Termininformationen aus Google Kalender ab, z. B. die Termin-ID oder eine Liste der Teilnehmer, die das Drittanbietersystem möglicherweise benötigt, um die Konferenz zu erstellen.
Stellen Sie eine Verbindung zum Konferenzdienst des Drittanbieters her und erstellen Sie dort mit den Google Kalender-Termininformationen eine neue Konferenz.
Wenn die Anfrage zum Erstellen der Konferenz aus irgendeinem Grund fehlgeschlagen ist, verwenden Sie die Fehlerinformationen, um ein ConferenceData-Objekt mit einem ConferenceError-Objekt zu erstellen und zurückzugeben. Andernfalls führen Sie die nächsten Schritte aus.
1. Synchronisierung der Konferenz initialisieren
2. Verwenden Sie die vom Drittanbieterdienst zurückgegebenen Informationen, um ein neues ConferenceData-Objekt zu erstellen und zurückzugeben.

Termininformationen abrufen

Um eine Konferenz eines Drittanbieters zu erstellen, sind bestimmte Informationen zum entsprechenden Google Kalender-Termin erforderlich. Die genauen erforderlichen Veranstaltungsinformationen variieren je nach Konferenzsystem von Drittanbietern. Dazu gehören häufig der Beginn und das Ende des Termins, die Zusammenfassung, die Teilnehmerliste und die ID.

Beim Aufruf wird an jede von Ihnen definierte onCreateFunction ein Argument übergeben, das die Kalender- und Termin-IDs enthält. Mithilfe dieser IDs können Sie die vollständigen Termininformationen mit dem erweiterten Dienst von Google Kalender abrufen.

Google Kalender kann einem Termin Konferenzdetails hinzufügen, bevor er existiert. In solchen Fällen übergibt Google Kalender dem onCreateFunction eine gültige eventId. Nachfolgende Aufrufe von Calendar.Events.get() können jedoch zu einer Fehlermeldung führen, die besagt, dass der Termin nicht existiert. In diesen Fällen ist es am besten, die Drittanbieterkonferenz mit Platzhalterdaten zu erstellen. Diese Daten werden bei der nächsten Synchronisierung des Ereignisses ersetzt.

Drittanbieter-Konferenz erstellen

Nachdem onCreateFunction die erforderlichen Ereignisdaten abgerufen hat, muss eine Verbindung zum Konferenzsystem des Drittanbieters hergestellt werden, um die Konferenz zu erstellen. Dazu werden in der Regel API-Anfragen gestellt, die vom Konferenzsystem des Drittanbieters unterstützt werden. Sehen Sie in der Dokumentation Ihrer Drittanbieter-Konferenzlösung nach, welche API-Anfragen Sie zum Erstellen von Konferenzen verwenden können.

In Apps Script lassen sich externe API-Anfragen am einfachsten mithilfe der Open-Source-Bibliotheken OAuth2 für Apps Script oder OAuth1 für Apps Script verarbeiten. Sie können mit dem UrlFetch-Dienst auch eine Verbindung zu externen APIs herstellen. Dazu müssen Sie jedoch die Autorisierungsdetails explizit verarbeiten.

Nachdem Sie die Erstellung der Konferenz angefordert haben, müssen Sie möglicherweise zusätzliche Anfragen stellen, um die neuen Konferenzdetails abzurufen.

Konferenzsynchronisierung initialisieren

Nachdem das Add-on erfolgreich eine Konferenz auf dem System eines Drittanbieters erstellt hat, sollten Sie einige Schritte ausführen, um die Synchronisierung zu aktivieren, damit Änderungen am Google Kalender-Termin in der Konferenz berücksichtigt werden.

Wie Sie die Synchronisierung nach dem Erstellen einer Konferenz einrichten, erfahren Sie unter Kalenderänderungen synchronisieren.

Konferenzdatenantwort erstellen

Mithilfe der vom Drittanbieterdienst zurückgegebenen Konferenzinformationen muss der onCreateFunction dann ein ConferenceData-Objekt erstellen und zurückgeben. Im Abschnitt Konferenzdaten wird der Inhalt dieses Objekts beschrieben. Google Kalender verwendet diese Informationen, um Nutzer zur Konferenz zu leiten, sobald diese begonnen hat.

Beachten Sie beim Erstellen eines ConferenceData-Objekts, dass es einige Einschränkungen für Feldlängen, Formate der Einstiegspunkt-URIs und die zulässigen Kombinationen von Einstiegspunkten gibt. Beispielsweise kann es maximal einen VIDEO-Einstiegspunkt in einer einzelnen ConferenceData geben. Diese Einschränkungen sind identisch mit den Einschränkungen, die im Kalender API-Ereignis für das entsprechende conferenceData-Feld beschrieben sind. Allerdings sind nicht alle hier beschriebenen API-Ereignisfelder in Apps Script verfügbar.

Fehlerbehebung

In einigen Fällen kann die Konferenzerstellung aufgrund eines Fehlers, der vom Konferenzsystem des Drittanbieters zurückgegeben wurde, nicht abgeschlossen werden. In diesen Fällen sollte das Add-on die Fehlerbedingung stabil verarbeiten, indem ein ConferenceData-Objekt mit ConferenceError-Details erstellt und zurückgegeben wird, damit Google Kalender entsprechend reagieren kann.

Wenn Sie ein ConferenceData-Objekt zum Melden eines Fehlers erstellen, müssen Sie außer dem ConferenceError-Objekt keine ConferenceData-Komponenten hinzufügen. ConferenceErrors kann eine ConferenceErrorType, eine Fehlermeldung und im Fall von Authentifizierungsproblemen eine URL enthalten, über die sich Nutzer im Konferenzsystem des Drittanbieters anmelden können.

Beispiel

Das folgende Beispiel zeigt ein onCreateFunction-Objekt. Der Name der Funktion kann beliebig sein. Sie müssen sie nur in Ihrem Add-on-Projektmanifest definieren.

Die Funktion create3rdPartyConference() kontaktiert das Drittanbietersystem, um die Konferenz dort zu erstellen, und die Funktion getAuthenticationUrl() erzeugt eine Drittanbieter-Systemauthentifizierungs-URL. Sie sind hier nicht vollständig implementiert, da sie stark von den Details des Drittanbietersystems abhängen.

Die Funktion initializeSyncing() wird hier nicht gezeigt. Sie erledigt alle Vorarbeiten, die für die Synchronisierung erforderlich sind. Weitere Informationen finden Sie unter Kalenderänderungen synchronisieren.

/**
 *  Creates a conference, then builds and returns a ConferenceData object
 *  with the corresponding conference information. This method is called
 *  when a user selects a conference solution defined by the add-on that
 *  uses this function as its 'onCreateFunction' in the add-on manifest.
 *
 *  @param {Object} arg The default argument passed to a 'onCreateFunction';
 *      it carries information about the Google Calendar event.
 *  @return {ConferenceData}
 */
function createConference(arg) {
  const eventData = arg.eventData;
  const calendarId = eventData.calendarId;
  const eventId = eventData.eventId;

  // Retrieve the Calendar event information using the Calendar
  // Advanced service.
  var calendarEvent;
  try {
    calendarEvent = Calendar.Events.get(calendarId, eventId);
  } catch (err) {
    // The calendar event does not exist just yet; just proceed with the
    // given event ID and allow the event details to sync later.
    console.log(err);
    calendarEvent = {
      id: eventId,
    };
  }

  // Create a conference on the third-party service and return the
  // conference data or errors in a custom JSON object.
  var conferenceInfo = create3rdPartyConference(calendarEvent);

  // Build and return a ConferenceData object, either with conference or
  // error information.
  var dataBuilder = ConferenceDataService.newConferenceDataBuilder();

  if (!conferenceInfo.error) {
    // No error, so build the ConferenceData object from the
    // returned conference info.

    var phoneEntryPoint = ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
        .setUri('tel:+' + conferenceInfo.phoneNumber)
        .setPin(conferenceInfo.phonePin);

    var adminEmailParameter = ConferenceDataService.newConferenceParameter()
        .setKey('adminEmail')
        .setValue(conferenceInfo.adminEmail);

    dataBuilder.setConferenceId(conferenceInfo.id)
        .addEntryPoint(phoneEntryPoint)
        .addConferenceParameter(adminEmailParameter)
        .setNotes(conferenceInfo.conferenceLegalNotice);

    if (conferenceInfo.videoUri) {
      var videoEntryPoint = ConferenceDataService.newEntryPoint()
          .setEntryPointType(ConferenceDataService.EntryPointType.VIDEO)
          .setUri(conferenceInfo.videoUri)
          .setPasscode(conferenceInfo.videoPasscode);
      dataBuilder.addEntryPoint(videoEntryPoint);
    }

    // Since the conference creation request succeeded, make sure that
    // syncing has been enabled.
    initializeSyncing(calendarId, eventId, conferenceInfo.id);

  } else if (conferenceInfo.error === 'AUTH') {
    // Authenentication error. Implement a function to build the correct
    // authenication URL for the third-party conferencing system.
    var authenticationUrl = getAuthenticationUrl();
    var error = ConferenceDataService.newConferenceError()
        .setConferenceErrorType(
            ConferenceDataService.ConferenceErrorType.AUTHENTICATION)
        .setAuthenticationUrl(authenticationUrl);
    dataBuilder.setError(error);

  } else {
    // Other error type;
    var error = ConferenceDataService.newConferenceError()
        .setConferenceErrorType(
            ConferenceDataService.ConferenceErrorType.TEMPORARY);
    dataBuilder.setError(error);
  }

  // Don't forget to build the ConferenceData object.
  return dataBuilder.build();
}


/**
 *  Contact the third-party conferencing system to create a conference there,
 *  using the provided calendar event information. Collects and retuns the
 *  conference data returned by the third-party system in a custom JSON object
 *  with the following fields:
 *
 *    data.adminEmail - the conference administrator's email
 *    data.conferenceLegalNotice - the conference legal notice text
 *    data.error - Only present if there was an error during
 *         conference creation. Equal to 'AUTH' if the add-on user needs to
 *         authorize on the third-party system.
 *    data.id - the conference ID
 *    data.phoneNumber - the conference phone entry point phone number
 *    data.phonePin - the conference phone entry point PIN
 *    data.videoPasscode - the conference video entry point passcode
 *    data.videoUri - the conference video entry point URI
 *
 *  The above fields are specific to this example; which conference information
 *  your add-on needs is dependent on the third-party conferencing system
 *  requirements.
 *
 * @param {Object} calendarEvent A Calendar Event resource object returned by
 *     the Google Calendar API.
 * @return {Object}
 */
function create3rdPartyConference(calendarEvent) {
  var data = {};

  // Implementation details dependent on the third-party system API.
  // Typically one or more API calls are made to create the conference and
  // acquire its relevant data, which is then put in to the returned JSON
  // object.

  return data;
}

/**
 *  Return the URL used to authenticate the user with the third-party
 *  conferencing system.
 *
 *  @return {String}
 */
function getAuthenticationUrl() {
  var url;
  // Implementation details dependent on the third-party system.

  return url;
}