टीम के साथ छुट्टियों के कैलेंडर को पॉप्युलेट करना

कोडिंग लेवल: शुरुआती
अवधि: 15 मिनट
प्रोजेक्ट टाइप: समय के हिसाब से ट्रिगर वाला ऑटोमेशन

मकसद

• यह समझना कि समाधान क्या करता है.
• जानें कि समाधान में Apps Script की सेवाएं क्या करती हैं.
• स्क्रिप्ट सेट अप करें.
• स्क्रिप्ट चलाएं.

इस समाधान के बारे में जानकारी

छुट्टियों का शेयर किया गया कैलेंडर, टीम के साथ मिलकर काम करने में मदद करने वाला एक बेहतरीन टूल है. इससे कोई भी एक नज़र में यह पता लगा सकता है कि कौन छुट्टी पर है. इस सुविधा की मदद से, यह देखा जा सकता है कि आपके सहकर्मी ऑफ़िस में मौजूद हैं या नहीं. इसके लिए, आपको मैन्युअल तरीके से जानकारी डालने की ज़रूरत नहीं है.

यह कैसे काम करता है

यह समाधान, Google ग्रुप में मौजूद हर व्यक्ति के अलग-अलग कैलेंडर के आधार पर, छुट्टियों का शेयर किया गया कैलेंडर बनाता है. जब कोई व्यक्ति छुट्टी बुक करता है, तो वह अपने निजी Google Calendar में "छुट्टी" या "ऑफ़िस से बाहर है" जैसे कीवर्ड का इस्तेमाल करके कोई इवेंट जोड़ता है.

यह स्क्रिप्ट हर घंटे, ग्रुप के सदस्यों के कैलेंडर को स्कैन करती है और ज़रूरी इवेंट को शेयर किए गए कैलेंडर में सिंक करती है. आपके पास स्क्रिप्ट को नए इवेंट के लिए स्कैन करने की फ़्रीक्वेंसी बदलने का विकल्प है.

यह सुविधा सिर्फ़ उन Calendar इवेंट को ऐक्सेस करती है जिन्हें आपके सहकर्मियों ने अपनी निजता सेटिंग की मदद से, आपको दिखाने के लिए सेट किया है.

Apps Script की सेवाएं

यह समाधान इन सेवाओं का इस्तेमाल करता है:

• ग्रुप सेवा–इससे Google ग्रुप के सदस्यों की जानकारी मिलती है.
• Calendar की बेहतर सेवा–इससे Google Calendar API का ऐक्सेस मिलता है. साथ ही, यह ग्रुप के सदस्यों के कैलेंडर पर इवेंट खोजता है.

ज़रूरी शर्तें

इस सैंपल का इस्तेमाल करने के लिए, आपको ये ज़रूरी शर्तें पूरी करनी होंगी:

• Google खाता (Google Workspace खातों के लिए, एडमिन की अनुमति की ज़रूरत पड़ सकती है).
• इंटरनेट का ऐक्सेस वाला वेब ब्राउज़र.

स्क्रिप्ट सेट अप करना

टीम की छुट्टियों का कैलेंडर बनाना

1. Google Calendar खोलें.
2. "टीम के लिए छुट्टियां" नाम का नया कैलेंडर बनाएं.
3. कैलेंडर की सेटिंग में, कैलेंडर जोड़ें में जाकर, कैलेंडर आईडी कॉपी करें.

Apps Script प्रोजेक्ट बनाना

1. छुट्टियों का कैलेंडर ऐप्लिकेशन स्क्रिप्ट प्रोजेक्ट खोलने के लिए, इस बटन पर क्लिक करें.
   प्रोजेक्ट खोलना
2. खास जानकारी पर क्लिक करें.
3. खास जानकारी वाले पेज पर, कॉपी बनाएं पर क्लिक करें.
4. कॉपी किए गए Apps Script प्रोजेक्ट में, वैरिएबल TEAM_CALENDAR_ID को उस कैलेंडर के आईडी पर सेट करें जिसे आपने पहले बनाया था.
5. वैरिएबल GROUP_EMAIL को उस Google ग्रुप के ईमेल पते पर सेट करें जिसमें आपकी टीम के सदस्य शामिल हैं.
6. सेवाएं के बगल में, सेवा जोड़ें पर क्लिक करें.
7. Google Calendar API चुनें और जोड़ें पर क्लिक करें.

स्क्रिप्ट चलाना

1. कॉपी किए गए Apps Script प्रोजेक्ट में, फ़ंक्शन ड्रॉपडाउन में, सेटअप चुनें.
2. चलाएं पर क्लिक करें.

3. जब आपसे कहा जाए, तब स्क्रिप्ट को अनुमति दें. अगर OAuth की सहमति वाली स्क्रीन पर चेतावनी दिखती है, इस ऐप्लिकेशन की पुष्टि नहीं की गई है, तो बेहतर > {Project Name} पर जाएं (असुरक्षित) को चुनकर जारी रखें.

4. यह काम पूरा होने के बाद, Calendar पर वापस जाएं और पुष्टि करें कि Team Vacations कैलेंडर में इवेंट अपने-आप जुड़ गए हैं.

कोड की समीक्षा करना

इस समाधान के लिए 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.
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;
}

बदलाव

अपनी ज़रूरतों के हिसाब से, टीम के छुट्टियों के कैलेंडर के ऑटोमेशन में जितने चाहें उतने बदलाव किए जा सकते हैं. ट्रिगर में बदलाव करने के लिए, यहां दिया गया विकल्प इस्तेमाल किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.

यह बदलना कि स्क्रिप्ट कितनी बार नए इवेंट स्कैन करती है

स्क्रिप्ट के चलने की फ़्रीक्वेंसी बदलने के लिए, यह तरीका अपनाएं:

1. Apps Script प्रोजेक्ट में, ट्रिगर पर क्लिक करें.
2. ट्रिगर के बगल में, ट्रिगर में बदलाव करें पर क्लिक करें.
3. बदलावों को चुनें और सेव करें पर क्लिक करें.

योगदानकर्ता

इस सैंपल को Google, Google Developer Experts की मदद से मैनेज करता है.

अगले चरण

• समय के हिसाब से ट्रिगर
• Google Calendar इवेंट