बेहतर Calendar सेवा

बेहतर Calendar सेवा की मदद से, Apps Script में सार्वजनिक Google Calendar API का इस्तेमाल किया जा सकता है. Apps Script के पहले से मौजूद Calendar सेवा की तरह ही, इस एपीआई में स्क्रिप्ट और उपयोगकर्ता के Google Calendar को ऐक्सेस करने के साथ-साथ उनमें बदलाव भी किया जा सकता है. इसमें वे अतिरिक्त कैलेंडर भी शामिल हैं जिनकी उपयोगकर्ता ने सदस्यता ली है. ज़्यादातर मामलों में, पहले से मौजूद सेवा का इस्तेमाल करना आसान होता है, लेकिन यह बेहतर सेवा कुछ और सुविधाएं भी देती है. इसमें, हर इवेंट के लिए बैकग्राउंड का रंग सेट करना शामिल है.

रेफ़रंस

इस सेवा के बारे में ज़्यादा जानने के लिए, सार्वजनिक Google Calendar API से जुड़े पहचान वाले दस्तावेज़ देखें. Apps Script की सभी बेहतर सेवाओं की तरह, Calendar की बेहतर सेवा में भी वही ऑब्जेक्ट, तरीके, और पैरामीटर इस्तेमाल किए जाते हैं जिनका इस्तेमाल सार्वजनिक एपीआई में किया जाता है. ज़्यादा जानकारी के लिए, हस्ताक्षर कैसे तय किए जाते हैं देखें.

समस्याओं की शिकायत करने और दूसरी सहायता पाने के लिए, Calendar की सहायता गाइड देखें.

एचटीटीपी अनुरोध के हेडर

Calendar की बेहतर सेवा, एचटीटीपी अनुरोध के हेडर If-Match और If-None-Match को स्वीकार कर सकती है. ज़्यादा जानकारी के लिए, पहचान के लिए ज़रूरी दस्तावेज़ देखें.

नमूना कोड

नीचे दिया गया सैंपल कोड, एपीआई के वर्शन 3 का इस्तेमाल करता है.

इवेंट बनाना

इस उदाहरण में बताया गया है कि उपयोगकर्ता के डिफ़ॉल्ट कैलेंडर में इवेंट कैसे बनाया जाता है.

बेहतर/calendar.gs
/**
 * Creates an event in the user's default calendar.
 * @see https://developers.google.com/calendar/api/v3/reference/events/insert
 */
function createEvent() {
  const calendarId = 'primary';
  const start = getRelativeDate(1, 12);
  const end = getRelativeDate(1, 13);
  // event details for creating event.
  let event = {
    summary: 'Lunch Meeting',
    location: 'The Deli',
    description: 'To discuss our plans for the presentation next week.',
    start: {
      dateTime: start.toISOString()
    },
    end: {
      dateTime: end.toISOString()
    },
    attendees: [
      {email: 'gduser1@workspacesample.dev'},
      {email: 'gduser2@workspacesample.dev'}
    ],
    // Red background. Use Calendar.Colors.get() for the full list.
    colorId: 11
  };
  try {
    // call method to insert/create new event in provided calandar
    event = Calendar.Events.insert(event, calendarId);
    Logger.log('Event ID: ' + event.id);
  } catch (err) {
    Logger.log('Failed with error %s', err.message);
  }
}

/**
 * Helper function to get a new Date object relative to the current date.
 * @param {number} daysOffset The number of days in the future for the new date.
 * @param {number} hour The hour of the day for the new date, in the time zone
 *     of the script.
 * @return {Date} The new date.
 */
function getRelativeDate(daysOffset, hour) {
  const date = new Date();
  date.setDate(date.getDate() + daysOffset);
  date.setHours(hour);
  date.setMinutes(0);
  date.setSeconds(0);
  date.setMilliseconds(0);
  return date;
}

लिस्टिंग कैलेंडर

नीचे दिए गए उदाहरण में उपयोगकर्ता के कैलेंडर की सूची में दिखाए गए कैलेंडर की जानकारी वापस पाने का तरीका बताया गया है.

बेहतर/calendar.gs
/**
 * Lists the calendars shown in the user's calendar list.
 * @see https://developers.google.com/calendar/api/v3/reference/calendarList/list
 */
function listCalendars() {
  let calendars;
  let pageToken;
  do {
    calendars = Calendar.CalendarList.list({
      maxResults: 100,
      pageToken: pageToken

    });
    if (!calendars.items || calendars.items.length === 0) {
      Logger.log('No calendars found.');
      return;
    }
    // Print the calendar id and calendar summary
    for (const calendar of calendars.items) {
      Logger.log('%s (ID: %s)', calendar.summary, calendar.id);
    }
    pageToken = calendars.nextPageToken;
  } while (pageToken);
}

लिस्टिंग इवेंट

यहां दिए गए उदाहरण में, उपयोगकर्ता के डिफ़ॉल्ट कैलेंडर में आने वाले 10 इवेंट को सूची में डालने का तरीका बताया गया है.

बेहतर/calendar.gs
/**
 * Lists the next 10 upcoming events in the user's default calendar.
 * @see https://developers.google.com/calendar/api/v3/reference/events/list
 */
function listNext10Events() {
  const calendarId = 'primary';
  const now = new Date();
  const events = Calendar.Events.list(calendarId, {
    timeMin: now.toISOString(),
    singleEvents: true,
    orderBy: 'startTime',
    maxResults: 10
  });
  if (!events.items || events.items.length === 0) {
    Logger.log('No events found.');
    return;
  }
  for (const event of events.items) {
    if (event.start.date) {
      // All-day event.
      const start = new Date(event.start.date);
      Logger.log('%s (%s)', event.summary, start.toLocaleDateString());
      return;
    }
    const start = new Date(event.start.dateTime);
    Logger.log('%s (%s)', event.summary, start.toLocaleString());
  }
}

किसी इवेंट में शर्तों के साथ बदलाव करना

इस उदाहरण में बताया गया है कि If-Match हेडर का इस्तेमाल करके, कैलेंडर इवेंट को शर्तों के साथ कैसे अपडेट किया जा सकता है. स्क्रिप्ट एक नया इवेंट बनाती है, 30 सेकंड इंतज़ार करती है. इसके बाद, इवेंट को सिर्फ़ तब अपडेट करती है, जब इवेंट बनाने के बाद से इवेंट की कोई जानकारी न बदली हो.

बेहतर/calendar.gs
/**
 * Creates an event in the user's default calendar, waits 30 seconds, then
 * attempts to update the event's location, on the condition that the event
 * has not been changed since it was created.  If the event is changed during
 * the 30-second wait, then the subsequent update will throw a 'Precondition
 * Failed' error.
 *
 * The conditional update is accomplished by setting the 'If-Match' header
 * to the etag of the new event when it was created.
 */
function conditionalUpdate() {
  const calendarId = 'primary';
  const start = getRelativeDate(1, 12);
  const end = getRelativeDate(1, 13);
  let event = {
    summary: 'Lunch Meeting',
    location: 'The Deli',
    description: 'To discuss our plans for the presentation next week.',
    start: {
      dateTime: start.toISOString()
    },
    end: {
      dateTime: end.toISOString()
    },
    attendees: [
      {email: 'gduser1@workspacesample.dev'},
      {email: 'gduser2@workspacesample.dev'}
    ],
    // Red background. Use Calendar.Colors.get() for the full list.
    colorId: 11
  };
  event = Calendar.Events.insert(event, calendarId);
  Logger.log('Event ID: ' + event.getId());
  // Wait 30 seconds to see if the event has been updated outside this script.
  Utilities.sleep(30 * 1000);
  // Try to update the event, on the condition that the event state has not
  // changed since the event was created.
  event.location = 'The Coffee Shop';
  try {
    event = Calendar.Events.update(
        event,
        calendarId,
        event.id,
        {},
        {'If-Match': event.etag}
    );
    Logger.log('Successfully updated event: ' + event.id);
  } catch (e) {
    Logger.log('Fetch threw an exception: ' + e);
  }
}

किसी इवेंट को शर्तों के साथ वापस पाना

नीचे दिए गए उदाहरण में बताया गया है कि If-None-Match हेडर का इस्तेमाल करके, किसी कैलेंडर इवेंट को शर्त के साथ कैसे फ़ेच किया जा सकता है. स्क्रिप्ट एक नया इवेंट बनाती है और फिर उन इवेंट को 30 सेकंड तक पोल करती है. जब भी इवेंट बदलता है, नया वर्शन लाया जाता है.

बेहतर/calendar.gs
/**
 * Creates an event in the user's default calendar, then re-fetches the event
 * every second, on the condition that the event has changed since the last
 * fetch.
 *
 * The conditional fetch is accomplished by setting the 'If-None-Match' header
 * to the etag of the last known state of the event.
 */
function conditionalFetch() {
  const calendarId = 'primary';
  const start = getRelativeDate(1, 12);
  const end = getRelativeDate(1, 13);
  let event = {
    summary: 'Lunch Meeting',
    location: 'The Deli',
    description: 'To discuss our plans for the presentation next week.',
    start: {
      dateTime: start.toISOString()
    },
    end: {
      dateTime: end.toISOString()
    },
    attendees: [
      {email: 'gduser1@workspacesample.dev'},
      {email: 'gduser2@workspacesample.dev'}
    ],
    // Red background. Use Calendar.Colors.get() for the full list.
    colorId: 11
  };
  try {
    // insert event
    event = Calendar.Events.insert(event, calendarId);
    Logger.log('Event ID: ' + event.getId());
    // Re-fetch the event each second, but only get a result if it has changed.
    for (let i = 0; i < 30; i++) {
      Utilities.sleep(1000);
      event = Calendar.Events.get(calendarId, event.id, {}, {'If-None-Match': event.etag});
      Logger.log('New event description: ' + event.start.dateTime);
    }
  } catch (e) {
    Logger.log('Fetch threw an exception: ' + e);
  }
}

इवेंट सिंक हो रहे हैं

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

नीचे दिए गए उदाहरण में, ऊपर दिए गए उदाहरणों में बताया गया getRelativeDate(daysOffset, hour) तरीका ही इस्तेमाल किया गया है.

बेहतर/calendar.gs
/**
 * Retrieve and log events from the given calendar that have been modified
 * since the last sync. If the sync token is missing or invalid, log all
 * events from up to a month ago (a full sync).
 *
 * @param {string} calendarId The ID of the calender to retrieve events from.
 * @param {boolean} fullSync If true, throw out any existing sync token and
 *        perform a full sync; if false, use the existing sync token if possible.
 */
function logSyncedEvents(calendarId, fullSync) {
  const properties = PropertiesService.getUserProperties();
  const options = {
    maxResults: 100
  };
  const syncToken = properties.getProperty('syncToken');
  if (syncToken && !fullSync) {
    options.syncToken = syncToken;
  } else {
    // Sync events up to thirty days in the past.
    options.timeMin = getRelativeDate(-30, 0).toISOString();
  }
  // Retrieve events one page at a time.
  let events;
  let pageToken;
  do {
    try {
      options.pageToken = pageToken;
      events = Calendar.Events.list(calendarId, options);
    } catch (e) {
      // Check to see if the sync token was invalidated by the server;
      // if so, perform a full sync instead.
      if (e.message === 'Sync token is no longer valid, a full sync is required.') {
        properties.deleteProperty('syncToken');
        logSyncedEvents(calendarId, true);
        return;
      }
      throw new Error(e.message);
    }
    if (events.items && events.items.length === 0) {
      Logger.log('No events found.');
      return;
    }
    for (const event of events.items) {
      if (event.status === 'cancelled') {
        Logger.log('Event id %s was cancelled.', event.id);
        return;
      }
      if (event.start.date) {
        const start = new Date(event.start.date);
        Logger.log('%s (%s)', event.summary, start.toLocaleDateString());
        return;
      }
      // Events that don't last all day; they have defined start times.
      const start = new Date(event.start.dateTime);
      Logger.log('%s (%s)', event.summary, start.toLocaleString());
    }
    pageToken = events.nextPageToken;
  } while (pageToken);
  properties.setProperty('syncToken', events.nextSyncToken);
}