פיתוח תוסף ל-Google Workspace באמצעות Apps Script

המדריך למתחילים הזה יוצר תוסף פשוט של Google Workspace שמדגים דפי בית, טריגרים לפי הקשר והתחברות לממשקי API של צד שלישי.

התוסף יוצר הקשר או טקסט לא לפי הקשר בממשקים של Gmail, יומן Google ו-Drive. בתוסף מוצגת תמונה אקראית של חתול עם טקסט שמופיע כשכבת-על בתמונה. הטקסט הוא סטטי לדפי בית או מגיע את ההקשר של האפליקציה המארחת לטריגרים לפי הקשר.

מטרות

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

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

כדי להשתמש בדוגמה הזו, צריך לעמוד בדרישות המוקדמות הבאות:

• חשבון Google (חשבונות Google Workspace עשויים נדרש אישור של האדמין).

• דפדפן אינטרנט עם גישה לאינטרנט.

• פרויקט ב-Google Cloud.

הגדרת הסביבה

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

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

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

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

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

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

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

1. במסוף Google Cloud, נכנסים לתפריט menu > ממשקי API ו- שירותים > מסך ההסכמה של OAuth.

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

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

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

5. מעיינים בסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם האפליקציה נראה שהרישום תקין, לוחצים על חזרה למרכז הבקרה.

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

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

1. כדי ליצור פרויקט Apps Script חדש, נכנסים אל script.new.
2. לוחצים על פרויקט ללא שם.
3. משנים את השם של פרויקט Apps Script Cats ולוחצים על Rename.
4. לצד הקובץ Code.gs, לוחצים על סמל האפשרויות הנוספות more_vert > שינוי שם. נותנים לקובץ שם: Common.
5. לוחצים על 'הוספת קובץ' add > סקריפט. נותנים לקובץ שם: Gmail.
6. חוזרים על שלב 5 כדי ליצור 2 קובצי סקריפטים נוספים בשם Calendar ו-Drive. בסיום התהליך אמורים להיות לכם 4 קובצי סקריפטים נפרדים.

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

   Common.gs

     /**
    * This simple Google Workspace Add-on shows a random image of a cat in the
    * sidebar. When opened manually (the homepage card), some static text is
    * overlayed on the image, but when contextual cards are opened a new cat image
    * is shown with the text taken from that context (such as a message's subject
    * line) overlaying the image. There is also a button that updates the card with
    * a new random cat image.
    *
    * Click "File > Make a copy..." to copy the script, and "Publish > Deploy from
    * manifest > Install add-on" to install it.
    */
   
   /**
    * The maximum number of characters that can fit in the cat image.
    */
   var MAX_MESSAGE_LENGTH = 40;
   
   /**
    * Callback for rendering the homepage card.
    * @return {CardService.Card} The card to show to the user.
    */
   function onHomepage(e) {
     console.log(e);
     var hour = Number(Utilities.formatDate(new Date(), e.userTimezone.id, 'H'));
     var message;
     if (hour >= 6 && hour < 12) {
       message = 'Good morning';
     } else if (hour >= 12 && hour < 18) {
       message = 'Good afternoon';
     } else {
       message = 'Good night';
     }
     message += ' ' + e.hostApp;
     return createCatCard(message, true);
   }
   
   /**
    * Creates a card with an image of a cat, overlayed with the text.
    * @param {String} text The text to overlay on the image.
    * @param {Boolean} isHomepage True if the card created here is a homepage;
    *      false otherwise. Defaults to false.
    * @return {CardService.Card} The assembled card.
    */
   function createCatCard(text, isHomepage) {
     // Explicitly set the value of isHomepage as false if null or undefined.
     if (!isHomepage) {
       isHomepage = false;
     }
   
     // Use the "Cat as a service" API to get the cat image. Add a "time" URL
     // parameter to act as a cache buster.
     var now = new Date();
     // Replace forward slashes in the text, as they break the CataaS API.
     var caption = text.replace(/\//g, ' ');
     var imageUrl =
         Utilities.formatString('https://cataas.com/cat/says/%s?time=%s',
             encodeURIComponent(caption), now.getTime());
     var image = CardService.newImage()
         .setImageUrl(imageUrl)
         .setAltText('Meow')
   
     // Create a button that changes the cat image when pressed.
     // Note: Action parameter keys and values must be strings.
     var action = CardService.newAction()
         .setFunctionName('onChangeCat')
         .setParameters({text: text, isHomepage: isHomepage.toString()});
     var button = CardService.newTextButton()
         .setText('Change cat')
         .setOnClickAction(action)
         .setTextButtonStyle(CardService.TextButtonStyle.FILLED);
     var buttonSet = CardService.newButtonSet()
         .addButton(button);
   
     // Create a footer to be shown at the bottom.
     var footer = CardService.newFixedFooter()
         .setPrimaryButton(CardService.newTextButton()
             .setText('Powered by cataas.com')
             .setOpenLink(CardService.newOpenLink()
                 .setUrl('https://cataas.com')));
   
     // Assemble the widgets and return the card.
     var section = CardService.newCardSection()
         .addWidget(image)
         .addWidget(buttonSet);
     var card = CardService.newCardBuilder()
         .addSection(section)
         .setFixedFooter(footer);
   
     if (!isHomepage) {
       // Create the header shown when the card is minimized,
       // but only when this card is a contextual card. Peek headers
       // are never used by non-contexual cards like homepages.
       var peekHeader = CardService.newCardHeader()
         .setTitle('Contextual Cat')
         .setImageUrl('https://www.gstatic.com/images/icons/material/system/1x/pets_black_48dp.png')
         .setSubtitle(text);
       card.setPeekCardHeader(peekHeader)
     }
   
     return card.build();
   }
   
   /**
    * Callback for the "Change cat" button.
    * @param {Object} e The event object, documented {@link
    *     https://developers.google.com/gmail/add-ons/concepts/actions#action_event_objects
    *     here}.
    * @return {CardService.ActionResponse} The action response to apply.
    */
   function onChangeCat(e) {
     console.log(e);
     // Get the text that was shown in the current cat image. This was passed as a
     // parameter on the Action set for the button.
     var text = e.parameters.text;
   
     // The isHomepage parameter is passed as a string, so convert to a Boolean.
     var isHomepage = e.parameters.isHomepage === 'true';
   
     // Create a new card with the same text.
     var card = createCatCard(text, isHomepage);
   
     // Create an action response that instructs the add-on to replace
     // the current card with the new one.
     var navigation = CardService.newNavigation()
         .updateCard(card);
     var actionResponse = CardService.newActionResponseBuilder()
         .setNavigation(navigation);
     return actionResponse.build();
   }
   
   /**
    * Truncate a message to fit in the cat image.
    * @param {string} message The message to truncate.
    * @return {string} The truncated message.
    */
   function truncate(message) {
     if (message.length > MAX_MESSAGE_LENGTH) {
       message = message.slice(0, MAX_MESSAGE_LENGTH);
       message = message.slice(0, message.lastIndexOf(' ')) + '...';
     }
     return message;
   }
   
     

   Gmail.gs

     /**
    * Callback for rendering the card for a specific Gmail message.
    * @param {Object} e The event object.
    * @return {CardService.Card} The card to show to the user.
    */
   function onGmailMessage(e) {
     console.log(e);
     // Get the ID of the message the user has open.
     var messageId = e.gmail.messageId;
   
     // Get an access token scoped to the current message and use it for GmailApp
     // calls.
     var accessToken = e.gmail.accessToken;
     GmailApp.setCurrentMessageAccessToken(accessToken);
   
     // Get the subject of the email.
     var message = GmailApp.getMessageById(messageId);
     var subject = message.getThread().getFirstMessageSubject();
   
     // Remove labels and prefixes.
     subject = subject
         .replace(/^([rR][eE]|[fF][wW][dD])\:\s*/, '')
         .replace(/^\[.*?\]\s*/, '');
   
     // If neccessary, truncate the subject to fit in the image.
     subject = truncate(subject);
   
     return createCatCard(subject);
   }
   
   /**
    * Callback for rendering the card for the compose action dialog.
    * @param {Object} e The event object.
    * @return {CardService.Card} The card to show to the user.
    */
   function onGmailCompose(e) {
     console.log(e);
     var header = CardService.newCardHeader()
         .setTitle('Insert cat')
         .setSubtitle('Add a custom cat image to your email message.');
     // Create text input for entering the cat's message.
     var input = CardService.newTextInput()
         .setFieldName('text')
         .setTitle('Caption')
         .setHint('What do you want the cat to say?');
     // Create a button that inserts the cat image when pressed.
     var action = CardService.newAction()
         .setFunctionName('onGmailInsertCat');
     var button = CardService.newTextButton()
         .setText('Insert cat')
         .setOnClickAction(action)
         .setTextButtonStyle(CardService.TextButtonStyle.FILLED);
     var buttonSet = CardService.newButtonSet()
         .addButton(button);
     // Assemble the widgets and return the card.
     var section = CardService.newCardSection()
         .addWidget(input)
         .addWidget(buttonSet);
     var card = CardService.newCardBuilder()
         .setHeader(header)
         .addSection(section);
     return card.build();
   }
   
   /**
    * Callback for inserting a cat into the Gmail draft.
    * @param {Object} e The event object.
    * @return {CardService.UpdateDraftActionResponse} The draft update response.
    */
   function onGmailInsertCat(e) {
     console.log(e);
     // Get the text that was entered by the user.
     var text = e.formInput.text;
     // Use the "Cat as a service" API to get the cat image. Add a "time" URL
     // parameter to act as a cache buster.
     var now = new Date();
     var imageUrl = 'https://cataas.com/cat';
     if (text) {
       // Replace forward slashes in the text, as they break the CataaS API.
       var caption = text.replace(/\//g, ' ');
       imageUrl += Utilities.formatString('/says/%s?time=%s',
           encodeURIComponent(caption), now.getTime());
     }
     var imageHtmlContent = '<img style="display: block; max-height: 300px;" src="'
         + imageUrl + '"/>';
     var response = CardService.newUpdateDraftActionResponseBuilder()
         .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction()
             .addUpdateContent(imageHtmlContent,CardService.ContentType.MUTABLE_HTML)
             .setUpdateType(CardService.UpdateDraftBodyType.IN_PLACE_INSERT))
         .build();
     return response;
   }
   
     

   Calendar.gs

     /**
    * Callback for rendering the card for a specific Calendar event.
    * @param {Object} e The event object.
    * @return {CardService.Card} The card to show to the user.
    */
   function onCalendarEventOpen(e) {
     console.log(e);
     var calendar = CalendarApp.getCalendarById(e.calendar.calendarId);
     // The event metadata doesn't include the event's title, so using the
     // calendar.readonly scope and fetching the event by it's ID.
     var event = calendar.getEventById(e.calendar.id);
     if (!event) {
       // This is a new event still being created.
       return createCatCard('A new event! Am I invited?');
     }
     var title = event.getTitle();
     // If necessary, truncate the title to fit in the image.
     title = truncate(title);
     return createCatCard(title);
   }
   
     

   Drive.gs

     /**
    * Callback for rendering the card for specific Drive items.
    * @param {Object} e The event object.
    * @return {CardService.Card} The card to show to the user.
    */
   function onDriveItemsSelected(e) {
     console.log(e);
     var items = e.drive.selectedItems;
     // Include at most 5 items in the text.
     items = items.slice(0, 5);
     var text = items.map(function(item) {
       var title = item.title;
       // If neccessary, truncate the title to fit in the image.
       title = truncate(title);
       return title;
     }).join('\n');
     return createCatCard(text);
   }
   
     

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

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

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

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

    appsscript.json

       {
      "timeZone": "America/New_York",
      "dependencies": {
      },
      "exceptionLogging": "STACKDRIVER",
      "oauthScopes": [
        "https://www.googleapis.com/auth/calendar.addons.execute",
        "https://www.googleapis.com/auth/calendar.readonly",
        "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
        "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
        "https://www.googleapis.com/auth/gmail.addons.current.message.readonly",
        "https://www.googleapis.com/auth/gmail.addons.execute",
        "https://www.googleapis.com/auth/script.locale"],
      "runtimeVersion": "V8",
      "addOns": {
        "common": {
          "name": "Cats",
          "logoUrl": "https://www.gstatic.com/images/icons/material/system/1x/pets_black_48dp.png",
          "useLocaleFromApp": true,
          "homepageTrigger": {
            "runFunction": "onHomepage",
            "enabled": true
          },
          "universalActions": [{
            "label": "Learn more about Cataas",
            "openLink": "https://cataas.com"
          }]
        },
        "gmail": {
          "contextualTriggers": [{
            "unconditional": {
            },
            "onTriggerFunction": "onGmailMessage"
          }],
          "composeTrigger": {
            "selectActions": [{
              "text": "Insert cat",
              "runFunction": "onGmailCompose"
            }],
            "draftAccess": "NONE"
          }
        },
        "drive": {
          "onItemsSelectedTrigger": {
            "runFunction": "onDriveItemsSelected"
          }
        },
        "calendar": {
          "eventOpenTrigger": {
            "runFunction": "onCalendarEventOpen"
          }
        }
      }
    }
    
      

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

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

   כניסה לדף IAM & הגדרות אדמין

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

הגדרת פרויקט Cloud של פרויקט Apps Script

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

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

1. בפרויקט Apps Script, לוחצים על Editor (עריכה) code.
2. לוחצים על Deploy (פריסה) > בדיקת הפריסות.
3. לוחצים על התקנה > סיום.

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

1. נכנסים ל-Gmail.
2. כדי לפתוח את התוסף, לוחצים על הסמל בחלונית שמשמאל. חתולים pets.
3. אם מתבקשים, מאשרים את התוסף.
4. בתוסף מוצגים טקסט ותמונה של חתול. כדי לשנות: את התמונה, לוחצים על שינוי החתול.
5. אם תפתחו אימייל בזמן שהתוסף פתוח, התמונה תתרענן והטקסט ישתנה בשורת הנושא של האימייל (הוא חתוך אם הוא ארוך מדי).

אפשר לראות פונקציונליות דומה ביומן Google ב-Drive. אין צורך לאשר מחדש את כדי להשתמש בו באפליקציות המארחות האלה.

השלבים הבאים

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