तीसरे पक्ष की कॉन्फ़्रेंस बनाना

आपके स्क्रिप्ट प्रोजेक्ट के मेनिफ़ेस्ट में तय किए गए हर कॉन्फ़्रेंस समाधान के साथ एक onCreateFunction जुड़ा होता है. जब भी कोई उपयोगकर्ता किसी इवेंट में कॉन्फ़्रेंस करने के लिए, कॉन्फ़्रेंस करने की सेवा चुनता है, तो ऐड-ऑन इस फ़ंक्शन को कॉल करता है.

आपको अपने ऐड-ऑन मेनिफ़ेस्ट में बताए गए हर onCreateFunction को लागू करना होगा. आम तौर पर, इन फ़ंक्शन को ये काम करने होंगे:

1. Google Calendar के किसी इवेंट की जानकारी पाना. जैसे, इवेंट का आईडी या मेहमानों की सूची. कॉन्फ़्रेंस बनाने के लिए, तीसरे पक्ष के कॉन्फ़्रेंसिंग सिस्टम को इस जानकारी की ज़रूरत पड़ सकती है.
2. तीसरे पक्ष की कॉन्फ़्रेंसिंग सेवा से कनेक्ट करें और Google Calendar इवेंट की जानकारी का इस्तेमाल करके, वहां एक नई कॉन्फ़्रेंस बनाएं.
3. अगर कॉन्फ़्रेंस बनाने का अनुरोध किसी वजह से पूरा नहीं हो पाता है, तो गड़बड़ी की जानकारी का इस्तेमाल करके, ConferenceError वाला ConferenceData ऑब्जेक्ट बनाएं और दिखाएं. अगर ऐसा नहीं होता है, तो अगले चरण पूरे करें.
   1. कॉन्फ़्रेंस को सिंक करना शुरू करें.
   2. तीसरे पक्ष की कॉन्फ़्रेंसिंग सेवा से मिली जानकारी का इस्तेमाल करके, नया ConferenceData ऑब्जेक्ट बनाएं और उसे दिखाएं.

इवेंट की जानकारी हासिल करना

तीसरे पक्ष की कॉन्फ़्रेंस बनाने के लिए, उससे जुड़े Google Calendar इवेंट के बारे में कुछ जानकारी ज़रूरी है. तीसरे पक्ष के अलग-अलग कॉन्फ़्रेंस सिस्टम के लिए, इवेंट की ज़रूरी जानकारी अलग-अलग होती है. हालांकि, अक्सर इसमें इवेंट शुरू होने का समय, खत्म होने का समय, खास जानकारी, हिस्सा लेने वाले लोगों की सूची, और आईडी शामिल होता है.

कॉल किए जाने पर, आपके तय किए गए हर onCreateFunction को एक आर्ग्युमेंट दिया जाता है. इसमें कैलेंडर और इवेंट आईडी शामिल होते हैं. Google Calendar की बेहतर सेवा का इस्तेमाल करके, इवेंट की पूरी जानकारी पाने के लिए, इन आईडी का इस्तेमाल किया जा सकता है.

Google Calendar, किसी इवेंट के होने से पहले ही उसमें कॉन्फ़्रेंस की जानकारी जोड़ सकता है. ऐसे मामलों में, Google Calendar onCreateFunction को एक मान्य eventId पास करता है. हालांकि, Calendar.Events.get() को बाद में किए गए कॉल से, गड़बड़ी का जवाब मिल सकता है, जिसमें कहा जा सकता है कि इवेंट मौजूद नहीं है. ऐसे मामलों में, प्लेसहोल्डर डेटा का इस्तेमाल करके तीसरे पक्ष की कॉन्फ़्रेंस बनाना सबसे सही होता है. इवेंट के अगली बार सिंक होने पर, यह डेटा बदल जाता है.

तीसरे पक्ष का कॉन्फ़्रेंस बनाना

onCreateFunction के ज़रूरी इवेंट डेटा को वापस पाने के बाद, उसे कॉन्फ़्रेंस बनाने के लिए तीसरे पक्ष के कॉन्फ़्रेंसिंग सिस्टम से कनेक्ट करना होगा. आम तौर पर, तीसरे पक्ष के कॉन्फ़्रेंसिंग सिस्टम के साथ काम करने वाले एपीआई अनुरोधों की मदद से ऐसा किया जाता है. तीसरे पक्ष के कॉन्फ़्रेंसिंग सलूशन के दस्तावेज़ देखें. इससे आपको यह पता चलेगा कि कॉन्फ़्रेंस बनाने के लिए, किन एपीआई अनुरोधों का इस्तेमाल किया जा सकता है.

Apps Script में, बाहरी एपीआई के अनुरोधों को मैनेज करने का सबसे आसान तरीका, Apps Script के लिए OAuth2 या Apps Script के लिए OAuth1 ओपन-सोर्स लाइब्रेरी का इस्तेमाल करना है. UrlFetch सेवा का इस्तेमाल करके, बाहरी एपीआई से भी कनेक्ट किया जा सकता है. हालांकि, इसके लिए आपको अनुमति की जानकारी साफ़ तौर पर मैनेज करनी होगी.

कॉन्फ़्रेंस बनाने का अनुरोध करने के बाद, आपको कॉन्फ़्रेंस की नई जानकारी पाने के लिए, कुछ और अनुरोध करने पड़ सकते हैं.

कॉन्फ़्रेंस को सिंक करना शुरू करना

जब ऐड-ऑन किसी तीसरे पक्ष के सिस्टम पर कॉन्फ़्रेंस बना लेता है, तो सिंक करने की सुविधा चालू करने के लिए कुछ चरण पूरे करने होंगे. इससे Google Calendar इवेंट में किए गए बदलाव, कॉन्फ़्रेंस में दिखेंगे.

कॉन्फ़्रेंस बनाने के बाद, सिंक करने की सुविधा सेट अप करने के बारे में जानने के लिए, Calendar में किए गए बदलावों को सिंक करना देखें.

कॉन्फ़्रेंस डेटा रिस्पॉन्स बनाना

तीसरे पक्ष की सेवा से मिली कॉन्फ़्रेंस की जानकारी का इस्तेमाल करके, onCreateFunction को एक ConferenceData ऑब्जेक्ट बनाकर उसे दिखाना होगा. कॉन्फ़्रेंस का डेटा सेक्शन में, इस ऑब्जेक्ट के कॉन्टेंट के बारे में बताया गया है. Google Calendar इस जानकारी का इस्तेमाल करता है, ताकि कॉन्फ़्रेंस शुरू होने के बाद, उपयोगकर्ताओं को उस पर रीडायरेक्ट किया जा सके.

ConferenceData ऑब्जेक्ट बनाते समय, ध्यान रखें कि फ़ील्ड की लंबाई, एंट्री पॉइंट यूआरआई के फ़ॉर्मैट, और एंट्री पॉइंट के अनुमति वाले कॉम्बिनेशन पर कुछ सीमाएं हैं. उदाहरण के लिए, एक ConferenceData में ज़्यादा से ज़्यादा एक VIDEO एंट्री पॉइंट हो सकता है. ये सीमाएं, Calendar API इवेंट में बताई गई सीमाओं से मिलती-जुलती हैं. ये सीमाएं, उससे जुड़े conferenceData फ़ील्ड के लिए होती हैं. हालांकि, वहां बताए गए सभी एपीआई इवेंट फ़ील्ड, Apps Script में उपलब्ध नहीं हैं.

गड़बड़ियों को मैनेज करना

कुछ मामलों में, तीसरे पक्ष के कॉन्फ़्रेंसिंग सिस्टम से मिली गड़बड़ी की वजह से कॉन्फ़्रेंस बनाने की प्रोसेस पूरी नहीं हो पाती. इन मामलों में, आपका ऐड-ऑन गड़बड़ी की स्थिति को बेहतर तरीके से मैनेज करना चाहिए. इसके लिए, वह ConferenceError की जानकारी वाला ConferenceData ऑब्जेक्ट बनाकर उसे दिखाएगा, ताकि Google Calendar उसी हिसाब से काम कर सके.

किसी गड़बड़ी की शिकायत करने के लिए ConferenceData ऑब्जेक्ट बनाते समय, आपको ConferenceError ऑब्जेक्ट के अलावा कोई और ConferenceData कॉम्पोनेंट शामिल करने की ज़रूरत नहीं है. ConferenceErrors में ConferenceErrorType, गड़बड़ी का मैसेज हो सकता है. साथ ही, पुष्टि करने से जुड़ी समस्याओं के मामले में, ऐसा यूआरएल भी हो सकता है जिसकी मदद से उपयोगकर्ता, तीसरे पक्ष के कॉन्फ़्रेंसिंग सिस्टम में लॉग इन कर सकें.

उदाहरण

यहां onCreateFunction का एक उदाहरण दिया गया है. ध्यान दें कि फ़ंक्शन का नाम कुछ भी हो सकता है. आपको सिर्फ़ अपने ऐड-ऑन प्रोजेक्ट के मेनिफ़ेस्ट में इसे तय करना होगा.

create3rdPartyConference() फ़ंक्शन, तीसरे पक्ष के सिस्टम से संपर्क करके वहां कॉन्फ़्रेंस बनाता है. साथ ही, getAuthenticationUrl() फ़ंक्शन, तीसरे पक्ष के सिस्टम की पुष्टि करने वाला यूआरएल बनाता है. ये यहां पूरी तरह से लागू नहीं किए गए हैं, क्योंकि ये तीसरे पक्ष के सिस्टम की जानकारी पर काफ़ी निर्भर हैं.

फ़ंक्शन 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;
}