Class Calendar

تقويم Google

يمثّل تقويمًا يملكه المستخدم أو اشترك فيه.

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
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يؤدي هذا الإجراء إلى إنشاء سلسلة جديدة من الأحداث التي تستمر طوال اليوم.
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تُنشئ سلسلة أحداث جديدة.
deleteCalendar()voidيؤدي ذلك إلى حذف التقويم نهائيًا.
getColor()Stringللحصول على لون التقويم
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الحصول على اسم التقويم
getTimeZone()Stringتحصل على المنطقة الزمنية للتقويم.
isHidden()Booleanيحدِّد ما إذا كان التقويم مخفيًا في واجهة المستخدم.
isMyPrimaryCalendar()Booleanلتحديد ما إذا كان التقويم هو التقويم الأساسي للمستخدم الفعلي
isOwnedByMe()Booleanلتحديد ما إذا كان التقويم مملوكًا لك.
isSelected()Booleanيحدِّد ما إذا كان سيتم عرض أحداث التقويم في واجهة المستخدم.
setColor(color)Calendarلضبط لون التقويم
setDescription(description)Calendarلضبط وصف تقويم
setHidden(hidden)Calendarلضبط ما إذا كان التقويم مرئيًا في واجهة المستخدم.
setName(name)Calendarلضبط اسم التقويم.
setSelected(selected)Calendarلضبط ما إذا كان سيتم عرض أحداث التقويم في واجهة المستخدم.
setTimeZone(timeZone)Calendarلضبط المنطقة الزمنية للتقويم
unsubscribeFromCalendar()voidإلغاء اشتراك المستخدم في تقويم

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

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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

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

deleteCalendar()

يؤدي ذلك إلى حذف التقويم نهائيًا. لا يمكن للمستخدم حذف سوى التقويم الذي يملكه. 

// Creates a calendar to delete.
const calendar = CalendarApp.createCalendar('Test');

// Deletes the 'Test' calendar permanently.
calendar.deleteCalendar();

عمليات الرمي

Error - إذا كان هذا تقويمًا مستورَدًا.

التفويض

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

  • https://www.googleapis.com/auth/calendar
  • 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 ذات الصلة:

  • 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 ذات الصلة:

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

getEventById(iCalId)

تحصل على الحدث الذي يحمل رقم التعريف المحدّد. إذا كانت السلسلة تنتمي إلى تقويم غير التلقائي ، يجب استدعاء هذه الطريقة من ذلك التقويم. يؤدي استدعاء CalendarApp.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 ذات الصلة:

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

getEventSeriesById(iCalId)

تحصل على سلسلة الأحداث التي تحمل رقم التعريف المحدّد. إذا كان رقم التعريف المقدَّم خاصًا بعنصر CalendarEvent واحد، يتم عرض CalendarEventSeries يتضمّن حدثًا واحدًا في السلسلة. يُرجى العِلم أنّه إذا كانت سلسلة الأحداث تنتمي إلى تقويم غير التقويم التلقائي، يجب استدعاء هذه الطريقة منCalendar هذا. إنّ استدعاء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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

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

getEventsForDay(date)

تحصل على جميع الأحداث التي تحدث في يوم معيّن.

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

يُرجى العِلم أنّه يتم استخدام جزء التاريخ فقط من عنصر 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 ذات الصلة:

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

getEventsForDay(date, options)

تحصل على جميع الأحداث التي تحدث في يوم معيّن وتستوفي معايير محدّدة.

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

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

يُرجى العِلم أنّ الفلترة على 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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: المنطقة الزمنية، المحدّدة بالتنسيق "الطول" (على سبيل المثال، "أمريكا/نيويورك"، كما هو مُدرَج في Joda.org)

التفويض

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

  • 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);

الإرجاع

Boolean — true إذا كان التقويم مخفيًا في واجهة المستخدم، false إذا كان غير مخفي

التفويض

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

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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());

الإرجاع

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

التفويض

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

  • 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);

المعلمات

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

الإرجاع

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

التفويض

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

  • 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 ذات الصلة:

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

setHidden(hidden)

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

المعلمات

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

الإرجاع

Calendar - هذا التقويم لإنشاء سلسلة

التفويض

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

  • 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 ذات الصلة:

  • 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 ذات الصلة:

  • 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المنطقة الزمنية، المحدّدة بتنسيق "طويل" (مثل "أمريكا/نيويورك"، كما هو مُدرَج في Joda.org)

الإرجاع

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

التفويض

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

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

unsubscribeFromCalendar()

إلغاء اشتراك المستخدم في تقويم لا يمكن للمستخدم إلغاء الاشتراك في التقاويم المدرَجة ضمن قائمة تقاويمي. يمكنهم إلغاء الاشتراك في التقاويم المدرَجة ضمن تقاويم أخرى. 

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

// Unsubscribes the user from the calendar.
const result = calendar.unsubscribeFromCalendar();

عمليات الرمي

Error - إذا كان هذا تقويمًا تملكه

التفويض

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

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