การสร้างการประชุมของบุคคลที่สาม

หมายเหตุ: ฟังก์ชันการทำงานนี้สร้างขึ้นสำหรับผู้ให้บริการการประชุมโดยเฉพาะ และเดิมมีให้บริการเป็นส่วนเสริมการประชุมในปฏิทิน

โซลูชันการประชุมแต่ละรายการที่คุณกำหนดไว้ในโปรเจ็กต์สคริปต์ไฟล์ Manifestจะมี onCreateFunction ที่เชื่อมโยงกัน ส่วนเสริมจะเรียกใช้ฟังก์ชันนี้เพื่อสร้างการประชุมทุกครั้งที่ผู้ใช้พยายามเลือกโซลูชันการประชุมนั้นในกิจกรรม

คุณต้องติดตั้งใช้งาน onCreateFunction แต่ละรายการที่อธิบายไว้ในไฟล์ Manifest ของส่วนเสริม โดยทั่วไปแล้ว ฟังก์ชันเหล่านี้ต้องทําสิ่งต่อไปนี้

1. ดึงข้อมูลกิจกรรมใน Google ปฏิทิน เช่น รหัสกิจกรรมหรือรายชื่อผู้เข้าร่วม ซึ่งระบบการประชุมของบุคคลที่สามอาจต้องใช้เพื่อสร้างการประชุม
2. เชื่อมต่อกับบริการการประชุมของบุคคลที่สามและสร้างการประชุมใหม่โดยใช้ข้อมูลกิจกรรมใน Google ปฏิทิน
3. หากคําขอสร้างการประชุมไม่สําเร็จเนื่องจากเหตุผลบางอย่าง ให้ใช้ข้อมูลข้อผิดพลาดเพื่อสร้างและแสดงออบเจ็กต์ ConferenceData ที่มี ConferenceError หรือทำตามขั้นตอนถัดไป
   1. เริ่มต้นการซิงค์การประชุม
   2. ใช้ข้อมูลที่บริการการประชุมของบุคคลที่สามแสดงผลเพื่อสร้างและแสดงผลออบเจ็กต์ ConferenceData ใหม่

กำลังดึงข้อมูลกิจกรรม

หากต้องการสร้างการประชุมของบุคคลที่สาม คุณจะต้องมีข้อมูลบางอย่างเกี่ยวกับกิจกรรมใน Google ปฏิทินที่เกี่ยวข้อง ข้อมูลกิจกรรมที่แน่นอนที่จำเป็นจะแตกต่างกันไปในแต่ละระบบการประชุมของบุคคลที่สาม แต่มักรวมถึงเวลาเริ่มต้นและสิ้นสุดของกิจกรรม สรุป รายชื่อผู้เข้าร่วม และรหัส

เมื่อเรียกใช้ onCreateFunction แต่ละรายการที่คุณกำหนดจะได้รับอาร์กิวเมนต์ที่มีรหัสปฏิทินและกิจกรรม คุณสามารถใช้รหัสเหล่านี้เพื่อเรียกข้อมูลกิจกรรมทั้งหมดโดยใช้บริการขั้นสูงของ Google ปฏิทิน

Google ปฏิทินอาจเพิ่มรายละเอียดการประชุมลงในกิจกรรมก่อนที่กิจกรรมนั้นจะมีอยู่ ในกรณีเช่นนี้ Google ปฏิทินจะส่ง onCreateFunction ที่ถูกต้องให้กับ eventId แต่การเรียกใช้ Calendar.Events.get() ในภายหลังอาจส่งผลให้มีการตอบกลับข้อผิดพลาดว่าไม่มีกิจกรรมดังกล่าว ในกรณีเหล่านี้ วิธีที่ดีที่สุดคือสร้างการประชุมของบุคคลที่สามโดยใช้ข้อมูลตัวยึดตำแหน่ง ระบบจะแทนที่ข้อมูลนี้เมื่อซิงค์เหตุการณ์ครั้งถัดไป

การสร้างการประชุมของบุคคลที่สาม

เมื่อ onCreateFunction ดึงข้อมูลกิจกรรมที่จำเป็นแล้ว จะต้องเชื่อมต่อกับระบบการประชุมของบุคคลที่สามเพื่อสร้างการประชุม โดยปกติแล้วการดำเนินการนี้จะทำได้โดยการส่งคำขอ API ที่ระบบการประชุมของบุคคลที่สามรองรับ โปรดอ่านเอกสารประกอบของโซลูชันการประชุมของบุคคลที่สามเพื่อดูคำขอ API ที่คุณสามารถใช้สร้างการประชุมได้

ใน Apps Script วิธีที่ง่ายที่สุดในการจัดการคําขอ API ภายนอกคือการใช้ไลบรารีโอเพนซอร์ส OAuth2 สําหรับ Apps Script หรือ OAuth1 สําหรับ Apps Script นอกจากนี้ คุณยังเชื่อมต่อกับ API ภายนอกได้โดยใช้บริการ UrlFetch แต่วิธีนี้กำหนดให้คุณต้องจัดการรายละเอียดการให้สิทธิ์อย่างชัดเจน

หลังจากส่งคำขอสร้างการประชุมแล้ว คุณอาจต้องส่งคำขอเพิ่มเติมเพื่อเรียกดูรายละเอียดการประชุมใหม่

เริ่มต้นการซิงค์การประชุม

เมื่อส่วนเสริมสร้างการประชุมในระบบของบุคคลที่สามเรียบร้อยแล้ว ระบบจะใช้เวลา 2-3 ขั้นตอนเพื่อเปิดใช้การซิงค์เพื่อให้การเปลี่ยนแปลงกิจกรรมใน Google ปฏิทินแสดงในการประชุม

ดูรายละเอียดเกี่ยวกับการตั้งค่าการซิงค์หลังจากสร้างการประชุมได้ที่การซิงค์การเปลี่ยนแปลงในปฏิทิน

การสร้างการตอบกลับข้อมูลการประชุม

เมื่อใช้ข้อมูลการประชุมที่บริการของบุคคลที่สามแสดง onCreateFunction จะต้องสร้างและแสดงออบเจ็กต์ ConferenceData ส่วนข้อมูลการประชุมจะอธิบายเนื้อหาของออบเจ็กต์นี้ Google ปฏิทินจะใช้ข้อมูลนี้เพื่อนำผู้ใช้ไปยังการประชุมเมื่อการประชุมเริ่มขึ้น

เมื่อสร้างออบเจ็กต์ ConferenceData ให้ทราบว่ามีข้อจำกัดบางอย่างเกี่ยวกับความยาวของช่อง รูปแบบของ URI ของจุดแรกเข้า และการผสมผสานของจุดแรกเข้าที่อนุญาต ตัวอย่างเช่น VIDEO อาจมีจุดเข้าใช้งานได้สูงสุด 1 จุดในConferenceData รายการเดียว ข้อจํากัดเหล่านี้เหมือนกับข้อจํากัดที่อธิบายไว้ในกิจกรรม Calendar API สําหรับช่อง conferenceData ที่เกี่ยวข้อง แม้ว่าช่องเหตุการณ์ API บางช่องที่อธิบายไว้จะใช้งานไม่ได้ใน Apps Script

การจัดการข้อผิดพลาด

ในบางกรณี การสร้างการประชุมจะดำเนินการไม่สำเร็จเนื่องจากระบบการประชุมของบุคคลที่สามแสดงข้อผิดพลาด ในกรณีเหล่านี้ ส่วนเสริมควรจัดการกับเงื่อนไขข้อผิดพลาดอย่างมีประสิทธิภาพโดยการสร้างและแสดงผลออบเจ็กต์ ConferenceData ที่มีรายละเอียด ConferenceError เพื่อให้ Google ปฏิทินดำเนินการตามความเหมาะสม

เมื่อสร้างออบเจ็กต์ ConferenceData เพื่อรายงานข้อผิดพลาด คุณไม่จำเป็นต้องใส่คอมโพเนนต์ ConferenceData ใดๆ นอกเหนือจากออบเจ็กต์ ConferenceError ConferenceErrors อาจมี ConferenceErrorType, ข้อความแสดงข้อผิดพลาด และในกรณีที่มีปัญหาเกี่ยวกับการตรวจสอบสิทธิ์ จะมี URL ที่อนุญาตให้ผู้ใช้เข้าสู่ระบบการประชุมของบุคคลที่สาม

หมายเหตุ: ส่วนเสริมไม่จําเป็นต้องพยายามตั้งค่าการซิงค์การประชุมหากการสร้างการประชุมไม่สําเร็จ

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดง onCreateFunction (โปรดทราบว่าชื่อของฟังก์ชันจะเป็นอะไรก็ได้ คุณเพียงต้องกำหนดชื่อในไฟล์ Manifest ของโปรเจ็กต์ส่วนเสริม)

ฟังก์ชัน create3rdPartyConference() จะติดต่อระบบของบุคคลที่สามเพื่อสร้างการประชุม และฟังก์ชัน getAuthenticationUrl() จะสร้าง URL การตรวจสอบสิทธิ์ของระบบของบุคคลที่สาม เราไม่ได้ใช้ฟีเจอร์เหล่านี้อย่างเต็มรูปแบบที่นี่ เนื่องจากฟีเจอร์เหล่านี้ขึ้นอยู่กับรายละเอียดของระบบของบุคคลที่สามเป็นอย่างมาก

ฟังก์ชัน initializeSyncing() จะไม่แสดงที่นี่ แต่จะจัดการงานเบื้องต้นที่จําเป็นสําหรับการซิงค์ โปรดดูรายละเอียดที่หัวข้อซิงค์การเปลี่ยนแปลงในปฏิทิน

/**
 *  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;
}