إنشاء جدول أعمال للاجتماعات

مستوى الترميز: مبتدئ
المدة: 15 دقيقة
نوع المشروع: برمجة باستخدام عامل تشغيل مستند إلى حدث

الأهداف

• فهم دور الحلّ
• فهم ما تفعله خدمات Apps Script ضمن الحلّ
• إعداد النص البرمجي
• شغِّل النص البرمجي.

لمحة عن هذا الحل

إنشاء مستندات جداول الأعمال تلقائيًا في "مستندات Google" وإرفاقها بجلساتك في "تقويم Google"

آلية العمل

ينشئ البرنامج النصي نموذج مستند لجدول أعمال. عند تعديل تقويمك، يتحقّق النص البرمجي ممّا إذا كانت أيّ من الأحداث التي تملكها تتضمّن "‎#agenda" في الوصف. إذا كانت العلامة متوفّرة، يُنشئ النص البرمجي نسخة من النموذج ويُعدِّلها ويُضيفها إلى حدث التقويم ويشاركها مع ضيوف الحدث.

خدمات "برمجة تطبيقات Google"

يستخدم هذا الحلّ الخدمات التالية:

• خدمة Drive: للتحقّق مما إذا كان ملف ملف التنسيق المستند متوفّرًا، وفي حال عدم توفّره، يتم إنشاء مجلد جديد لملف التنسيق المستند. تُنشئ هذه الإعدادات نسخة من مستند النموذج لكل جدول أعمال جديد.
• خدمة المستندات: لإنشاء نموذج جدول الأعمال
• خدمة التقويم: تبحث عن الأحداث التي تحتوي على العلامة "‎#agenda" وتُعدّل وصف الحدث من خلال إضافة رابط إلى مستند جدول الأعمال.
• الخدمة الأساسية: تستخدِم فئة Session للحصول على عنوان البريد الإلكتروني للمستخدم. يساعد ذلك في إنشاء عامل التفعيل للمستخدم الحالي.
• خدمة النصوص البرمجية: لإنشاء عامل تشغيل يتم تفعيله عند حدوث تغيير في تقويم المستخدم.

المتطلبات الأساسية

لاستخدام هذا العيّنة، يجب استيفاء المتطلبات الأساسية التالية:

• حساب Google (قد تحتاج حسابات Google Workspace إلى موافقة المشرف).
• متصفح ويب يمكنه الوصول إلى الإنترنت

إعداد النص البرمجي

1. انقر على الزر أدناه لفتح نموذج مشروع إنشاء جدول أعمال للاجتماعات Apps Script.
   فتح المشروع
2. انقر على نظرة عامة .
3. في صفحة النظرة العامة، انقر على رمز إنشاء نسخة .
4. في المشروع المنسوخ، اختَر setUp من القائمة المنسدلة للدالة.
5. انقر على تشغيل.
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. افتح المجلد Agenda Maker - App (تطبيق "صانع المخططات الزمنية").
3. افتح مستند Agenda TEMPLATE## وأدخِل تعديلاتك.

المساهمون

تم إنشاء هذا العيّنة من قِبل جيريمي غلاسنبرغ، استشاري إدارة المنتجات والمنصات الاستراتيجية. يمكنك التواصل مع جيريمي على Twitter على ‎@jglassenberg.

تُعدّ Google هذه العينة بمساعدة خبراء Google Developers.

الخطوات التالية

• العوامل المشغّلة المستندة إلى الأحداث
• مرجع خدمة "تقويم Google"