Class Calendar

تقویم

نشان‌دهنده تقویمی است که کاربر مالک آن است یا در آن مشترک شده است.

روش‌ها

روش نوع بازگشتی شرح مختصر
create All Day Event(title, date) Calendar Event یک رویداد تمام روز جدید ایجاد می‌کند.
create All Day Event(title, startDate, endDate) Calendar Event یک رویداد تمام روز جدید ایجاد می‌کند که می‌تواند چندین روز طول بکشد.
create All Day Event(title, startDate, endDate, options) Calendar Event یک رویداد تمام روز جدید ایجاد می‌کند که می‌تواند چندین روز طول بکشد.
create All Day Event(title, date, options) Calendar Event یک رویداد تمام روز جدید ایجاد می‌کند.
create All Day Event Series(title, startDate, recurrence) Calendar Event Series یک سری رویداد جدید تمام روز ایجاد می‌کند.
create All Day Event Series(title, startDate, recurrence, options) Calendar Event Series یک سری رویداد جدید تمام روز ایجاد می‌کند.
create Event(title, startTime, endTime) Calendar Event یک رویداد جدید ایجاد می‌کند.
create Event(title, startTime, endTime, options) Calendar Event یک رویداد جدید ایجاد می‌کند.
create Event From Description(description) Calendar Event یک رویداد را از یک توصیف آزاد ایجاد می‌کند.
create Event Series(title, startTime, endTime, recurrence) Calendar Event Series یک سری رویداد جدید ایجاد می‌کند.
create Event Series(title, startTime, endTime, recurrence, options) Calendar Event Series یک سری رویداد جدید ایجاد می‌کند.
delete Calendar() void تقویم را برای همیشه حذف می‌کند.
get Color() String رنگ تقویم را به خود می‌گیرد.
get Description() String توضیحات تقویم را دریافت می‌کند.
get Event By Id(iCalId) Calendar Event رویداد را با شناسه‌ی داده شده دریافت می‌کند.
get Event Series By Id(iCalId) Calendar Event Series سری رویدادها را با شناسه داده شده دریافت می‌کند.
get Events(startTime, endTime) Calendar Event[] تمام رویدادهایی را که در یک محدوده زمانی مشخص رخ می‌دهند، دریافت می‌کند.
get Events(startTime, endTime, options) Calendar Event[] تمام رویدادهایی را که در یک محدوده زمانی مشخص رخ می‌دهند و معیارهای مشخص شده را برآورده می‌کنند، دریافت می‌کند.
get Events For Day(date) Calendar Event[] تمام رویدادهایی را که در یک روز مشخص رخ می‌دهند، دریافت می‌کند.
get Events For Day(date, options) Calendar Event[] تمام رویدادهایی را که در یک روز مشخص رخ می‌دهند و معیارهای مشخصی را برآورده می‌کنند، دریافت می‌کند.
get Id() String شناسه تقویم را دریافت می‌کند.
get Name() String نام تقویم را دریافت می‌کند.
get Time Zone() String منطقه زمانی تقویم را دریافت می‌کند.
is Hidden() Boolean تعیین می‌کند که آیا تقویم در رابط کاربری پنهان است یا خیر.
is My Primary Calendar() Boolean تعیین می‌کند که آیا تقویم، تقویم اصلی برای کاربر فعال است یا خیر.
is Owned By Me() Boolean مشخص می‌کند که آیا تقویم متعلق به شماست یا خیر.
is Selected() Boolean تعیین می‌کند که آیا رویدادهای تقویم در رابط کاربری نمایش داده شوند یا خیر.
set Color(color) Calendar رنگ تقویم را تنظیم می‌کند.
set Description(description) Calendar توضیحات یک تقویم را تنظیم می‌کند.
set Hidden(hidden) Calendar تنظیم می‌کند که آیا تقویم در رابط کاربری قابل مشاهده باشد یا خیر.
set Name(name) Calendar نام تقویم را تنظیم می‌کند.
set Selected(selected) Calendar تعیین می‌کند که آیا رویدادهای تقویم در رابط کاربری نمایش داده شوند یا خیر.
set Time Zone(timeZone) Calendar منطقه زمانی تقویم را تنظیم می‌کند.
unsubscribe From Calendar() 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()}`);

پارامترها

نام نوع توضیحات
title String عنوان رویداد.
date Date تاریخ رویداد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود).

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویداد.
start Date Date تاریخ شروع رویداد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود).
end Date Date تاریخی که رویداد در آن پایان می‌یابد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود). تاریخ پایان انحصاری است.

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویداد.
start Date Date تاریخ شروع رویداد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود).
end Date Date تاریخی که رویداد در آن پایان می‌یابد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود). تاریخ پایان انحصاری است.
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته‌ای را مطابق لیست زیر مشخص می‌کند.

پارامترهای پیشرفته

نام نوع توضیحات
description String شرح رویداد.
location String محل برگزاری رویداد.
guests String فهرستی از آدرس‌های ایمیل که باید به عنوان مهمان اضافه شوند و با ویرگول از هم جدا شده‌اند.
send Invites Boolean آیا ایمیل‌های دعوت ارسال شود یا خیر (پیش‌فرض: 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()}`);

پارامترها

نام نوع توضیحات
title String عنوان رویداد.
date Date تاریخ رویداد (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود).
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته‌ای را مطابق لیست زیر مشخص می‌کند.

پارامترهای پیشرفته

نام نوع توضیحات
description String شرح رویداد.
location String محل برگزاری رویداد.
guests String فهرستی از آدرس‌های ایمیل که باید به عنوان مهمان اضافه شوند و با ویرگول از هم جدا شده‌اند.
send Invites Boolean آیا ایمیل‌های دعوت ارسال شود یا خیر (پیش‌فرض: 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()}`);

پارامترها

نام نوع توضیحات
title String عنوان رویدادهای این مجموعه
start Date Date تاریخ اولین رویداد در این مجموعه (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود)
recurrence Event Recurrence تنظیمات تکرار سری رویدادها

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویدادهای این مجموعه
start Date Date تاریخ اولین رویداد در این مجموعه (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود)
recurrence Event Recurrence تنظیمات تکرار سری رویدادها
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام نوع توضیحات
description String شرح وقایع سریال
location String مکان وقوع وقایع در سریال
guests String فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند و باید به عنوان مهمان به رویدادهای این مجموعه اضافه شوند
send Invites Boolean آیا ایمیل‌های دعوت ارسال شود یا خیر (پیش‌فرض: false )

بازگشت

CalendarEventSeries — مجموعه رویدادهای ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از 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()}`);

پارامترها

نام نوع توضیحات
title String عنوان رویداد
start Time Date تاریخ و زمان شروع رویداد
end Time Date تاریخ و زمان پایان رویداد

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویداد
start Time Date تاریخ و زمان شروع رویداد
end Time Date تاریخ و زمان پایان رویداد
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام نوع توضیحات
description String شرح رویداد
location String محل رویداد
guests String فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند و باید به عنوان مهمان اضافه شوند
send Invites Boolean آیا ایمیل‌های دعوت ارسال شود یا خیر (پیش‌فرض: 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()}`);

پارامترها

نام نوع توضیحات
description String شرح آزاد رویداد

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویدادهای این مجموعه
start Time Date تاریخ و زمان شروع اولین رویداد در این مجموعه
end Time Date تاریخ و زمان پایان اولین رویداد در این مجموعه
recurrence Event Recurrence تنظیمات تکرار سری رویدادها

بازگشت

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

پارامترها

نام نوع توضیحات
title String عنوان رویدادهای این مجموعه
start Time Date تاریخ و زمان شروع اولین رویداد در این مجموعه
end Time Date تاریخ و زمان پایان اولین رویداد در این مجموعه
recurrence Event Recurrence تنظیمات تکرار سری رویدادها
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام نوع توضیحات
description String شرح وقایع سریال
location String مکان وقوع وقایع در سریال
guests String فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند و باید به عنوان مهمان به رویدادهای این مجموعه اضافه شوند
send Invites Boolean آیا ایمیل‌های دعوت ارسال شود یا خیر (پیش‌فرض: false )

بازگشت

CalendarEventSeries — مجموعه رویدادهای ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • 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 API مرتبط دارند:

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

رویداد را با شناسه‌ی داده شده دریافت می‌کند. اگر سری زمانی متعلق به تقویمی غیر از تقویم پیش‌فرض باشد، این متد باید از آن تقویم فراخوانی شود. فراخوانی 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());

پارامترها

نام نوع توضیحات
iCalId String شناسنامه رویداد.

بازگشت

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 با یک رویداد واحد در آن سری بازگردانده می‌شود. توجه داشته باشید که اگر سری رویدادها متعلق به تقویمی غیر از تقویم پیش‌فرض باشد، این متد باید از آن 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());

پارامترها

نام نوع توضیحات
iCalId String شناسه مجموعه رویدادها.

بازگشت

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}`);

پارامترها

نام نوع توضیحات
start Time Date شروع محدوده زمانی
end Time Date پایان محدوده زمانی، غیر فراگیر

بازگشت

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}`);

پارامترها

نام نوع توضیحات
start Time Date شروع محدوده زمانی
end Time Date پایان محدوده زمانی، غیر فراگیر
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام نوع توضیحات
start Integer شاخص اولین رویدادی که برمی‌گردد
max Integer حداکثر تعداد رویدادهایی که باید برگردانده شوند
author String آدرس ایمیلی که برای فیلتر کردن نتایج توسط ایجادکننده رویداد استفاده می‌شود
search String یک عبارت جستجوی متن کامل که برای فیلتر کردن نتایج استفاده می‌شود
status Filters[] Guest Status آرایه‌ای از وضعیت‌ها که برای فیلتر کردن نتایج استفاده می‌شود

بازگشت

CalendarEvent[] — رویدادهایی که در محدوده زمانی اتفاق می‌افتند و با معیارها مطابقت دارند

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

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

پارامترها

نام نوع توضیحات
date Date تاریخ بازیابی رویدادها (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود)

بازگشت

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)

تمام رویدادهایی را که در یک روز مشخص رخ می‌دهند و معیارهای مشخصی را برآورده می‌کنند، دریافت می‌کند.

این متد رویدادهایی را برمی‌گرداند که در طول روز مشخص شروع شده باشند، در طول روز پایان یافته باشند یا کل روز را در بر گرفته باشند.

توجه داشته باشید که فقط بخش تاریخ شیء 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}`);

پارامترها

نام نوع توضیحات
date Date تاریخ بازیابی رویدادها (فقط روز استفاده می‌شود؛ زمان نادیده گرفته می‌شود)
options Object گزینه‌های فیلتر پیشرفته

پارامترهای پیشرفته

نام نوع توضیحات
start Integer شاخص اولین رویدادی که برمی‌گردد
max Integer حداکثر تعداد رویدادهایی که باید برگردانده شوند
author String آدرس ایمیلی که برای فیلتر کردن نتایج توسط ایجادکننده رویداد استفاده می‌شود
search String یک عبارت جستجوی متن کامل که برای فیلتر کردن نتایج استفاده می‌شود
status Filters[] Guest Status آرایه‌ای از وضعیت‌ها که برای فیلتر کردن نتایج استفاده می‌شود

بازگشت

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

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

بازگشت

Boolean - اگر تقویم در رابط کاربری پنهان باشد، true و اگر نباشد 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());

بازگشت

Boolean - اگر رویدادهای تقویم در رابط کاربری نمایش داده شوند، true و در غیر این صورت false

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از 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);

پارامترها

نام نوع توضیحات
color String یک Calendar App.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.');

پارامترها

نام نوع توضیحات
description String توضیحات این تقویم

بازگشت

Calendar — این تقویم برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

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

setHidden(hidden)

تنظیم می‌کند که آیا تقویم در رابط کاربری قابل مشاهده باشد یا خیر.

پارامترها

نام نوع توضیحات
hidden Boolean برای مخفی کردن تقویم در رابط کاربری true و برای نمایش آن 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');

پارامترها

نام نوع توضیحات
name String نام جدید

بازگشت

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

پارامترها

نام نوع توضیحات
selected Boolean برای نمایش رویدادهای تقویم در رابط کاربری true و برای پنهان کردن آنها 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');

پارامترها

نام نوع توضیحات
time Zone String منطقه زمانی، که با فرمت "طولانی" مشخص شده است (مانند "America/New_York"، همانطور که توسط Joda.org فهرست شده است).

بازگشت

Calendar — این تقویم برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • 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 API مرتبط دارند:

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