Class CalendarApp

CalendarApp

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

أماكن إقامة

الموقعTypeالوصف
ColorColorتعداد يمثل الألوان المُعنوَنة المتاحة في خدمة "تقويم Google".
EventColorEventColorتعداد يمثّل ألوان الأحداث المُعنونة المتاحة في خدمة "تقويم Google".
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تحصل على التقويم باستخدام المعرّف المحدّد.
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الحصول على التقويم بالمعرّف المحدّد، إذا كان المستخدم يملكه.
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.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'));
Logger.log('Event ID: ' + event.getId());

المَعلمات

الاسمTypeالوصف
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.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'));
Logger.log('Event ID: ' + event.getId());

المَعلمات

الاسمTypeالوصف
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.
var 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());

المَعلمات

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

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

الاسمTypeالوصف
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.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'),
    {location: 'The Moon'});
Logger.log('Event ID: ' + event.getId());

المَعلمات

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

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

الاسمTypeالوصف
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.
var 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());

المَعلمات

الاسمTypeالوصف
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.
var 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());

المَعلمات

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

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

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

استرجاع الكرة

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

التفويض

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

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

createCalendar(name)

ينشئ تقويمًا جديدًا، يمتلكه المستخدم.

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

createCalendar(name, options)

ينشئ تقويمًا جديدًا، يمتلكه المستخدم.

// Creates a new calendar named "Travel Plans" with a summary and color.
var calendar = CalendarApp.createCalendar('Travel Plans', {
  summary: '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());

المَعلمات

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

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

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

استرجاع الكرة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات 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.
var 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());

المَعلمات

الاسمTypeالوصف
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.
var 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());

المَعلمات

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

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

الاسمTypeالوصف
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.
var event = CalendarApp.getDefaultCalendar()
    .createEventFromDescription('Lunch with Mary, Friday at 1PM');
Logger.log('Event ID: ' + event.getId());

المَعلمات

الاسمTypeالوصف
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.
var 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());

المَعلمات

الاسمTypeالوصف
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.
var 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());

المَعلمات

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

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

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

استرجاع الكرة

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

التفويض

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

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

getAllCalendars()

الحصول على جميع التقاويم التي يملكها المستخدم أو اشترك فيها

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

استرجاع الكرة

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

التفويض

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

  • 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.
var calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

استرجاع الكرة

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

التفويض

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

  • 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.
var calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com');
Logger.log('The calendar is named "%s".', calendar.getName());

المَعلمات

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

استرجاع الكرة

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

التفويض

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

  • 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".
var calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

المَعلمات

الاسمTypeالوصف
nameStringاسم التقويم

استرجاع الكرة

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

التفويض

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

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

  • 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.
var calendar = CalendarApp.getDefaultCalendar();
Logger.log('My default calendar is set to the time zone "%s".',
    calendar.getTimeZone());

استرجاع الكرة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات 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)

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

المَعلمات

الاسمTypeالوصف
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 مع حدث واحد في السلسلة. تجدر الإشارة إلى أنّه إذا كانت سلسلة الأحداث تنتمي إلى تقويم آخر غير التقويم التلقائي، يجب استدعاء هذه الطريقة من 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());

المَعلمات

الاسمTypeالوصف
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.
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log('Number of events: ' + events.length);

المَعلمات

الاسمTypeالوصف
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".
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow,
    {search: 'meeting'});
Logger.log('Number of events: ' + events.length);

المَعلمات

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

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

الاسمTypeالوصف
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)

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

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

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

// Determines how many events are happening today.
var today = new Date();
var events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log('Number of events: ' + events.length);

المَعلمات

الاسمTypeالوصف
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)

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

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

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

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

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

المَعلمات

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

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

الاسمTypeالوصف
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

getOwnedCalendarById(id)

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

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

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

المَعلمات

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

استرجاع الكرة

Calendar — التقويم الذي يتضمن المعرّف المحدّد، أو null إذا لم يكن التقويم متوفّرًا أو لا يملكه المستخدم

التفويض

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

  • 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".
var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

المَعلمات

الاسمTypeالوصف
nameStringاسم التقويم

استرجاع الكرة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات 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 — المنطقة الزمنية المحددة بتنسيق "طويل" (على سبيل المثال، "America/New_York" كما هو مدرج في 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());

استرجاع الكرة

Booleantrue إذا كنت أنت مالك التقويم، و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

newRecurrence()

إنشاء كائن تكرار جديد يمكن استخدامه لإنشاء قواعد لتكرار الحدث.

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
var 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 ذات الصلة:

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

المَعلمات

الاسمTypeالوصف
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.')

المَعلمات

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

استرجاع الكرة

Calendar — هذا التقويم للسلاسل

التفويض

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

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

setHidden(hidden)

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

المَعلمات

الاسمTypeالوصف
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');

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

الاسمTypeالوصف
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');

المَعلمات

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

استرجاع الكرة

Calendar — هذا التقويم للتسلسل.

التفويض

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

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

subscribeToCalendar(id)

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

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

المَعلمات

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

استرجاع الكرة

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

الرميات

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

التفويض

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

  • 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.
var calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
    { color: CalendarApp.Color.BLUE });
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

المَعلمات

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

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

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

استرجاع الكرة

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

الرميات

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

التفويض

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

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