Team-Urlaubskalender ausfüllen

Codierungslevel: Anfänger
Dauer: 15 Minuten
Projekttyp: Automatisierung mit einem zeitgesteuerten Trigger

Lernziele

• Informieren Sie sich über die Funktionsweise der Lösung.
• Informationen zu den Aufgaben der Apps Script-Dienste in der Lösung
• Richten Sie das Script ein.
• Führen Sie das Skript aus.

Informationen zu dieser Lösung

Ein gemeinsam genutzter Urlaubskalender ist ein hervorragendes Tool für die Zusammenarbeit im Team. So kann jeder auf einen Blick sehen, wer nicht im Büro ist. So sehen Sie, wann Ihre Kollegen nicht im Büro sind, ohne dass Sie manuelle Einträge vornehmen müssen.

Funktionsweise

Mit dieser Lösung wird ein gemeinsam genutzter Urlaubskalender basierend auf den individuellen Kalendern der einzelnen Personen in einer Google-Gruppe erstellt. Wenn jemand Urlaub bucht, fügt er seinem privaten Google-Kalender einen Termin mit einem Keyword wie „Urlaub“ oder „Abwesend“ hinzu.

Jede Stunde scannt das Script die Kalender der Mitglieder in der Gruppe und synchronisiert die entsprechenden Termine mit dem freigegebenen Kalender. Sie können festlegen, wie oft das Script nach neuen Ereignissen sucht.

Bei dieser Lösung wird nur auf Kalendertermine zugegriffen, die Ihre Kollegen über ihre Datenschutzeinstellungen für Sie sichtbar gemacht haben.

Apps Script-Dienste

Für diese Lösung werden die folgenden Dienste verwendet:

• Groups-Dienst: Bestimmt die Mitglieder der Google-Gruppe.
• Erweiterter Kalenderdienst: Ermöglicht den Zugriff auf die Google Calendar API und sucht nach Terminen in den Kalendern der Gruppenmitglieder.

Vorbereitung

Für die Verwendung dieses Beispiels sind die folgenden Voraussetzungen erforderlich:

• Ein Google-Konto (für Google Workspace-Konten ist möglicherweise die Administratorzustimmung erforderlich).
• Einen Webbrowser mit Internetzugriff.

Script einrichten

Teamurlaubskalender erstellen

1. Öffnen Sie Google Kalender.
2. Erstellen Sie einen neuen Kalender mit dem Namen „Teamurlaube“.
3. Kopieren Sie in den Einstellungen des Kalenders unter Kalender integrieren die Kalender-ID.

Apps Script-Projekt erstellen

1. Klicken Sie auf die folgende Schaltfläche, um das Apps Script-Projekt Urlaubskalender zu öffnen.
   Projekt öffnen
2. Klicken Sie auf Übersicht .
3. Klicken Sie auf der Übersichtsseite auf „Kopie erstellen“ .
4. Legen Sie in Ihrem kopierten Apps Script-Projekt die Variable TEAM_CALENDAR_ID auf die ID des zuvor erstellten Kalenders fest.
5. Legen Sie für die Variable GROUP_EMAIL die E-Mail-Adresse einer Google-Gruppe fest, die Ihre Teammitglieder enthält.
6. Klicken Sie neben Dienste auf „Dienst hinzufügen“ .
7. Wählen Sie Google Calendar API aus und klicken Sie auf Hinzufügen.

Skript ausführen

1. Wählen Sie in Ihrem kopierten Apps Script-Projekt im Drop-down-Menü für Funktionen setup aus.
2. Klicken Sie auf Ausführen.

3. Autorisieren Sie das Script, wenn Sie dazu aufgefordert werden. Wenn auf dem OAuth-Zustimmungsbildschirm die Warnung Diese App ist nicht bestätigt angezeigt wird, wählen Sie Erweitert > Zu {Project Name} (unsicher) aus.

4. Wenn Sie fertig sind, kehren Sie zu Google Kalender zurück, um zu prüfen, ob der Kalender „Urlaub des Teams“ mit Terminen gefüllt ist.

Code ansehen

Wenn Sie den Apps Script-Code für diese Lösung ansehen möchten, klicken Sie unten auf Quellcode ansehen:

Quellcode ansehen

Code.gs

solutions/automations/vacation-calendar/Code.js

Auf GitHub ansehen

// 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.
let 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'];
let GROUP_EMAIL = 'ENTER_GOOGLE_GROUP_EMAIL_HERE';

let ONLY_DIRECT_MEMBERS = false;

let KEYWORDS = ['vacation', 'ooo', 'out of office', 'offline'];
let MONTHS_IN_ADVANCE = 3;

/**
 * Sets up the script to run automatically every hour.
 */
function setup() {
  let 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.
  let today = new Date();
  let 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;
  users.forEach(function(user) {
    let username = user.getEmail().split('@')[0];
    KEYWORDS.forEach(function(keyword) {
      let events = findEvents(user, keyword, today, maxDate, lastRun);
      events.forEach(function(event) {
        importEvent(username, event);
        count++;
      }); // End foreach event.
    }); // End foreach keyword.
  }); // End foreach user.

  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';
    delete event.outOfOfficeProperties;
    delete event.focusTimeProperties;
  }

  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, keyword, start, end, optSince) {
  let params = {
    q: keyword,
    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.filter(function(item) {
      return shouldImportEvent(user, keyword, item);
    }));
    pageToken = response.nextPageToken;
  } while (pageToken);
  return events;
}

/**
 * Determines if the given event should be imported into the shared team
 * calendar.
 * @param {Session.User} user The user that is attending the event.
 * @param {string} keyword The keyword being searched for.
 * @param {Calendar.Event} event The event being considered.
 * @return {boolean} True if the event should be imported.
 */
function shouldImportEvent(user, keyword, event) {
  // Filters out events where the keyword did not appear in the summary
  // (that is, the keyword appeared in a different field, and are thus
  // is not likely to be relevant).
  if (event.summary.toLowerCase().indexOf(keyword) < 0) {
    return false;
  }
  if (!event.organizer || event.organizer.email == user.getEmail()) {
    // If the user is the creator of the event, always imports it.
    return true;
  }
  // Only imports events the user has accepted.
  if (!event.attendees) return false;
  let matching = event.attendees.filter(function(attendee) {
    return attendee.self;
  });
  return matching.length > 0 && matching[0].responseStatus == 'accepted';
}

/**
 * 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) {
  var group = GroupsApp.getGroupByEmail(groupEmail);
  var users = group.getUsers();
  var childGroups = group.getGroups();
  for (var i = 0; i < childGroups.length; i++) {
    var childGroup = childGroups[i];
    users = users.concat(getAllMembers(childGroup.getEmail()));
  }
  // Remove duplicate members
  var uniqueUsers = [];
  var userEmails = {};
  for (var i = 0; i < users.length; i++) {
    var 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) {
  let users = [];
  for (let groupEmail of groupEmails) {
    let groupUsers = GroupsApp.getGroupByEmail(groupEmail).getUsers();
    for (let user of groupUsers) {
      if (!users.some(u => u.getEmail() === user.getEmail())) {
        users.push(user);
      }
    }
  }
  return users;
}

Änderungen

Sie können die Automatisierung des Urlaubskalenders für Ihr Team nach Bedarf bearbeiten. Unten finden Sie eine optionale Änderung, mit der Sie den Trigger anpassen können.

Häufigkeit ändern, mit der das Script nach neuen Ereignissen sucht

So ändern Sie die Häufigkeit der Ausführung des Scripts:

1. Klicken Sie im Apps Script-Projekt auf Trigger .
2. Klicken Sie neben dem Trigger auf „Trigger bearbeiten“ .
3. Wählen Sie Ihre Änderungen aus und klicken Sie auf Speichern.

Beitragende

Dieses Beispiel wird von Google mithilfe von Google Developer Experts verwaltet.

Nächste Schritte

• Zeitbasierte Trigger
• Google Kalender-Termine