تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

خدمة التقويم المتقدمة

تتيح لك خدمة "تقويم Google" المتقدّمة استخدام Google Calendar API العامة في "برمجة تطبيقات Google". تمامًا مثل خدمة "تقويم Google" المضمّنة في Apps Script، تتيح واجهة برمجة التطبيقات هذه للنصوص البرمجية الوصول إلى "تقويم Google" الخاص بالمستخدم وتعديله، بما في ذلك التقاويم الإضافية التي اشترك فيها المستخدم. في معظم الحالات، يكون استخدام الخدمة المضمّنة أسهل، ولكن هذه الخدمة المتقدّمة توفّر بعض الميزات الإضافية، بما في ذلك ضبط لون الخلفية للأحداث الفردية.

مراجع

للحصول على معلومات مفصّلة حول هذه الخدمة، يُرجى الاطّلاع على المستندات المرجعية لواجهة برمجة التطبيقات العامة في "تقويم Google". مثل جميع الخدمات المتقدّمة في Apps Script، تستخدم خدمة "تقويم Google" المتقدّمة الكائنات والطُرق والمعلَمات نفسها التي تستخدمها واجهة برمجة التطبيقات العامة. لمزيد من المعلومات، اطّلِع على كيفية تحديد تواقيع الطرق.

للإبلاغ عن مشاكل والعثور على خيارات دعم أخرى، يُرجى الاطّلاع على دليل دعم "تقويم Google".

عناوين طلبات HTTP

يمكن لخدمة "تقويم Google" المتقدّمة قبول عنوانَي طلب HTTP If-Match وIf-None-Match. لمزيد من التفاصيل، يُرجى الاطّلاع على المستندات المرجعية.

نموذج التعليمات البرمجية

يستخدِم نموذج الرمز البرمجي أدناه الإصدار 3 من واجهة برمجة التطبيقات.

إنشاء الأحداث

يوضّح المثال التالي كيفية إنشاء حدث في تقويم المستخدم التلقائي.

advanced/calendar.gs

عرض على GitHub

/**
 * 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;
}

عرض التقاويم

يوضّح المثال التالي كيفية استرداد تفاصيل حول التقاويم المعروضة في قائمة تقاويم المستخدم.

advanced/calendar.gs

عرض على GitHub

/**
 * 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);
}

أحداث بطاقة بيانات المتجر

يوضّح المثال التالي كيفية إدراج الأحداث العشرة القادمة في تقويم المستخدم التلقائي.

advanced/calendar.gs

عرض على GitHub

/**
 * 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());
  }
}

تعديل حدث بشكل مشروط

يوضّح المثال التالي كيفية تعديل حدث في "تقويم Google" بشكل مشروط باستخدام العنوان If-Match. ينشئ النص البرمجي حدثًا جديدًا، وينتظر لمدة 30 ثانية، ثم يعدّل الحدث فقط إذا لم تتغير أي تفاصيل منذ إنشاء الحدث.

advanced/calendar.gs

عرض على GitHub

/**
 * 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);
  }
}

استرداد حدث بشكل مشروط

يوضّح المثال التالي كيفية استرداد حدث من "تقويم Google" بشكل مشروط باستخدام العنوان If-None-Match. ينشئ النص البرمجي حدثًا جديدًا، ثم يستطلع الحدث بحثًا عن تغييرات لمدة 30 ثانية. في كل مرة يتغيّر فيها الحدث، يتم جلب الإصدار الجديد.

advanced/calendar.gs

عرض على GitHub

/**
 * 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);
  }
}

مزامنة الأحداث

يوضّح المثال التالي كيفية استرداد الأحداث باستخدام رموز المزامنة. عند تضمين رمز مميّز للمزامنة في طلب خدمة متقدّمة في "تقويم Google"، لن يتضمّن الردّ الناتج سوى العناصر التي تم تغييرها منذ إنشاء هذا الرمز المميّز، ما يتيح معالجة أكثر فعالية. راجِع مقالة مزامنة الموارد بكفاءة لمزيد من التفاصيل حول عملية المزامنة.

يستفيد المثال التالي من طريقة getRelativeDate(daysOffset, hour) نفسها المحدّدة في الأمثلة أعلاه.

advanced/calendar.gs

عرض على GitHub

/**
 * 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);
}

خدمة التقويم المتقدمة تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

مراجع

عناوين طلبات HTTP

نموذج التعليمات البرمجية

إنشاء الأحداث

عرض التقاويم

أحداث بطاقة بيانات المتجر

تعديل حدث بشكل مشروط

استرداد حدث بشكل مشروط

مزامنة الأحداث

خدمة التقويم المتقدمة