Mengisi kalender liburan tim

Tingkat coding: Pemula
Durasi: 15 menit
Jenis project: Otomatisasi dengan pemicu berbasis waktu

Tujuan

• Pahami fungsi solusi.
• Pahami fungsi layanan Google Apps Script dalam solusi.
• Siapkan skrip.
• Jalankan skrip.

Tentang solusi ini

Kalender liburan bersama adalah alat yang efektif untuk membantu tim Anda berkolaborasi; siapa pun dapat menentukan siapa yang tidak berada di kantor secara sekilas. Solusi ini memungkinkan Anda melihat kapan rekan kerja Anda tidak berada di kantor, tanpa perlu memasukkan data secara manual.

Cara kerjanya

Solusi ini mengisi kalender liburan bersama berdasarkan kalender masing-masing orang dalam grup Google. Saat seseorang memesan waktu istirahat, dia akan menambahkan acara ke Google Kalender pribadinya menggunakan kata kunci seperti "Liburan" atau "Tidak ada di kantor".

Setiap jam, skrip memindai kalender anggota dalam grup dan menyinkronkan acara yang sesuai ke kalender bersama. Anda dapat mengubah seberapa sering skrip memindai acara baru.

Solusi ini hanya mengakses acara Kalender yang telah dibuat terlihat oleh rekan kerja Anda menggunakan setelan privasi mereka.

Layanan Apps Script

Solusi ini menggunakan layanan berikut:

• Layanan Google Grup: Menentukan anggota grup Google Grup.
• Layanan lanjutan kalender: Memberikan akses ke Google Calendar API dan menelusuri acara di kalender anggota grup.

Prasyarat

Untuk menggunakan sampel ini, Anda memerlukan prasyarat berikut:

• Akun Google (akun Google Workspace mungkin memerlukan persetujuan administrator).
• Browser web dengan akses ke internet.

Menyiapkan skrip

Untuk menyiapkan skrip guna mengisi kalender cuti tim, selesaikan langkah-langkah berikut:

Membuat kalender liburan tim

1. Buka Kalender.
2. Buat kalender baru bernama "Cuti Tim".
3. Di setelan kalender, di bagian Integrasikan kalender, salin ID Kalender.

Buat project Apps Script

1. Untuk membuka project Apps Script Vacation Calendar, klik tombol berikut: Buka project
2. Klik Ringkasan .
3. Di halaman ringkasan, klik Buat salinan .
4. Di project Apps Script yang Anda salin, tetapkan variabel TEAM_CALENDAR_ID ke ID kalender yang Anda buat sebelumnya.
5. Tetapkan variabel GROUP_EMAIL ke alamat email grup Google Grup yang berisi anggota tim Anda.
6. Di samping Layanan, klik Tambahkan layanan .
7. Pilih Google Calendar API, lalu klik Tambahkan.

Jalankan skrip:

1. Di project Apps Script yang Anda salin, di drop-down fungsi, pilih setup.
2. Klik Run.
3. Saat diminta, izinkan skrip. <<../_snippets/oauth.md>>
4. Setelah selesai, kembali ke Kalender untuk mengonfirmasi bahwa kalender Cuti Tim sudah diisi dengan acara.

Meninjau kode

Untuk meninjau kode Apps Script untuk solusi ini, klik Lihat kode sumber:

Melihat kode sumber

Code.gs

solutions/automations/vacation-calendar/Code.js

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

Modifikasi

Anda dapat mengedit otomatisasi kalender liburan tim sesering yang Anda inginkan agar sesuai dengan kebutuhan Anda. Berikut adalah perubahan opsional untuk mengubah pemicu.

Mengubah seberapa sering skrip memindai acara baru

Untuk mengubah seberapa sering skrip berjalan, lakukan langkah-langkah berikut:

1. Di project Apps Script, klik Triggers .
2. Di samping pemicu, klik Edit Pemicu .
3. Pilih perubahan Anda, lalu klik Simpan.

Kontributor

Contoh ini dikelola oleh Google dengan bantuan Pakar Developer Google.

Langkah berikutnya

• Pemicu berbasis waktu
• Acara kalender