Заполнение календаря командных отпусков

Уровень владения программированием : начинающий
Продолжительность : 15 мин.
Тип проекта : Автоматизация с использованием триггера, срабатывающего по времени.

Цели

• Поймите, для чего предназначено это решение.
• Разберитесь, что делают сервисы Google Apps Script в рамках данного решения.
• Настройте скрипт.
• Запустите скрипт.

Об этом решении

Общий календарь отпусков — отличный инструмент для эффективной командной работы; любой сотрудник может с первого взгляда определить, кто отсутствует на рабочем месте. Это решение позволяет видеть, когда ваши коллеги отсутствуют, без необходимости ручного ввода информации.

Как это работает

Это решение формирует общий календарь отпусков на основе индивидуальных календарей каждого пользователя в группе Google. Когда кто-то бронирует отпуск, он добавляет событие в свой личный календарь Google, используя ключевое слово, например, «Отпуск» или «Вне офиса».

Каждый час скрипт сканирует календари участников группы и синхронизирует соответствующие события с общим календарем. Вы можете изменить частоту сканирования новых событий скриптом .

Это решение получает доступ только к тем событиям календаря, которые ваши коллеги сделали видимыми для вас, используя свои настройки конфиденциальности.

Сервисы Apps Script

Данное решение использует следующие сервисы:

• Сервис Google Groups : определяет участников группы Google Groups.
• Расширенная функция календаря : предоставляет доступ к API Google Календаря и осуществляет поиск событий в календарях участников группы.

Предварительные требования

Для использования этого примера необходимы следующие условия:

• Для работы потребуется учетная запись Google (для учетных записей Google Workspace может потребоваться подтверждение администратора).
• Веб-браузер с доступом в интернет.

Настройте скрипт

Чтобы настроить скрипт для заполнения календаря отпусков команды, выполните следующие шаги:

Создайте календарь отпусков для команды.

1. Открыть календарь .
2. Создайте новый календарь под названием «Отпуск команды».
3. В настройках календаря, в разделе «Интеграция календаря» , скопируйте идентификатор календаря .

Создайте проект Apps Script.

1. Чтобы открыть проект Vacation Calendar Apps Script, нажмите следующую кнопку: Открыть проект
2. Нажмите «Обзор .
3. На странице обзора нажмите «Создать копию». .
4. В скопированном проекте Apps Script установите переменную TEAM_CALENDAR_ID равным идентификатору календаря, созданного вами ранее.
5. Установите переменную GROUP_EMAIL в значение адреса электронной почты группы Google Groups, в которую входят члены вашей команды.
6. Рядом с пунктом «Услуги» нажмите « услугу».
7. Выберите Google Calendar API и нажмите «Добавить» .

Запустите скрипт

1. В скопированном проекте Apps Script в раскрывающемся списке функций выберите «Настройка» .
2. Нажмите «Выполнить» .
3. При появлении запроса авторизуйте скрипт. <<../_snippets/oauth.md>>
4. После завершения вернитесь в Календарь, чтобы убедиться, что календарь «Отпуск команды» заполнен событиями.

Просмотрите код

Чтобы просмотреть код Apps Script для этого решения, нажмите «Просмотреть исходный код» :

Просмотреть исходный код

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

Модификации

Вы можете редактировать автоматизацию календаря отпусков команды по своему усмотрению в соответствии со своими потребностями. Ниже приведено необязательное изменение для настройки триггера.

Измените частоту сканирования скриптом новых событий.

Чтобы изменить частоту выполнения скрипта, выполните следующие действия:

1. В проекте Apps Script нажмите «Запускает .
2. Рядом с триггером нажмите « триггер».
3. Выберите изменения и нажмите «Сохранить» .

Авторы

Данный пример поддерживается компанией Google при содействии экспертов-разработчиков Google.

Следующие шаги

• Триггеры, срабатывающие по времени
• События календаря