יצירת סדר יום לפגישות

רמת קידוד: מתחילים
משך: 15 דקות
סוג הפרויקט: אוטומציה עם טריגר מבוסס-אירוע

מטרות

• מבינים מה הפתרון עושה.
• להבין מה שירותי Apps Script עושים בפתרון.
• מגדירים את הסקריפט.
• מריצים את הסקריפט.

מידע על הפתרון הזה

יצירה אוטומטית של מסמכי סדר יום ב-Google Docs וצירוף שלהם לפגישות ביומן Google.

איך זה עובד

הסקריפט יוצר תבנית מסמך של סדר יום. כשאתם מעדכנים את היומן, הסקריפט בודק אם יש אירועים בבעלותכם שכוללים את ' #agenda' בתיאור. אם התג קיים, הסקריפט יוצר עותק של התבנית, מוסיף אותו לאירוע ביומן ומשתף אותו עם המשתתפים באירוע.

שירותי Apps Script

הפתרון הזה משתמש בשירותים הבאים:

• שירות Drive – בודק אם המסמך בתבנית קיים ואם לא קיים, יוצר תיקייה חדשה עבור מסמך התבנית. יוצר עותק של תבנית המסמך עבור כל סדר יום חדש.
• שירות מסמכים – יוצר את התבנית של סדר היום.
• שירות יומן – בודק אירועים עם התג "#agenda" ומעדכנת את תיאור האירוע עם קישור למסמך של סדר היום.
• Base service – משתמש במחלקה Session כדי לקבל את האימייל של המשתמש. הפעולה הזו עוזרת ליצור את הטריגר עבור המשתמש הנוכחי.
• שירות סקריפט – יוצר טריגר שמופעל בכל פעם שיש שינוי ביומן של המשתמש.

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

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

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

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

1. לוחצים על הלחצן שלמטה כדי לפתוח את פרויקט Apps Script לדוגמה יצירת סדר יום לפגישות.
   פתיחת הפרויקט
2. לוחצים על סקירה כללית .
3. בדף הסקירה הכללית, לוחצים על 'יצירת עותק' .
4. בפרויקט שהועתק, בתפריט הנפתח של הפונקציה, בוחרים באפשרות setUp.
5. לוחצים על Run.
6. כשמוצגת בקשה, מאשרים את הסקריפט. אם במסך ההסכמה של OAuth מוצגת האזהרה האפליקציה הזו לא מאומתת, ממשיכים בלחיצה על מתקדם > מעבר אל {Project Name} (לא בטוח).

הרצת הסקריפט

1. פותחים את יומן Google.
2. יוצרים אירוע חדש או עורכים אירוע קיים.
3. צריך להוסיף את #agenda בתיאור, ולשמור את האירוע.
4. תוכלו לחפש באימייל הודעה על שיתוף מסמך, או לרענן את יומן Google וללחוץ שוב על האירוע כדי להציג את הקישור למסמך של סדר היום.

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

בדיקת הקוד

כדי לבדוק את קוד Apps Script של הפתרון הזה, יש ללחוץ על הצגת קוד מקור למטה:

הצגת קוד המקור

Code.gs

solutions/automations/agenda-maker/Code.js

הצגת הקוד ב-GitHub

// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/agenda-maker

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * Checks if the folder for Agenda docs exists, and creates it if it doesn't.
 *
 * @return {*} Drive folder ID for the app.
 */
function checkFolder() {
  const folders = DriveApp.getFoldersByName('Agenda Maker - App');
  // Finds the folder if it exists
  while (folders.hasNext()) {
    let folder = folders.next();
    if (
      folder.getDescription() ==
        'Apps Script App - Do not change this description' &&
      folder.getOwner().getEmail() == Session.getActiveUser().getEmail()
    ) {
      return folder.getId();
    }
  }
  // If the folder doesn't exist, creates one
  let folder = DriveApp.createFolder('Agenda Maker - App');
  folder.setDescription('Apps Script App - Do not change this description');
  return folder.getId();
}

/**
 * Finds the template agenda doc, or creates one if it doesn't exist.
 */
function getTemplateId(folderId) {
  const folder = DriveApp.getFolderById(folderId);
  const files = folder.getFilesByName('Agenda TEMPLATE##');

  // If there is a file, returns the ID.
  while (files.hasNext()) {
    const file = files.next();
    return file.getId();
  }

  // Otherwise, creates the agenda template.
  // You can adjust the default template here
  const doc = DocumentApp.create('Agenda TEMPLATE##');
  const body = doc.getBody();

  body
      .appendParagraph('##Attendees##')
      .setHeading(DocumentApp.ParagraphHeading.HEADING1)
      .editAsText()
      .setBold(true);
  body.appendParagraph(' ').editAsText().setBold(false);

  body
      .appendParagraph('Overview')
      .setHeading(DocumentApp.ParagraphHeading.HEADING1)
      .editAsText()
      .setBold(true);
  body.appendParagraph(' ');
  body.appendParagraph('- Topic 1: ').editAsText().setBold(true);
  body.appendParagraph(' ').editAsText().setBold(false);
  body.appendParagraph('- Topic 2: ').editAsText().setBold(true);
  body.appendParagraph(' ').editAsText().setBold(false);
  body.appendParagraph('- Topic 3: ').editAsText().setBold(true);
  body.appendParagraph(' ').editAsText().setBold(false);

  body
      .appendParagraph('Next Steps')
      .setHeading(DocumentApp.ParagraphHeading.HEADING1)
      .editAsText()
      .setBold(true);
  body.appendParagraph('- Takeaway 1: ').editAsText().setBold(true);
  body.appendParagraph('- Responsible: ').editAsText().setBold(false);
  body.appendParagraph('- Accountable: ');
  body.appendParagraph('- Consult: ');
  body.appendParagraph('- Inform: ');
  body.appendParagraph(' ');
  body.appendParagraph('- Takeaway 2: ').editAsText().setBold(true);
  body.appendParagraph('- Responsible: ').editAsText().setBold(false);
  body.appendParagraph('- Accountable: ');
  body.appendParagraph('- Consult: ');
  body.appendParagraph('- Inform: ');
  body.appendParagraph(' ');
  body.appendParagraph('- Takeaway 3: ').editAsText().setBold(true);
  body.appendParagraph('- Responsible: ').editAsText().setBold(false);
  body.appendParagraph('- Accountable: ');
  body.appendParagraph('- Consult: ');
  body.appendParagraph('- Inform: ');

  doc.saveAndClose();

  folder.addFile(DriveApp.getFileById(doc.getId()));

  return doc.getId();
}

/**
 * When there is a change to the calendar, searches for events that include "#agenda"
 * in the decrisption.
 *
 */
function onCalendarChange() {
  // Gets recent events with the #agenda tag
  const now = new Date();
  const events = CalendarApp.getEvents(
      now,
      new Date(now.getTime() + 2 * 60 * 60 * 1000000),
      {search: '#agenda'},
  );

  const folderId = checkFolder();
  const templateId = getTemplateId(folderId);

  const folder = DriveApp.getFolderById(folderId);

  // Loops through any events found
  for (i = 0; i < events.length; i++) {
    const event = events[i];

    // Confirms whether the event has the #agenda tag
    let description = event.getDescription();
    if (description.search('#agenda') == -1) continue;

    // Only works with events created by the owner of this calendar
    if (event.isOwnedByMe()) {
      // Creates a new document from the template for an agenda for this event
      const newDoc = DriveApp.getFileById(templateId).makeCopy();
      newDoc.setName('Agenda for ' + event.getTitle());

      const file = DriveApp.getFileById(newDoc.getId());
      folder.addFile(file);

      const doc = DocumentApp.openById(newDoc.getId());
      const body = doc.getBody();

      // Fills in the template with information about the attendees from the
      // calendar event
      const conf = body.findText('##Attendees##');
      if (conf) {
        const ref = conf.getStartOffset();

        for (let i in event.getGuestList()) {
          let guest = event.getGuestList()[i];

          body.insertParagraph(ref + 2, guest.getEmail());
        }
        body.replaceText('##Attendees##', 'Attendees');
      }

      // Replaces the tag with a link to the agenda document
      const agendaUrl = 'https://docs.google.com/document/d/' + newDoc.getId();
      description = description.replace(
          '#agenda',
          '<a href=' + agendaUrl + '>Agenda Doc</a>',
      );
      event.setDescription(description);

      // Invites attendees to the Google doc so they automatically receive access to the agenda
      newDoc.addEditor(newDoc.getOwner());

      for (let i in event.getGuestList()) {
        let guest = event.getGuestList()[i];

        newDoc.addEditor(guest.getEmail());
      }
    }
  }
  return;
}

/**
 * Creates an event-driven trigger that fires whenever there's a change to the calendar.
 */
function setUp() {
  let email = Session.getActiveUser().getEmail();
  ScriptApp.newTrigger("onCalendarChange").forUserCalendar(email).onEventUpdated().create();
}

שינויים

אפשר לערוך את המדגם כמה שרוצים. בהמשך מפורטים כמה שינויים אופציונליים שאפשר לבצע.

עדכון ההרשאות של המשתתפים במסמכי סדר היום

הסקריפט מעניק למשתתפים הרשאה לערוך את הקובץ. כדי להגביל את ההרשאות לצפייה בלבד, צריך להחליף את השיטה addEditor בשיטה addViewer בחלק הבא של הקוד:

     for (let i in event.getGuestList()) {
       let guest = event.getGuestList()[i];

       newDoc.addEditor(guest.getEmail());

עריכת התבנית של מסמך סדר היום

כדי לעדכן את התבנית של המסמך של סדר היום, פועלים לפי השלבים הבאים:

1. אחרי שיוצרים את סדר היום הראשון באירוע ביומן, פותחים את Google Drive.
2. פותחים את התיקייה יוצר סדר היום – אפליקציה.
3. פותחים את המסמך תבנית סדר יום## ועורכים את השינויים הרצויים.

תורמים

הדוגמה הזו נוצרה על ידי ג'רמי גלסנברג, יועץ ניהול מוצר ויועץ אסטרטגיה לפלטפורמה. אפשר לחפש את רמי ב-Twitter @jglassenברג.

הדוגמה הזו מנוהלת על ידי Google בעזרת מומחי המפתחים של Google.

השלבים הבאים

• טריגרים מבוססי-אירוע
• הסבר על שירות היומן