Gelişmiş Takvim Hizmeti

Kullanıcı takvimlerine ek özelliklerle erişmek ve bunları değiştirmek için kullanılan komut dosyası.

Gelişmiş Takvim hizmeti, Google Apps Komut Dosyası'nda herkese açık Google Calendar API'yi kullanmanıza olanak tanır. Apps Komut Dosyası'nın yerleşik Takvim hizmetine benzer şekilde bu API, komut dosyalarının kullanıcının Google Takvim'ine (kullanıcının abone olduğu ek takvimler dahil) erişmesine ve bu takvimi değiştirmesine olanak tanır. Çoğu durumda yerleşik hizmetin kullanımı daha kolaydır ancak bu gelişmiş hizmet, tek tek etkinliklerin arka plan rengini ayarlama gibi birkaç ek özellik sunar.

Bu, kullanımdan önce etkinleştirilmesi gereken gelişmiş bir hizmettir.

Referans

Bu hizmetle ilgili ayrıntılı bilgi için herkese açık Calendar API'nin referans belgelerine bakın. Apps Komut Dosyası'ndaki tüm gelişmiş hizmetler gibi, gelişmiş Takvim hizmeti de herkese açık API ile aynı nesneleri, yöntemleri ve parametreleri kullanır. Daha fazla bilgi için Yöntem imzaları nasıl belirlenir? başlıklı makaleyi inceleyin.

Sorunları bildirmek ve diğer destek seçeneklerini görmek için Takvim Destek Kılavuzu'na bakın.

HTTP isteği başlıkları

Gelişmiş Takvim hizmeti, HTTP istek başlıklarını If-Match ve If-None-Match kabul edebilir. Ayrıntılar için referans belgelerine bakın.

Örnek kod

Aşağıdaki örnek kodda API'nin 3. sürümü kullanılmaktadır.

Etkinlik oluşturma

Aşağıdaki örnekte, kullanıcının varsayılan takviminde nasıl etkinlik oluşturulacağı gösterilmektedir.

advanced/calendar.gs

GitHub'da göster

/**
 * 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);
    console.log(`Event ID: ${event.id}`);
  } catch (err) {
    console.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;
}

Takvimleri listeleme

Aşağıdaki örnekte, kullanıcının takvim listesinde gösterilen takvimlerle ilgili ayrıntıların nasıl alınacağı gösterilmektedir.

advanced/calendar.gs

GitHub'da göster

/**
 * 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) {
      console.log("No calendars found.");
      return;
    }
    // Print the calendar id and calendar summary
    for (const calendar of calendars.items) {
      console.log("%s (ID: %s)", calendar.summary, calendar.id);
    }
    pageToken = calendars.nextPageToken;
  } while (pageToken);
}

Listeleme etkinlikleri

Aşağıdaki örnekte, kullanıcının varsayılan takvimindeki önümüzdeki 10 etkinliğin nasıl listeleneceği gösterilmektedir.

advanced/calendar.gs

GitHub'da göster

/**
 * 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) {
    console.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);
      console.log("%s (%s)", event.summary, start.toLocaleDateString());
      continue;
    }
    const start = new Date(event.start.dateTime);
    console.log("%s (%s)", event.summary, start.toLocaleString());
  }
}

Etkinlikleri koşullu olarak değiştirme

Aşağıdaki örnekte, If-Match üstbilgisini kullanarak bir takvim etkinliğinin koşullu olarak nasıl güncelleneceği gösterilmektedir. Komut dosyası yeni bir etkinlik oluşturur, 30 saniye bekler ve ardından etkinliği yalnızca etkinlik oluşturulduktan sonra etkinlik ayrıntılarında değişiklik yapılmamışsa günceller.

advanced/calendar.gs

GitHub'da göster

/**
 * 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);
  console.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 },
    );
    console.log(`Successfully updated event: ${event.id}`);
  } catch (e) {
    console.log(`Fetch threw an exception: ${e}`);
  }
}

Bir etkinliği koşullu olarak alma

Aşağıdaki örnekte, If-None-Match üstbilgisini kullanarak bir takvim etkinliğinin koşullu olarak nasıl getirileceği gösterilmektedir. Komut dosyası yeni bir etkinlik oluşturur ve ardından 30 saniye boyunca etkinlikte değişiklik olup olmadığını kontrol eder. Etkinlik her değiştiğinde yeni sürüm getirilir.

advanced/calendar.gs

GitHub'da göster

/**
 * 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);
    console.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 },
      );
      console.log(`New event description: ${event.start.dateTime}`);
    }
  } catch (e) {
    console.log(`Fetch threw an exception: ${e}`);
  }
}

Etkinlikleri senkronize etme

Aşağıdaki örnekte, senkronizasyon jetonları kullanılarak etkinliklerin nasıl alınacağı gösterilmektedir. Bir Takvim gelişmiş hizmet isteğine senkronizasyon jetonu eklediğinizde, sonuçta elde edilen yanıt yalnızca bu jeton oluşturulduktan sonra değişen öğeleri içerir. Bu sayede daha verimli bir işleme süreci sağlanır. Senkronizasyon süreci hakkında daha fazla bilgi için Kaynakları Verimli Bir Şekilde Senkronize Etme başlıklı makaleyi inceleyin.

Aşağıdaki örnekte, önceki örneklerde tanımlanan getRelativeDate(daysOffset, hour) yöntem kullanılmaktadır.

advanced/calendar.gs

GitHub'da göster

/**
 * 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) {
      console.log("No events found.");
      return;
    }
    for (const event of events.items) {
      if (event.status === "cancelled") {
        console.log("Event id %s was cancelled.", event.id);
        return;
      }
      if (event.start.date) {
        const start = new Date(event.start.date);
        console.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);
      console.log("%s (%s)", event.summary, start.toLocaleString());
    }
    pageToken = events.nextPageToken;
  } while (pageToken);
  properties.setProperty("syncToken", events.nextSyncToken);
}

Gelişmiş Takvim Hizmeti Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

Referans

HTTP isteği başlıkları

Örnek kod

Etkinlik oluşturma

Takvimleri listeleme

Listeleme etkinlikleri

Etkinlikleri koşullu olarak değiştirme

Bir etkinliği koşullu olarak alma

Etkinlikleri senkronize etme

Gelişmiş Takvim Hizmeti