তৃতীয় পক্ষের সম্মেলন তৈরি করুন

আপনার স্ক্রিপ্ট প্রজেক্ট ম্যানিফেস্টে সংজ্ঞায়িত প্রতিটি কনফারেন্স সলিউশনের সাথে একটি onCreateFunction যুক্ত থাকে। যখনই কোনো ব্যবহারকারী কোনো ইভেন্টের জন্য সেই কনফারেন্স সলিউশনটি নির্বাচন করার চেষ্টা করেন, গুগল ওয়ার্কস্পেস অ্যাড-অনটি একটি কনফারেন্স তৈরি করার জন্য এই ফাংশনটিকে কল করে।

আপনার অ্যাড-অন ম্যানিফেস্টে বর্ণিত প্রতিটি onCreateFunction বাস্তবায়ন করুন। এই ফাংশনগুলোকে অবশ্যই নিম্নলিখিত কাজগুলো করতে হবে:

  1. গুগল ক্যালেন্ডার ইভেন্টের যেকোনো তথ্য, যেমন ইভেন্ট আইডি বা অংশগ্রহণকারীদের তালিকা, সংগ্রহ করুন যা থার্ড-পার্টি কনফারেন্সিং সিস্টেমের কনফারেন্স তৈরি করার জন্য প্রয়োজন।
  2. তৃতীয় পক্ষের কনফারেন্সিং পরিষেবাতে সংযোগ করুন এবং ক্যালেন্ডারের ইভেন্টের তথ্য ব্যবহার করে সেখানে একটি নতুন কনফারেন্স তৈরি করুন।
  3. যদি কনফারেন্স তৈরির অনুরোধ ব্যর্থ হয়, তাহলে ত্রুটির তথ্য ব্যবহার করে একটি ConferenceError সম্বলিত ConferenceData অবজেক্ট তৈরি করে ফেরত দিন। অন্যথায়, পরবর্তী ধাপগুলো সম্পন্ন করুন।
  4. কনফারেন্স সিঙ্কিং শুরু করুন।
  5. তৃতীয় পক্ষের কনফারেন্সিং পরিষেবা থেকে প্রাপ্ত তথ্য ব্যবহার করে একটি নতুন ConferenceData অবজেক্ট তৈরি ও ফেরত দিন।

ইভেন্টের তথ্য পুনরুদ্ধার করুন

একটি থার্ড-পার্টি কনফারেন্স তৈরি করতে, সংশ্লিষ্ট ক্যালেন্ডার ইভেন্ট সম্পর্কিত তথ্যের প্রয়োজন হয়। প্রয়োজনীয় সুনির্দিষ্ট ইভেন্ট তথ্য বিভিন্ন থার্ড-পার্টি কনফারেন্স সিস্টেম ভেদে ভিন্ন হয়, তবে এতে প্রায়শই ইভেন্টের শুরুর সময়, শেষের সময়, সারাংশ, অংশগ্রহণকারীদের তালিকা এবং আইডি অন্তর্ভুক্ত থাকে।

কল করা হলে, আপনার সংজ্ঞায়িত প্রতিটি onCreateFunction একটি আর্গুমেন্ট পাস করা হয়, যাতে ক্যালেন্ডার এবং ইভেন্ট আইডিগুলো থাকে। ক্যালেন্ডার অ্যাডভান্সড সার্ভিস ব্যবহার করে ইভেন্টের সম্পূর্ণ তথ্য পুনরুদ্ধার করতে এই আইডিগুলো ব্যবহার করুন।

কোনো ইভেন্ট তৈরি হওয়ার আগেই ক্যালেন্ডার তাতে কনফারেন্সের বিবরণ যোগ করে ফেলতে পারে। এমন ক্ষেত্রে, ক্যালেন্ডার তার onCreateFunction এ একটি বৈধ eventId পাঠায়, কিন্তু পরবর্তীতে Calendar.Events.get কল করলে ইভেন্টটি বিদ্যমান নেই বলে একটি এরর আসতে পারে। এই পরিস্থিতিতে, প্লেসহোল্ডার ডেটা ব্যবহার করে থার্ড-পার্টি কনফারেন্সটি তৈরি করুন; পরেরবার ইভেন্টটি সিঙ্ক হলে এই ডেটা প্রতিস্থাপিত হয়ে যাবে।

তৃতীয় পক্ষের সম্মেলন তৈরি করুন

onCreateFunction প্রয়োজনীয় ইভেন্ট ডেটা সংগ্রহ করার পর, কনফারেন্স তৈরি করার জন্য এটিকে অবশ্যই থার্ড-পার্টি কনফারেন্সিং সিস্টেমের সাথে সংযোগ স্থাপন করতে হবে। সাধারণত, থার্ড-পার্টি কনফারেন্সিং সিস্টেম দ্বারা সমর্থিত API অনুরোধ পাঠানোর মাধ্যমে এটি সম্পন্ন করা হয়। কনফারেন্স তৈরি করার জন্য আপনি কোন API অনুরোধগুলো ব্যবহার করতে পারবেন তা জানতে আপনার থার্ড-পার্টি কনফারেন্সিং সলিউশনের ডকুমেন্টেশন দেখুন।

গুগল অ্যাপস স্ক্রিপ্টে, এক্সটার্নাল এপিআই রিকোয়েস্ট পাঠানোর সবচেয়ে সহজ উপায় হলো OAuth2 for Apps Script বা OAuth1 for Apps Script ওপেন-সোর্স লাইব্রেরিগুলো ব্যবহার করা। আপনি UrlFetch সার্ভিস ব্যবহার করেও এক্সটার্নাল এপিআই-এর সাথে কানেক্ট করতে পারেন, কিন্তু এর জন্য আপনাকে অথরাইজেশনের বিবরণগুলো স্পষ্টভাবে পরিচালনা করতে হবে।

কনফারেন্স তৈরির অনুরোধ করার পর, নতুন কনফারেন্সের বিবরণ পেতে আপনাকে অতিরিক্ত অনুরোধ করতে হতে পারে।

কনফারেন্স সিঙ্কিং শুরু করুন

অ্যাড-অনটি কোনো থার্ড-পার্টি সিস্টেমে সফলভাবে একটি কনফারেন্স তৈরি করার পর, সিঙ্কিং চালু করতে কয়েকটি ধাপ অনুসরণ করতে হবে, যাতে ক্যালেন্ডার ইভেন্টের পরিবর্তনগুলো কনফারেন্সে প্রতিফলিত হয়।

কনফারেন্স তৈরির পর সিঙ্কিং সেট আপ করার বিস্তারিত তথ্যের জন্য ‘ক্যালেন্ডার পরিবর্তন সিঙ্কিং’ দেখুন।

একটি কনফারেন্স ডেটা প্রতিক্রিয়া তৈরি করুন

তৃতীয় পক্ষের পরিষেবা থেকে প্রাপ্ত কনফারেন্সের তথ্য ব্যবহার করে, onCreateFunction কে অবশ্যই একটি ConferenceData অবজেক্ট তৈরি করে ফেরত দিতে হবে; ‘কনফারেন্স ডেটা’ অংশটি এই অবজেক্টের বিষয়বস্তু বর্ণনা করে। কনফারেন্সটি শুরু হয়ে গেলে, ক্যালেন্ডার এই তথ্য ব্যবহার করে ব্যবহারকারীদের সেখানে নির্দেশিত করে।

একটি ConferenceData অবজেক্ট তৈরি করার সময়, ফিল্ডের দৈর্ঘ্য, এন্ট্রি পয়েন্ট URI-এর ফরম্যাট এবং এন্ট্রি পয়েন্টের অনুমোদিত সংমিশ্রণ সম্পর্কে সচেতন থাকুন। উদাহরণস্বরূপ, একটি ConferenceData তে সর্বাধিক একটি VIDEO এন্ট্রি পয়েন্ট থাকতে পারে। এই সীমাবদ্ধতাগুলি সংশ্লিষ্ট conferenceData ফিল্ডের জন্য ক্যালেন্ডার এপিআই ইভেন্টে বর্ণিত সীমাবদ্ধতার অনুরূপ, যদিও সেখানে বর্ণিত সমস্ত এপিআই ইভেন্ট ফিল্ড অ্যাপস স্ক্রিপ্টে উপলব্ধ নয়।

ত্রুটিগুলি পরিচালনা করুন

কনফারেন্স তৈরির প্রক্রিয়ার সময় ত্রুটি ঘটতে পারে। কিছু ক্ষেত্রে, তৃতীয় পক্ষের কনফারেন্সিং সিস্টেম থেকে আসা কোনো ত্রুটির কারণে কনফারেন্স তৈরি সম্পন্ন করা যায় না। এইসব ক্ষেত্রে, আপনার অ্যাড-অনটির উচিত ConferenceError বিবরণ সম্বলিত একটি ConferenceData অবজেক্ট তৈরি ও ফেরত দিয়ে ত্রুটিটি সামাল দেওয়া, যাতে ক্যালেন্ডার সেই অনুযায়ী ব্যবস্থা নিতে পারে।

ত্রুটি জানানোর জন্য একটি ConferenceData অবজেক্ট তৈরি করার সময়, ConferenceError অবজেক্টটি ছাড়া অন্য কোনো ConferenceData কম্পোনেন্ট অন্তর্ভুক্ত করার প্রয়োজন নেই। ConferenceErrors একটি ConferenceErrorType , একটি ত্রুটির বার্তা এবং প্রমাণীকরণ সংক্রান্ত সমস্যার জন্য একটি URL থাকতে পারে, যা ব্যবহারকারীদের তৃতীয় পক্ষের কনফারেন্সিং সিস্টেমে লগ ইন করার সুযোগ দেয়।

কনফারেন্স তৈরির প্রচেষ্টা ব্যর্থ হলে আপনার অ্যাড-অনটির কনফারেন্স সিঙ্কিং সেট আপ করার চেষ্টা করার প্রয়োজন নেই।

উদাহরণ

নিম্নলিখিত উদাহরণটি একটি 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;
}