تعبئة تقويم عطلة الفريق

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

الأهداف

فهم وظيفة الحل
فهم وظيفة خدمات "برمجة تطبيقات Google" ضمن الحل
إعداد النص البرمجي
تشغيل النص البرمجي

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

يُعدّ تقويم الإجازات المشترك أداة رائعة لمساعدة فريقك على التعاون، إذ يمكن لأي مستخدم تحديد من هو خارج المكتب بنظرة سريعة. يتيح لك هذا الحل الاطّلاع على أوقات غياب زملائك عن المكتب، بدون الحاجة إلى إدخال البيانات يدويًا.

مثال على تقويم عطلات الفريق الذي يتضمّن أحداث "خارج المكتب"

آلية العمل

يملأ هذا الحل تقويم إجازات مشتركًا استنادًا إلى التقاويم الفردية لكل مستخدم في مجموعة Google. عندما يحجز أحد المستخدمين وقتًا للإجازة، يضيف حدثًا إلى "تقويم Google" الشخصي باستخدام كلمة رئيسية مثل "إجازة" أو "خارج المكتب".

يفحص النص البرمجي تقاويم أعضاء المجموعة كل ساعة ويُزامِن الأحداث المناسبة مع التقويم المشترك. يمكنك تغيير عدد مرات فحص النص البرمجي للأحداث الجديدة.

لا يمكن لهذا الحل الوصول إلا إلى أحداث "تقويم Google" التي أتاحها لك زملاؤك باستخدام إعدادات الخصوصية.

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

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

خدمة "مجموعات Google": تحدّد أعضاء مجموعة "مجموعات Google".
الخدمة المتقدّمة في "تقويم Google": تتيح الوصول إلى Google Calendar API والبحث عن الأحداث في تقاويم أعضاء المجموعة.

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

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

حساب Google (قد تتطلب حسابات Google Workspace موافقة المشرف)
متصفّح ويب يتيح الوصول إلى الإنترنت

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

لإعداد النص البرمجي لملء تقويم إجازات الفريق، يُرجى اتّباع الخطوات التالية:

إنشاء تقويم إجازات الفريق

افتح تقويم Google.
أنشئ تقويمًا جديدًا باسم "إجازات الفريق".
في إعدادات التقويم، ضمن دمج التقويم، انسَخ رقم تعريف التقويم.

إنشاء مشروع "برمجة تطبيقات Google"

لفتح مشروع "برمجة تطبيقات Google" تقويم الإجازات، انقر على الزر التالي: فتح المشروع
انقر على نظرة عامة .
في صفحة النظرة العامة، انقر على إنشاء نسخة .
في مشروع "برمجة تطبيقات Google" الذي نسخته، اضبط المتغيّر TEAM_CALENDAR_ID على رقم تعريف التقويم الذي أنشأته سابقًا.
اضبط المتغيّر GROUP_EMAIL على عنوان البريد الإلكتروني لمجموعة "مجموعات Google" التي تضم أعضاء فريقك.
بجانب الخدمات، انقر على إضافة خدمة .
اختَر Google Calendar API وانقر على إضافة.

تشغيل النص البرمجي

في مشروع "برمجة تطبيقات Google" الذي نسخته، اختَر الإعداد من القائمة المنسدلة للدالة.
انقر على تشغيل.
امنح الإذن للنص البرمجي عندما يُطلب منك ذلك. <<../_snippets/oauth.md>>
عند اكتمال العملية، ارجع إلى "تقويم Google" للتأكّد من ملء تقويم "إجازات الفريق" بالأحداث.

مراجعة الرمز البرمجي

لمراجعة رمز "برمجة تطبيقات Google" لهذا الحل، انقر على عرض رمز المصدر:

عرض رمز المصدر

Code.gs

solutions/automations/vacation-calendar/Code.js

عرض على GitHub

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

/*
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.
*/

// Set the ID of the team calendar to add events to. You can find the calendar's
// ID on the settings page.
const TEAM_CALENDAR_ID = "ENTER_TEAM_CALENDAR_ID_HERE";
// Set the email address of the Google Group that contains everyone in the team.
// Ensure the group has less than 500 members to avoid timeouts.
// Change to an array in order to add indirect members frrm multiple groups, for example:
// let GROUP_EMAIL = ['ENTER_GOOGLE_GROUP_EMAIL_HERE', 'ENTER_ANOTHER_GOOGLE_GROUP_EMAIL_HERE'];
const GROUP_EMAIL = "ENTER_GOOGLE_GROUP_EMAIL_HERE";

const ONLY_DIRECT_MEMBERS = false;

const KEYWORDS = ["vacation", "ooo", "out of office", "offline"];
const MONTHS_IN_ADVANCE = 3;

/**
 * Sets up the script to run automatically every hour.
 */
function setup() {
  const triggers = ScriptApp.getProjectTriggers();
  if (triggers.length > 0) {
    throw new Error("Triggers are already setup.");
  }
  ScriptApp.newTrigger("sync").timeBased().everyHours(1).create();
  // Runs the first sync immediately.
  sync();
}

/**
 * Looks through the group members' public calendars and adds any
 * 'vacation' or 'out of office' events to the team calendar.
 */
function sync() {
  // Defines the calendar event date range to search.
  const today = new Date();
  const maxDate = new Date();
  maxDate.setMonth(maxDate.getMonth() + MONTHS_IN_ADVANCE);

  // Determines the time the the script was last run.
  let lastRun = PropertiesService.getScriptProperties().getProperty("lastRun");
  lastRun = lastRun ? new Date(lastRun) : null;

  // Gets the list of users in the Google Group.
  let users = getAllMembers(GROUP_EMAIL);
  if (ONLY_DIRECT_MEMBERS) {
    users = GroupsApp.getGroupByEmail(GROUP_EMAIL).getUsers();
  } else if (Array.isArray(GROUP_EMAIL)) {
    users = getUsersFromGroups(GROUP_EMAIL);
  }

  // For each user, finds events having one or more of the keywords in the event
  // summary in the specified date range. Imports each of those to the team
  // calendar.
  let count = 0;
  for (const user of users) {
    const username = user.getEmail().split("@")[0];
    const events = findEvents(user, today, maxDate, lastRun);
    for (const event of events) {
      importEvent(username, event);
      count++;
    }
  }

  PropertiesService.getScriptProperties().setProperty("lastRun", today);
  console.log(`Imported ${count} events`);
}

/**
 * Imports the given event from the user's calendar into the shared team
 * calendar.
 * @param {string} username The team member that is attending the event.
 * @param {Calendar.Event} event The event to import.
 */
function importEvent(username, event) {
  event.summary = `[${username}] ${event.summary}`;
  event.organizer = {
    id: TEAM_CALENDAR_ID,
  };
  event.attendees = [];

  // If the event is not of type 'default', it can't be imported, so it needs
  // to be changed.
  if (event.eventType !== "default") {
    event.eventType = "default";
    event.outOfOfficeProperties = undefined;
    event.focusTimeProperties = undefined;
  }

  console.log("Importing: %s", event.summary);
  try {
    Calendar.Events.import(event, TEAM_CALENDAR_ID);
  } catch (e) {
    console.error(
      "Error attempting to import event: %s. Skipping.",
      e.toString(),
    );
  }
}

/**
 * In a given user's calendar, looks for occurrences of the given keyword
 * in events within the specified date range and returns any such events
 * found.
 * @param {Session.User} user The user to retrieve events for.
 * @param {string} keyword The keyword to look for.
 * @param {Date} start The starting date of the range to examine.
 * @param {Date} end The ending date of the range to examine.
 * @param {Date} optSince A date indicating the last time this script was run.
 * @return {Calendar.Event[]} An array of calendar events.
 */
function findEvents(user, start, end, optSince) {
  const params = {
    eventTypes: "outOfOffice",
    timeMin: formatDateAsRFC3339(start),
    timeMax: formatDateAsRFC3339(end),
    showDeleted: true,
  };
  if (optSince) {
    // This prevents the script from examining events that have not been
    // modified since the specified date (that is, the last time the
    // script was run).
    params.updatedMin = formatDateAsRFC3339(optSince);
  }
  let pageToken = null;
  let events = [];
  do {
    params.pageToken = pageToken;
    let response;
    try {
      response = Calendar.Events.list(user.getEmail(), params);
    } catch (e) {
      console.error(
        "Error retriving events for %s, %s: %s; skipping",
        user,
        keyword,
        e.toString(),
      );
      continue;
    }
    events = events.concat(response.items);
    pageToken = response.nextPageToken;
  } while (pageToken);
  return events;
}

/**
 * Returns an RFC3339 formated date String corresponding to the given
 * Date object.
 * @param {Date} date a Date.
 * @return {string} a formatted date string.
 */
function formatDateAsRFC3339(date) {
  return Utilities.formatDate(date, "UTC", "yyyy-MM-dd'T'HH:mm:ssZ");
}

/**
 * Get both direct and indirect members (and delete duplicates).
 * @param {string} the e-mail address of the group.
 * @return {object} direct and indirect members.
 */
function getAllMembers(groupEmail) {
  const group = GroupsApp.getGroupByEmail(groupEmail);
  let users = group.getUsers();
  const childGroups = group.getGroups();
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    users = users.concat(getAllMembers(childGroup.getEmail()));
  }
  // Remove duplicate members
  const uniqueUsers = [];
  const userEmails = {};
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    if (!userEmails[user.getEmail()]) {
      uniqueUsers.push(user);
      userEmails[user.getEmail()] = true;
    }
  }
  return uniqueUsers;
}

/**
 * Get indirect members from multiple groups (and delete duplicates).
 * @param {array} the e-mail addresses of multiple groups.
 * @return {object} indirect members of multiple groups.
 */
function getUsersFromGroups(groupEmails) {
  const users = [];
  for (const groupEmail of groupEmails) {
    const groupUsers = GroupsApp.getGroupByEmail(groupEmail).getUsers();
    for (const user of groupUsers) {
      if (!users.some((u) => u.getEmail() === user.getEmail())) {
        users.push(user);
      }
    }
  }
  return users;
}

التعديلات

يمكنك تعديل عملية الأتمتة لتقويم إجازات الفريق بالقدر الذي يناسب احتياجاتك. في ما يلي تغيير اختياري لتعديل المشغّل.

تغيير عدد مرات فحص النص البرمجي للأحداث الجديدة

لتغيير عدد مرات تشغيل النص البرمجي، اتّبِع الخطوات التالية:

في مشروع "برمجة تطبيقات Google"، انقر على المشغّلات .
بجانب المشغّل، انقر على تعديل المشغّل .
اختَر التغييرات التي تريدها وانقر على حفظ.

المساهمون

تحتفظ Google بهذا النموذج بمساعدة خبراء التطوير في Google.

تعبئة تقويم عطلة الفريق تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.