Class CalendarApp

تطبيقتقويم Google

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

الخصائص

الموقعالنوعالوصف
ColorColorتعداد يمثّل الألوان المسماة المتاحة في خدمة "تقويم Google".
EventColorEventColorتعداد يمثّل ألوان الأحداث المسماة المتاحة في خدمة "تقويم Google".
EventTransparencyEventTransparencyتعداد EventTransparency
EventTypeEventTypeتعداد EventType
GuestStatusGuestStatusتعداد يمثّل الحالات التي يمكن أن يكون عليها الضيف في حدث ما.
MonthMonthتعداد يمثّل أشهر السنة.
VisibilityVisibilityتعداد يمثّل مستوى رؤية حدث معيّن.
WeekdayWeekdayتعداد يمثّل أيام الأسبوع.

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
createAllDayEvent(title, date)CalendarEventينشئ حدثًا جديدًا يستمر طوال اليوم.
createAllDayEvent(title, startDate, endDate)CalendarEventتنشئ هذه الطريقة حدثًا جديدًا يستمر طوال اليوم ويمكن أن يمتد لعدة أيام.
createAllDayEvent(title, startDate, endDate, options)CalendarEventتنشئ هذه الطريقة حدثًا جديدًا يستمر طوال اليوم ويمكن أن يمتد لعدة أيام.
createAllDayEvent(title, date, options)CalendarEventينشئ حدثًا جديدًا يستمر طوال اليوم.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesتنشئ هذه الطريقة سلسلة أحداث جديدة تستمر طوال اليوم.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesتنشئ هذه الطريقة سلسلة أحداث جديدة تستمر طوال اليوم.
createCalendar(name)Calendarتنشئ هذه الطريقة تقويمًا جديدًا يملكه المستخدم.
createCalendar(name, options)Calendarتنشئ هذه الطريقة تقويمًا جديدًا يملكه المستخدم.
createEvent(title, startTime, endTime)CalendarEventتنشئ هذه الطريقة حدثًا جديدًا.
createEvent(title, startTime, endTime, options)CalendarEventتنشئ هذه الطريقة حدثًا جديدًا.
createEventFromDescription(description)CalendarEventتنشئ هذه الدالة حدثًا من وصف ذي تصميم مرن.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesتنشئ هذه الطريقة سلسلة أحداث جديدة.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesتنشئ هذه الطريقة سلسلة أحداث جديدة.
getAllCalendars()Calendar[]تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم أو اشترك فيها.
getAllOwnedCalendars()Calendar[]تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم.
getCalendarById(id)Calendar|nullتعرض هذه الطريقة التقويم الذي يحمل المعرّف المحدّد.
getCalendarsByName(name)Calendar[]تعرض هذه الطريقة جميع التقاويم التي تحمل اسمًا معيّنًا ويملكها المستخدم أو اشترك فيها.
getColor()Stringتعرض هذه الطريقة لون التقويم.
getDefaultCalendar()Calendarتعرض هذه الطريقة التقويم التلقائي للمستخدم.
getDescription()Stringتعرض هذه الطريقة وصف التقويم.
getEventById(iCalId)CalendarEventتعرض هذه الطريقة الحدث الذي يحمل رقم التعريف المحدّد.
getEventSeriesById(iCalId)CalendarEventSeriesتعرض هذه الطريقة سلسلة الأحداث التي تحمل المعرّف المحدّد.
getEvents(startTime, endTime)CalendarEvent[]تعرض هذه السمة جميع الأحداث التي تقع ضمن نطاق زمني محدّد.
getEvents(startTime, endTime, options)CalendarEvent[]تعرض جميع الأحداث التي تحدث خلال نطاق زمني معيّن وتستوفي المعايير المحدّدة.
getEventsForDay(date)CalendarEvent[]تعرض هذه الطريقة جميع الأحداث التي تقع في يوم معيّن.
getEventsForDay(date, options)CalendarEvent[]تعرض هذه الطريقة جميع الأحداث التي تحدث في يوم معيّن وتستوفي معايير محدّدة.
getId()Stringتعرض هذه السمة رقم تعريف التقويم.
getName()Stringتعرض هذه السمة اسم التقويم.
getOwnedCalendarById(id)Calendar|nullتعرض هذه الطريقة التقويم الذي يحمل رقم التعريف المحدّد، إذا كان المستخدم يملكه.
getOwnedCalendarsByName(name)Calendar[]تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم والتي تحمل اسمًا معيّنًا.
getTimeZone()Stringتعرض هذه الطريقة المنطقة الزمنية للتقويم.
isHidden()Booleanتحدِّد هذه السمة ما إذا كان التقويم مخفيًا في واجهة المستخدم.
isMyPrimaryCalendar()Booleanتحدّد هذه السمة ما إذا كان التقويم هو التقويم الأساسي للمستخدم الفعلي.
isOwnedByMe()Booleanتحدّد هذه السمة ما إذا كنت تملك التقويم.
isSelected()Booleanيحدّد هذا الإعداد ما إذا كان سيتم عرض أحداث التقويم في واجهة المستخدم.
newRecurrence()EventRecurrenceتُنشئ هذه الطريقة عنصر تكرار جديدًا يمكن استخدامه لإنشاء قواعد لتكرار الأحداث.
setColor(color)Calendarتضبط هذه السمة لون التقويم.
setDescription(description)Calendarتضبط هذه الطريقة وصف التقويم.
setHidden(hidden)Calendarيحدّد هذا الإعداد ما إذا كان التقويم مرئيًا في واجهة المستخدم.
setName(name)Calendarتُستخدَم لضبط اسم التقويم.
setSelected(selected)Calendarيحدّد هذا الإعداد ما إذا كان سيتم عرض أحداث التقويم في واجهة المستخدم أم لا.
setTimeZone(timeZone)Calendarتضبط هذه السمة المنطقة الزمنية للتقويم.
subscribeToCalendar(id)Calendarيشترك المستخدم في التقويم الذي يحمل رقم التعريف المحدّد، إذا كان مسموحًا له بالاشتراك.
subscribeToCalendar(id, options)Calendarيشترك المستخدم في التقويم الذي يحمل رقم التعريف المحدّد، إذا كان مسموحًا له بالاشتراك.

مستندات تفصيلية

createAllDayEvent(title, date)

ينشئ حدثًا جديدًا يستمر طوال اليوم.

// Creates an all-day event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل هذه السمة عنوان الحدث.
dateDateتاريخ الحدث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, startDate, endDate)

تنشئ هذه الطريقة حدثًا جديدًا يستمر طوال اليوم ويمكن أن يمتد لعدة أيام.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل هذه السمة عنوان الحدث.
startDateDateتاريخ بدء الحدث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت).
endDateDateتمثّل هذه السمة تاريخ انتهاء الفعالية (يتم استخدام اليوم فقط ويتم تجاهل الوقت). تاريخ الانتهاء غير مشمول.

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, startDate, endDate, options)

تنشئ هذه الطريقة حدثًا جديدًا يستمر طوال اليوم ويمكن أن يمتد لعدة أيام.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
    {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true},
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل هذه السمة عنوان الحدث.
startDateDateتاريخ بدء الحدث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت).
endDateDateتمثّل هذه السمة تاريخ انتهاء الفعالية (يتم استخدام اليوم فقط ويتم تجاهل الوقت). تاريخ الانتهاء غير مشمول.
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسمالنوعالوصف
descriptionStringوصف الحدث.
locationStringالموقع الجغرافي حيث ستقام الفعالية.
guestsStringقائمة قيم مفصولة بفاصلة تضم عناوين البريد الإلكتروني التي يجب إضافتها كضيوف.
sendInvitesBooleanتحديد ما إذا كان سيتم إرسال دعوات بالبريد الإلكتروني (القيمة التلقائية: false)

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, date, options)

ينشئ حدثًا جديدًا يستمر طوال اليوم.

// Creates an all-day event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
    {location: 'The Moon'},
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل هذه السمة عنوان الحدث.
dateDateتاريخ الحدث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسمالنوعالوصف
descriptionStringوصف الحدث.
locationStringالموقع الجغرافي حيث ستقام الفعالية.
guestsStringقائمة قيم مفصولة بفاصلة تضم عناوين البريد الإلكتروني التي يجب إضافتها كضيوف.
sendInvitesBooleanتحديد ما إذا كان سيتم إرسال دعوات بالبريد الإلكتروني (القيمة التلقائية: false)

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEventSeries(title, startDate, recurrence)

تنشئ هذه الطريقة سلسلة أحداث جديدة تستمر طوال اليوم.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')),
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringعنوان الأحداث في السلسلة
startDateDateتاريخ الحدث الأول في السلسلة (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)
recurrenceEventRecurrenceإعدادات التكرار لسلسلة الأحداث

الإرجاع

CalendarEventSeries: سلسلة الأحداث التي تم إنشاؤها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEventSeries(title, startDate, recurrence, options)

تنشئ هذه الطريقة سلسلة أحداث جديدة تستمر طوال اليوم.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')),
    {guests: 'everyone@example.com'},
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringعنوان الأحداث في السلسلة
startDateDateتاريخ الحدث الأول في السلسلة (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)
recurrenceEventRecurrenceإعدادات التكرار لسلسلة الأحداث
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
descriptionStringوصف الأحداث في السلسلة
locationStringالموقع الجغرافي للأحداث في السلسلة
guestsStringقائمة قيم مفصولة بفاصلة من عناوين البريد الإلكتروني التي يجب إضافتها كضيوف إلى الأحداث في السلسلة
sendInvitesBooleanما إذا كان سيتم إرسال دعوات بالبريد الإلكتروني (القيمة التلقائية: false)

الإرجاع

CalendarEventSeries: سلسلة الأحداث التي تم إنشاؤها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name)

تنشئ هذه الطريقة تقويمًا جديدًا يملكه المستخدم.

// Creates a new calendar named "Travel Plans".
const calendar = CalendarApp.createCalendar('Travel Plans');
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

المعلمات

الاسمالنوعالوصف
nameStringاسم التقويم الجديد

الإرجاع

Calendar: التقويم الذي تم إنشاؤه حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name, options)

تنشئ هذه الطريقة تقويمًا جديدًا يملكه المستخدم.

// Creates a new calendar named "Travel Plans" with a description and color.
const calendar = CalendarApp.createCalendar('Travel Plans', {
  description: 'A calendar to plan my travel schedule.',
  color: CalendarApp.Color.BLUE,
});
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

المعلمات

الاسمالنوعالوصف
nameStringاسم التقويم الجديد
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
locationStringالموقع الجغرافي للتقويم
descriptionStringوصف التقويم
timeZoneStringالمنطقة الزمنية التي سيتم ضبط التقويم عليها، ويتم تحديدها بالتنسيق "طويل" (على سبيل المثال، ‫"America/New_York"، كما هو مدرَج في Joda.org)
colorStringسلسلة لون سداسي عشري ("#rrggbb") أو قيمة من CalendarApp.Colors
hiddenBooleanما إذا كان التقويم مخفيًا في واجهة المستخدم (القيمة التلقائية: false)
selectedBooleanما إذا كانت أحداث التقويم معروضة في واجهة المستخدم (القيمة التلقائية: true)

الإرجاع

Calendar: التقويم الذي تم إنشاؤه حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEvent(title, startTime, endTime)

تنشئ هذه الطريقة حدثًا جديدًا.

في حال عدم تحديد منطقة زمنية، يتم تفسير قيم الوقت في سياق المنطقة الزمنية للبرنامج النصي، والتي قد تختلف عن المنطقة الزمنية للتقويم.

// Creates an event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 21, 1969 21:00:00 UTC'),
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل عنوان الحدث
startTimeDateتاريخ ووقت بدء الحدث
endTimeDateتاريخ ووقت انتهاء الحدث

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEvent(title, startTime, endTime, options)

تنشئ هذه الطريقة حدثًا جديدًا.

في حال عدم تحديد منطقة زمنية، يتم تفسير قيم الوقت في سياق المنطقة الزمنية للبرنامج النصي، والتي قد تختلف عن المنطقة الزمنية للتقويم.

// Creates an event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 20, 1969 21:00:00 UTC'),
    {location: 'The Moon'},
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringتمثّل عنوان الحدث
startTimeDateتاريخ ووقت بدء الحدث
endTimeDateتاريخ ووقت انتهاء الحدث
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
descriptionStringوصف الحدث
locationStringالموقع الجغرافي للحدث
guestsStringقائمة مفصولة بفواصل تضمّ عناوين البريد الإلكتروني التي يجب إضافتها كضيوف
sendInvitesBooleanما إذا كان سيتم إرسال دعوات بالبريد الإلكتروني (القيمة التلقائية: false)

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventFromDescription(description)

تنشئ هذه الدالة حدثًا من وصف ذي تصميم مرن.

يجب أن يستخدم الوصف التنسيق نفسه المستخدَم في ميزة "الإضافة السريعة" في واجهة المستخدم.

// Creates a new event and logs its ID.
const event = CalendarApp.getDefaultCalendar().createEventFromDescription(
    'Lunch with Mary, Friday at 1PM',
);
Logger.log(`Event ID: ${event.getId()}`);

المعلمات

الاسمالنوعالوصف
descriptionStringوصف الحدث بأي شكل

الإرجاع

CalendarEvent: الحدث الذي تم إنشاؤه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventSeries(title, startTime, endTime, recurrence)

تنشئ هذه الطريقة سلسلة أحداث جديدة.

// Creates an event series for a team meeting, taking place every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries(
    'Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringعنوان الأحداث في السلسلة
startTimeDateتمثّل هذه السمة تاريخ ووقت بدء الحدث الأول في السلسلة.
endTimeDateتاريخ ووقت انتهاء الحدث الأول في السلسلة
recurrenceEventRecurrenceإعدادات التكرار لسلسلة الأحداث

الإرجاع

CalendarEventSeries: سلسلة الأحداث التي تم إنشاؤها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventSeries(title, startTime, endTime, recurrence, options)

تنشئ هذه الطريقة سلسلة أحداث جديدة.

// Creates an event series for a team meeting, taking place every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries(
    'Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
    {location: 'Conference Room'},
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

المعلمات

الاسمالنوعالوصف
titleStringعنوان الأحداث في السلسلة
startTimeDateتمثّل هذه السمة تاريخ ووقت بدء الحدث الأول في السلسلة.
endTimeDateتاريخ ووقت انتهاء الحدث الأول في السلسلة
recurrenceEventRecurrenceإعدادات التكرار لسلسلة الأحداث
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
descriptionStringوصف الأحداث في السلسلة
locationStringالموقع الجغرافي للأحداث في السلسلة
guestsStringقائمة قيم مفصولة بفاصلة من عناوين البريد الإلكتروني التي يجب إضافتها كضيوف إلى الأحداث في السلسلة
sendInvitesBooleanما إذا كان سيتم إرسال دعوات بالبريد الإلكتروني (القيمة التلقائية: false)

الإرجاع

CalendarEventSeries: سلسلة الأحداث التي تم إنشاؤها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllCalendars()

تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم أو اشترك فيها.

// Determines how many calendars the user can access.
const calendars = CalendarApp.getAllCalendars();
Logger.log(
    'This user owns or is subscribed to %s calendars.',
    calendars.length,
);

الإرجاع

Calendar[]: جميع التقاويم التي يمكن للمستخدم الوصول إليها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllOwnedCalendars()

تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم.

// Determines how many calendars the user owns.
const calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

الإرجاع

Calendar[]: جميع التقاويم التي يملكها المستخدم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCalendarById(id)

تعرض هذه الطريقة التقويم الذي يحمل المعرّف المحدّد.

// Gets the public calendar "US Holidays" by ID.
const calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

المعلمات

الاسمالنوعالوصف
idStringمعرّف التقويم

الإرجاع

Calendar|null: التقويم الذي يحمل رقم التعريف المحدّد، أو null إذا كان التقويم غير متوفّر أو إذا لم يكن بإمكان المستخدم الوصول إليه أو إذا لم يكن مشتركًا فيه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCalendarsByName(name)

تعرض هذه الطريقة جميع التقاويم التي تحمل اسمًا معيّنًا ويملكها المستخدم أو اشترك فيها. الأسماء غير حساسة لحالة الأحرف.

// Gets the public calendar named "US Holidays".
const calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

المعلمات

الاسمالنوعالوصف
nameStringاسم التقويم

الإرجاع

Calendar[]: جميع التقاويم بهذا الاسم التي يمكن للمستخدم الوصول إليها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getColor()

تعرض هذه الطريقة لون التقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

الإرجاع

String: سلسلة لون سداسي عشري (#rrggbb).

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDefaultCalendar()

تعرض هذه الطريقة التقويم التلقائي للمستخدم.

// Determines the time zone of the user's default calendar.
const calendar = CalendarApp.getDefaultCalendar();
Logger.log(
    'My default calendar is set to the time zone "%s".',
    calendar.getTimeZone(),
);

الإرجاع

Calendar: التقويم التلقائي للمستخدم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDescription()

تعرض هذه الطريقة وصف التقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

الإرجاع

String: وصف هذا التقويم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventById(iCalId)

تعرض هذه الطريقة الحدث الذي يحمل رقم التعريف المحدّد. إذا كانت السلسلة تنتمي إلى تقويم غير التقويم التلقائي، يجب استدعاء هذه الطريقة من ذلك التقويم. يؤدي طلب getEventById(iCalId) فقط إلى عرض حدث في التقويم التلقائي.

قد تتضمّن أحداث متعدّدة المعرّف نفسه إذا كانت جزءًا من سلسلة أحداث. في هذه الحالة، لا تعرض هذه الطريقة سوى الحدث الأول من تلك السلسلة.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Creates an event for the moon landing.
const event = calendar.createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:05:00 UTC'),
    new Date('July 20, 1969 20:17:00 UTC'),
);

// Gets the calendar event ID and logs it to the console.
const iCalId = event.getId();
console.log(iCalId);

// Gets the event by its ID and logs the title of the event to the console.
// For the default calendar, you can use CalendarApp.getEventById(iCalId)
// instead.
const myEvent = calendar.getEventById(iCalId);
console.log(myEvent.getTitle());

المعلمات

الاسمالنوعالوصف
iCalIdStringمعرّف الحدث

الإرجاع

CalendarEvent: الحدث الذي يحمل المعرّف المحدّد، أو null إذا كان الحدث غير متوفّر أو إذا لم يكن بإمكان المستخدم الوصول إليه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventSeriesById(iCalId)

تعرض هذه الطريقة سلسلة الأحداث التي تحمل المعرّف المحدّد. إذا كان رقم التعريف المحدّد خاصًا بـ CalendarEvent واحد، سيتم عرض CalendarEventSeries مع حدث واحد في السلسلة. يُرجى العِلم أنّه إذا كانت سلسلة الأحداث تنتمي إلى تقويم غير التقويم التلقائي، يجب استدعاء هذه الطريقة من CalendarApp. ولا يؤدي استدعاء getEventSeriesById(iCalId) مباشرةً إلا إلى عرض سلسلة أحداث متوفّرة في التقويم التلقائي.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31,
// 2023.
const eventSeries = calendar.createEventSeries(
    'Team meeting',
    new Date('Jan 1, 2023 13:00:00'),
    new Date('Jan 1, 2023 14:00:00'),
    CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')),
);

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

// Gets the event series by its ID and logs the series title to the console.
// For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId)
// instead.
console.log(calendar.getEventSeriesById(iCalId).getTitle());

المعلمات

الاسمالنوعالوصف
iCalIdStringرقم تعريف سلسلة الأحداث

الإرجاع

CalendarEventSeries: السلسلة التي تحمل رقم التعريف المحدّد، أو null إذا كانت السلسلة غير متوفّرة أو إذا لم يكن بإمكان المستخدم الوصول إليها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEvents(startTime, endTime)

تعرض هذه السمة جميع الأحداث التي تقع ضمن نطاق زمني محدّد.

تعرض هذه الطريقة الأحداث التي تبدأ خلال النطاق الزمني المحدّد أو تنتهي خلاله أو تشمله. في حال عدم تحديد منطقة زمنية، يتم تفسير قيم الوقت في سياق المنطقة الزمنية للبرنامج النصي، والتي قد تختلف عن المنطقة الزمنية للتقويم.

// Determines how many events are happening in the next two hours.
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log(`Number of events: ${events.length}`);

المعلمات

الاسمالنوعالوصف
startTimeDateبداية النطاق الزمني
endTimeDateنهاية النطاق الزمني، غير شاملة

الإرجاع

CalendarEvent[]: الأحداث التي تقع ضمن النطاق الزمني

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEvents(startTime, endTime, options)

تعرض جميع الأحداث التي تحدث خلال نطاق زمني معيّن وتستوفي المعايير المحدّدة.

تعرض هذه الطريقة الأحداث التي تبدأ خلال النطاق الزمني المحدّد أو تنتهي خلاله أو تشمله. في حال عدم تحديد منطقة زمنية، يتم تفسير قيم الوقت في سياق المنطقة الزمنية للبرنامج النصي، والتي قد تختلف عن المنطقة الزمنية للتقويم.

يُرجى العِلم أنّ الفلترة حسب author أو search أو statusFilters تتم بعد تطبيق start وmax. وهذا يعني أنّ عدد الأحداث التي يتم عرضها قد يكون أقل من max، حتى إذا كانت أحداث إضافية تستوفي المعايير.

// Determines how many events are happening in the next two hours that contain
// the term "meeting".
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const events = CalendarApp.getDefaultCalendar().getEvents(
    now,
    twoHoursFromNow,
    {search: 'meeting'},
);
Logger.log(`Number of events: ${events.length}`);

المعلمات

الاسمالنوعالوصف
startTimeDateبداية النطاق الزمني
endTimeDateنهاية النطاق الزمني، غير شاملة
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
startIntegerفهرس أول حدث سيتم عرضه
maxIntegerالحدّ الأقصى لعدد الأحداث التي سيتم عرضها
authorStringعنوان بريد إلكتروني يُستخدَم لفلترة النتائج حسب صانع الحدث
searchStringطلب بحث بنص كامل يُستخدَم لفلترة النتائج
statusFilters[]GuestStatusمصفوفة من الحالات المستخدَمة لفلترة النتائج

الإرجاع

CalendarEvent[]: الأحداث التي تحدث خلال النطاق الزمني وتتطابق مع المعايير

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventsForDay(date)

تعرض هذه الطريقة جميع الأحداث التي تقع في يوم معيّن.

تعرض هذه الطريقة الأحداث إذا بدأت خلال اليوم المحدّد أو انتهت خلاله أو شملته.

يُرجى العِلم أنّه يتم استخدام جزء التاريخ فقط من عنصر التاريخ، ويتم تجاهل جزء الوقت. يتم تفسير التاريخ على أنّه من منتصف الليل في ذلك اليوم إلى منتصف الليل في اليوم التالي في المنطقة الزمنية للتقويم.

// Determines how many events are happening today.
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log(`Number of events: ${events.length}`);

المعلمات

الاسمالنوعالوصف
dateDateتاريخ استرداد الأحداث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)

الإرجاع

CalendarEvent[]: الأحداث التي تحدث في التاريخ المحدّد

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventsForDay(date, options)

تعرض هذه الطريقة جميع الأحداث التي تحدث في يوم معيّن وتستوفي معايير محدّدة.

تعرض هذه الطريقة الأحداث إذا بدأت خلال اليوم المحدّد أو انتهت خلاله أو شملته.

يُرجى العِلم أنّه يتم استخدام جزء التاريخ فقط من عنصر التاريخ، ويتم تجاهل جزء الوقت. يتم تفسير التاريخ على أنّه من منتصف الليل في ذلك اليوم إلى منتصف الليل في اليوم التالي في المنطقة الزمنية للتقويم.

يُرجى العِلم أنّ الفلترة حسب author أو search أو statusFilters تتم بعد تطبيق start وmax. وهذا يعني أنّ عدد الأحداث التي يتم عرضها قد يكون أقل من max، حتى إذا كانت أحداث إضافية تستوفي المعايير.

// Determines how many events are happening today and contain the term
// "meeting".
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {
  search: 'meeting',
});
Logger.log(`Number of events: ${events.length}`);

المعلمات

الاسمالنوعالوصف
dateDateتاريخ استرداد الأحداث (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)
optionsObjectخيارات الفلترة المتقدّمة

المعلمات المتقدمة

الاسمالنوعالوصف
startIntegerفهرس أول حدث سيتم عرضه
maxIntegerالحدّ الأقصى لعدد الأحداث التي سيتم عرضها
authorStringعنوان بريد إلكتروني يُستخدَم لفلترة النتائج حسب صانع الحدث
searchStringطلب بحث بنص كامل يُستخدَم لفلترة النتائج
statusFilters[]GuestStatusمصفوفة من الحالات المستخدَمة لفلترة النتائج

الإرجاع

CalendarEvent[]: الأحداث التي تحدث في التاريخ المحدّد وتتطابق مع المعايير

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

تعرض هذه السمة رقم تعريف التقويم. معرّف التقويم التلقائي للمستخدم هو عنوان بريده الإلكتروني.

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the ID of the calendar and logs it to the console.
const calendarId = calendar.getId();
console.log(calendarId);

الإرجاع

استبدِل String برقم تعريف التقويم.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getName()

تعرض هذه السمة اسم التقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

الإرجاع

String: اسم هذا التقويم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOwnedCalendarById(id)

تعرض هذه الطريقة التقويم الذي يحمل رقم التعريف المحدّد، إذا كان المستخدم يملكه.

للعثور على معرّف التقويم، انقر على السهم بجانب اسم التقويم في "تقويم Google"، ثم اختَر إعدادات التقويم. يظهر رقم التعريف بالقرب من أسفل صفحة الإعدادات.

// Gets a (non-existent) private calendar by ID.
const calendar = CalendarApp.getOwnedCalendarById(
    '123456789@group.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

المعلمات

الاسمالنوعالوصف
idStringمعرّف التقويم

الإرجاع

Calendar|null: التقويم الذي يحمل رقم التعريف المحدّد، أو null إذا كان التقويم غير موجود أو إذا لم يكن المستخدم هو مالكه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOwnedCalendarsByName(name)

تعرض هذه الطريقة جميع التقاويم التي يملكها المستخدم والتي تحمل اسمًا معيّنًا. الأسماء ليست حسّاسة لحالة الأحرف.

// Gets a private calendar named "Travel Plans".
const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

المعلمات

الاسمالنوعالوصف
nameStringاسم التقويم

الإرجاع

Calendar[]: جميع التقاويم بهذا الاسم التي يملكها المستخدم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTimeZone()

تعرض هذه الطريقة المنطقة الزمنية للتقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

الإرجاع

String: المنطقة الزمنية، ويتم تحديدها بالتنسيق "الطويل" (على سبيل المثال، "America/New_York"، كما هو مدرج في Joda.org).

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isHidden()

تحدِّد هذه السمة ما إذا كان التقويم مخفيًا في واجهة المستخدم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is hidden in the user interface and logs it
// to the console. For the default calendar, you can use CalendarApp.isHidden()
// instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

الإرجاع

Booleantrue إذا كان التقويم مخفيًا في واجهة المستخدم، وfalse إذا لم يكن مخفيًا.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isMyPrimaryCalendar()

تحدّد هذه السمة ما إذا كان التقويم هو التقويم الأساسي للمستخدم الفعلي.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar()
// instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

الإرجاع

Boolean: true إذا كان التقويم هو التقويم التلقائي للمستخدم الفعلي، أو false إذا لم يكن كذلك.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isOwnedByMe()

تحدّد هذه السمة ما إذا كنت تملك التقويم.

// Gets a calendar by its ID. To get the user's default calendar, use
// CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with the calendar ID that you want to use.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

الإرجاع

Boolean: true إذا كنت تملك التقويم، false إذا لم تكن تملكه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isSelected()

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

// Gets the user's default calendar. To get a different calendar,
// use getCalendarById() instead.
const calendar = CalendarApp.getDefaultCalendar();

// Determines whether the calendar's events are displayed in the user interface
// and logs it.
console.log(calendar.isSelected());

الإرجاع

Booleantrue إذا كانت أحداث التقويم معروضة في واجهة المستخدم، false إذا لم تكن معروضة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

newRecurrence()

تُنشئ هذه الطريقة عنصر تكرار جديدًا يمكن استخدامه لإنشاء قواعد لتكرار الأحداث.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    recurrence,
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

الإرجاع

EventRecurrence: عنصر تكرار جديد بدون ضبط أي قواعد (يتصرف كتكرار أسبوعي)

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setColor(color)

تضبط هذه السمة لون التقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

المعلمات

الاسمالنوعالوصف
colorStringCalendarApp.Color أو سلسلة لون سداسي عشري ("#rrggbb").

الإرجاع

Calendar: هذا التقويم مخصّص للربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

تضبط هذه الطريقة وصف التقويم.

// Gets the user's default calendar. To get a different calendar,
// use getCalendarById() instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.');

المعلمات

الاسمالنوعالوصف
descriptionStringوصف هذا التقويم

الإرجاع

Calendar: هذا التقويم لربط المواعيد المتتالية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setHidden(hidden)

يحدّد هذا الإعداد ما إذا كان التقويم مرئيًا في واجهة المستخدم.

المعلمات

الاسمالنوعالوصف
hiddenBooleantrue لإخفاء التقويم في واجهة المستخدم، وfalse لإظهاره

الإرجاع

Calendar: هذا التقويم لربط المواعيد المتتالية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setName(name)

تُستخدَم لضبط اسم التقويم.

// Gets the user's default calendar. To get a different calendar,
// use getCalendarById() instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

المعلمات

الاسمالنوعالوصف
nameStringالاسم الجديد

الإرجاع

Calendar: هذا التقويم لربط المواعيد المتتالية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setSelected(selected)

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

// Gets the user's default calendar. To get a different calendar,
// use getCalendarById() instead.
const calendar = CalendarApp.getDefaultCalendar();

// Selects the calendar so that its events are displayed in the user interface.
// To unselect the calendar, set the parameter to false.
calendar.setSelected(true);

المعلمات

الاسمالنوعالوصف
selectedBooleantrue لإظهار أحداث التقويم في واجهة المستخدم، وfalse لإخفائها

الإرجاع

Calendar: هذا التقويم لربط المواعيد المتتالية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTimeZone(timeZone)

تضبط هذه السمة المنطقة الزمنية للتقويم.

// Gets the user's default calendar. To get a different calendar,
// use getCalendarById() instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

المعلمات

الاسمالنوعالوصف
timeZoneStringالمنطقة الزمنية، المحدّدة بالتنسيق "الطويل" (مثل "America/New_York"، كما هو موضّح في Joda.org).

الإرجاع

Calendar: هذا التقويم مخصّص للربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id)

يشترك المستخدم في التقويم الذي يحمل رقم التعريف المحدّد، إذا كان مسموحًا له بالاشتراك.

// Subscribe to the calendar "US Holidays".
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

المعلمات

الاسمالنوعالوصف
idStringرقم تعريف التقويم الذي تريد الاشتراك فيه

الإرجاع

Calendar: التقويم الذي تم الاشتراك فيه حديثًا

عمليات الطرح

Error: في حال عدم توفّر تقويم بهذا المعرّف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id, options)

يشترك المستخدم في التقويم الذي يحمل رقم التعريف المحدّد، إذا كان مسموحًا له بالاشتراك.

// Subscribe to the calendar "US Holidays", and set it to the color blue.
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
    {color: CalendarApp.Color.BLUE},
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

المعلمات

الاسمالنوعالوصف
idStringرقم تعريف التقويم المطلوب الاشتراك فيه
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسمالنوعالوصف
colorStringسلسلة لون سداسي عشري ("#rrggbb") أو قيمة من CalendarApp.Colors
hiddenBooleanتحديد ما إذا كان التقويم مخفيًا في واجهة المستخدم (القيمة التلقائية: false)
selectedBooleanتحديد ما إذا كانت أحداث التقويم معروضة في واجهة المستخدم (القيمة التلقائية: true إذا تم تحديد color أيضًا، false في الحالات الأخرى).

الإرجاع

Calendar: التقويم الذي تم الاشتراك فيه حديثًا

عمليات الطرح

Error: في حال عدم توفّر تقويم بهذا المعرّف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds