שיחת ועידה מהירה ביומן

חשוב: המדריך למתחילים מיועד רק לספקי שיחות ועידה באינטרנט.

התוסף הבא של Google Workspace לתוספים למתחילים נועד להרחיב את הסנכרון של יומן Google עם שירות פנטזי קצר-טווח לשיחות ועידה באינטרנט, שנקרא My Web Conference. כשעורכים אירועים ביומן, התוסף מאפשר למשתמשים לראות את שיחת הוועידה שלי באינטרנט כאפשרות לשיחת ועידה.

במדריך למתחילים תוכלו לראות איך יוצרים שיחות ועידה וסנכרון אירועים, אבל אי אפשר להשתמש בהן עד שמחברים אותן ל-API של הפתרון לשיחות ועידה.

מטרות

• הגדרת הסביבה.
• מגדירים את הסקריפט.
• מריצים את הסקריפט.

דרישות מוקדמות

• דפדפן אינטרנט עם גישה לאינטרנט.
• חשבון Google Workspace (יכול להיות שתצטרכו אישור אדמין).
• פרויקט ב-Google Cloud.

הגדרת הסביבה

פתיחת הפרויקט ב-Cloud במסוף Google Cloud

אם הוא לא פתוח, פותחים את הפרויקט ב-Cloud שבו אתם מתכוונים להשתמש בדוגמה הזו:

1. נכנסים לדף Select a project במסוף Google Cloud.

   בחירת פרויקט ב-Cloud

2. בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על יצירת פרויקט ופועלים לפי ההוראות שבמסך. אם אתם יוצרים פרויקט ב-Google Cloud, ייתכן שאתם צריכים להפעיל את החיוב בפרויקט.

מפעילים את Calendar API

במדריך למתחילים נעשה שימוש בשירות המתקדם של יומן Google, שיש לו גישה ל-יומן API. כדי להשתמש ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.

מפעילים את Calendar API בפרויקט ב-Google Cloud.

הפעלת ה-API

הגדרת מסך ההסכמה של OAuth

לתוספים ל-Google Workspace נדרשת הגדרה של מסך הסכמה. הגדרה של מסך ההסכמה ל-OAuth בתוסף Google Workspace מגדירה מה Google מציגה למשתמשים.

1. במסוף Google Cloud, נכנסים לתפריט > APIs & Services > מסך ההסכמה של OAuth.

   מעבר למסך ההסכמה של OAuth

2. בהגדרה סוג משתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
3. ממלאים את טופס ההרשמה לאפליקציה ולוחצים על שמירה והמשך.

4. בינתיים, אפשר לדלג על הוספת היקפים וללחוץ על שמירה והמשך. בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש לחיצוני ואז להוסיף את היקפי ההרשאות שנדרשים לאפליקציה.

5. לבדוק את הסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרישום של האפליקציה נראה בסדר, לוחצים על Back to Dashboard (חזרה למרכז השליטה).

הגדרת הסקריפט

יצירת פרויקט Apps Script

1. כדי ליצור פרויקט חדש ב-Apps Script, צריך לעבור לכתובת script.new.
2. לוחצים על פרויקט ללא שם.
3. משנים את השם של פרויקט Apps Script לתוסף לשיחות ועידה ולוחצים על שינוי שם.
4. לצד הקובץ Code.gs, לוחצים על סמל האפשרויות הנוספות > שינוי שם. נותנים לקובץ את השם CreateConf.
5. לוחצים על 'הוספת קובץ' > סקריפט.
6. נותנים לקובץ שם בשם Syncing.

7. מחליפים את התוכן של כל קובץ בקוד המתאים הבא:

   CreateConf.gs

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

   Syncing.gs

   /**
    *  Initializes syncing of conference data by creating a sync trigger and
    *  sync token if either does not exist yet.
    *
    *  @param {String} calendarId The ID of the Google Calendar.
    */
   function initializeSyncing(calendarId) {
     // Create a syncing trigger if it doesn't exist yet.
     createSyncTrigger(calendarId);
   
     // Perform an event sync to create the initial sync token.
     syncEvents({'calendarId': calendarId});
   }
   
   /**
    *  Creates a sync trigger if it does not exist yet.
    *
    *  @param {String} calendarId The ID of the Google Calendar.
    */
   function createSyncTrigger(calendarId) {
     // Check to see if the trigger already exists; if does, return.
     var allTriggers = ScriptApp.getProjectTriggers();
     for (var i = 0; i < allTriggers.length; i++) {
       var trigger = allTriggers[i];
       if (trigger.getTriggerSourceId() == calendarId) {
         return;
       }
     }
   
     // Trigger does not exist, so create it. The trigger calls the
     // 'syncEvents()' trigger function when it fires.
     var trigger = ScriptApp.newTrigger('syncEvents')
         .forUserCalendar(calendarId)
         .onEventUpdated()
         .create();
   }
   
   /**
    *  Sync events for the given calendar; this is the syncing trigger
    *  function. If a sync token already exists, this retrieves all events
    *  that have been modified since the last sync, then checks each to see
    *  if an associated conference needs to be updated and makes any required
    *  changes. If the sync token does not exist or is invalid, this
    *  retrieves future events modified in the last 24 hours instead. In
    *  either case, a new sync token is created and stored.
    *
    *  @param {Object} e If called by a event updated trigger, this object
    *      contains the Google Calendar ID, authorization mode, and
    *      calling trigger ID. Only the calendar ID is actually used here,
    *      however.
    */
   function syncEvents(e) {
     var calendarId = e.calendarId;
     var properties = PropertiesService.getUserProperties();
     var syncToken = properties.getProperty('syncToken');
   
     var options;
     if (syncToken) {
       // There's an existing sync token, so configure the following event
       // retrieval request to only get events that have been modified
       // since the last sync.
       options = {
         syncToken: syncToken
       };
     } else {
       // No sync token, so configure to do a 'full' sync instead. In this
       // example only recently updated events are retrieved in a full sync.
       // A larger time window can be examined during a full sync, but this
       // slows down the script execution. Consider the trade-offs while
       // designing your add-on.
       var now = new Date();
       var yesterday = new Date();
       yesterday.setDate(now.getDate() - 1);
       options = {
         timeMin: now.toISOString(),          // Events that start after now...
         updatedMin: yesterday.toISOString(), // ...and were modified recently
         maxResults: 50,   // Max. number of results per page of responses
         orderBy: 'updated'
       }
     }
   
     // Examine the list of updated events since last sync (or all events
     // modified after yesterday if the sync token is missing or invalid), and
     // update any associated conferences as required.
     var events;
     var pageToken;
     do {
       try {
         options.pageToken = pageToken;
         events = Calendar.Events.list(calendarId, options);
       } catch (err) {
         // Check to see if the sync token was invalidated by the server;
         // if so, perform a full sync instead.
         if (err.message ===
               "Sync token is no longer valid, a full sync is required.") {
           properties.deleteProperty('syncToken');
           syncEvents(e);
           return;
         } else {
           throw new Error(err.message);
         }
       }
   
       // Read through the list of returned events looking for conferences
       // to update.
       if (events.items && events.items.length > 0) {
         for (var i = 0; i < events.items.length; i++) {
            var calEvent = events.items[i];
            // Check to see if there is a record of this event has a
            // conference that needs updating.
            if (eventHasConference(calEvent)) {
              updateConference(calEvent, calEvent.conferenceData.conferenceId);
            }
         }
       }
   
       pageToken = events.nextPageToken;
     } while (pageToken);
   
     // Record the new sync token.
     if (events.nextSyncToken) {
       properties.setProperty('syncToken', events.nextSyncToken);
     }
   }
   
   /**
    *  Returns true if the specified event has an associated conference
    *  of the type managed by this add-on; retuns false otherwise.
    *
    *  @param {Object} calEvent The Google Calendar event object, as defined by
    *      the Calendar API.
    *  @return {boolean}
    */
   function eventHasConference(calEvent) {
     var name = calEvent.conferenceData.conferenceSolution.name || null;
   
     // This version checks if the conference data solution name matches the
     // one of the solution names used by the add-on. Alternatively you could
     // check the solution's entry point URIs or other solution-specific
     // information.
     if (name) {
       if (name === "My Web Conference" ||
           name === "My Recorded Web Conference") {
         return true;
       }
     }
     return false;
   }
   
   /**
    *  Update a conference based on new Google Calendar event information.
    *  The exact implementation of this function is highly dependant on the
    *  details of the third-party conferencing system, so only a rough outline
    *  is shown here.
    *
    *  @param {Object} calEvent The Google Calendar event object, as defined by
    *      the Calendar API.
    *  @param {String} conferenceId The ID used to identify the conference on
    *      the third-party conferencing system.
    */
   function updateConference(calEvent, conferenceId) {
     // Check edge case: the event was cancelled
     if (calEvent.status === 'cancelled' || eventHasConference(calEvent)) {
       // Use the third-party API to delete the conference too.
   
   
     } else {
       // Extract any necessary information from the event object, then
       // make the appropriate third-party API requests to update the
       // conference with that information.
   
     }
   }
   
   

8. לוחצים על Project Settings (הגדרות הפרויקט) .

9. מסמנים את התיבה הצגת קובץ המניפסט 'appsscript.json' בעורך.

10. לוחצים על עריכה .

11. פותחים את הקובץ appsscript.json ומחליפים את התוכן בקוד הבא, ולוחצים על 'שמירה' .

    appsscript.json

    {
      "addOns": {
        "calendar": {
          "conferenceSolution": [{
            "id": 1,
            "name": "My Web Conference",
            "logoUrl": "https://lh3.googleusercontent.com/...",
            "onCreateFunction": "createConference"
          }],
          "currentEventAccess": "READ_WRITE"
        },
        "common": {
          "homepageTrigger": {
            "enabled": false
          },
          "logoUrl": "https://lh3.googleusercontent.com/...",
          "name": "My Web Conferencing"
        }
      },
      "timeZone": "America/New_York",
      "dependencies": {
        "enabledAdvancedServices": [
        {
          "userSymbol": "Calendar",
          "serviceId": "calendar",
          "version": "v3"
        }
        ]
      },
      "webapp": {
        "access": "ANYONE",
        "executeAs": "USER_ACCESSING"
      },
      "exceptionLogging": "STACKDRIVER",
      "oauthScopes": [
        "https://www.googleapis.com/auth/calendar.addons.execute",
        "https://www.googleapis.com/auth/calendar.events.readonly",
        "https://www.googleapis.com/auth/calendar.addons.current.event.read",
        "https://www.googleapis.com/auth/calendar.addons.current.event.write",
        "https://www.googleapis.com/auth/script.external_request",
        "https://www.googleapis.com/auth/script.scriptapp"
      ]
    }
    
    

העתקת מספר הפרויקט ב-Cloud

1. במסוף Google Cloud, נכנסים לתפריט > IAM & Admin > הגדרות.

   כניסה לדף IAM & Admin Settings

2. מעתיקים את הערך בשדה Project number.

הגדרת הפרויקט בענן של פרויקט Apps Script

1. בפרויקט Apps Script, לוחצים על Project Settings (הגדרות הפרויקט) .
2. בקטע פרויקט Google Cloud Platform (GCP), לוחצים על שינוי פרויקט.
3. בקטע מספר פרויקט GCP, מדביקים את מספר הפרויקט ב-Google Cloud.
4. לוחצים על Set project.

התקנה של פריסת בדיקה

1. בפרויקט Apps Script, לוחצים על עריכה .
2. פותחים את הקובץ CreateConf.gs ולוחצים על הפעלה. כשמתבקשים, מאשרים את הסקריפט.
3. לוחצים על פריסה > בדיקת פריסות.
4. לוחצים על התקנה > סיום.

מריצים את הסקריפט

1. נכנסים לאתר calendar.google.com.
2. צור אירוע חדש או פתח אירוע קיים.
3. לוחצים על החץ למטה ליד הוספה של שיחת ועידה בווידאו ב-Google Meet. > שיחת הוועידה שלי באינטרנט. אם הודעת השגיאה יצירת שיחת הוועידה נכשלה, תופיע כי התוסף לא מחובר לפתרון אמיתי של שיחות ועידה של צד שלישי.

השלבים הבאים

• הרחבה של Google Workspace באמצעות תוספים
• יצירת תוספים ל-Google Workspace
• פרסום אפליקציה