Wypełnianie kalendarza wakacyjnych zespołu

Poziom kodowania: początkujący
Czas trwania: 15 minut
Typ projektu: automatyzacja z wyzwalaczem czasowym

Cele

• Dowiedz się, co robi rozwiązanie.
• Dowiedz się, jakie usługi Google Apps Script są wykorzystywane w rozwiązaniu.
• Skonfiguruj skrypt.
• Uruchom skrypt.

Informacje o rozwiązaniu

Udostępniony kalendarz urlopów to świetne narzędzie do współpracy zespołu. Każdy może szybko sprawdzić, kto jest nieobecny w biurze. To rozwiązanie pozwala sprawdzić, kiedy współpracownicy są poza biurem, bez konieczności ręcznego wprowadzania danych.

Jak to działa

To rozwiązanie wypełnia wspólny kalendarz urlopów na podstawie indywidualnych kalendarzy każdej osoby w grupie Google. Gdy ktoś rezerwuje czas wolny, dodaje wydarzenie do swojego osobistego Kalendarza Google, używając słowa kluczowego, np. „Urlop” lub „Poza biurem”.

Co godzinę skrypt skanuje kalendarze członków grupy i synchronizuje odpowiednie wydarzenia z kalendarzem udostępnionym. Możesz zmienić częstotliwość skanowania przez skrypt nowych zdarzeń.

To rozwiązanie ma dostęp tylko do wydarzeń w Kalendarzu, które Twoi współpracownicy udostępnili Ci za pomocą ustawień prywatności.

Usługi Apps Script

To rozwiązanie korzysta z tych usług:

• Usługa Grup dyskusyjnych Google: określa członków grupy w Grupach dyskusyjnych Google.
• Usługa zaawansowana Kalendarz: zapewnia dostęp do interfejsu Google Calendar API i wyszukuje wydarzenia w kalendarzach członków grupy.

Wymagania wstępne

Aby użyć tego przykładu, musisz spełnić te wymagania wstępne:

• Konto Google (w przypadku kont Google Workspace może być wymagana zgoda administratora).
• przeglądarkę internetową z dostępem do internetu,

Konfigurowanie skryptu

Aby skonfigurować skrypt do wypełniania kalendarza urlopów zespołu, wykonaj te czynności:

Tworzenie kalendarza urlopów zespołu

1. Otwórz Kalendarz.
2. Utwórz nowy kalendarz o nazwie „Urlopy zespołu”.
3. W ustawieniach kalendarza w sekcji Integrowanie kalendarza skopiuj identyfikator kalendarza.

Tworzenie projektu Apps Script

1. Aby otworzyć projekt Apps Script Vacation Calendar, kliknij ten przycisk: Otwórz projekt
2. Kliknij Przegląd .
3. Na stronie przeglądu kliknij Utwórz kopię.
4. W skopiowanym projekcie Apps Script ustaw zmienną TEAM_CALENDAR_ID na identyfikator utworzonego wcześniej kalendarza.
5. Ustaw zmienną GROUP_EMAIL na adres e-mail grupy w Grupach dyskusyjnych Google, która zawiera członków Twojego zespołu.
6. Obok opcji Usługi kliknij Dodaj usługę.
7. Wybierz Google Calendar API i kliknij Dodaj.

Uruchamianie skryptu

1. W skopiowanym projekcie Apps Script w menu funkcji wybierz setup.
2. Kliknij Wykonaj.
3. Gdy pojawi się odpowiedni komunikat, autoryzuj skrypt. <<../_snippets/oauth.md>>
4. Po zakończeniu wróć do Kalendarza, aby sprawdzić, czy kalendarz urlopów zespołu jest wypełniony wydarzeniami.

Sprawdź kod

Aby sprawdzić kod Apps Script tego rozwiązania, kliknij Wyświetl kod źródłowy:

Pokaż kod źródłowy

Code.gs

solutions/automations/vacation-calendar/Code.js

Wyświetl w GitHubie

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

Reguły przekształcania

Możesz dowolnie edytować automatyzację kalendarza urlopów zespołu, aby dostosować ją do swoich potrzeb. Poniżej znajdziesz opcjonalną zmianę, która zmodyfikuje regułę.

Zmiana częstotliwości skanowania nowych wydarzeń przez skrypt

Aby zmienić częstotliwość uruchamiania skryptu:

1. W projekcie Apps Script kliknij Triggery .
2. Obok wyzwalacza kliknij Edytuj wyzwalacz.
3. Wybierz zmiany i kliknij Zapisz.

Współtwórcy

Ten przykład jest obsługiwany przez Google przy pomocy ekspertów Google Developers.

Dalsze kroki

• Wyzwalacze oparte na czasie
• Wydarzenia w Kalendarzu