این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class CalendarApp

به یک اسکریپت اجازه می دهد تا تقویم Google کاربر را بخواند و به روز کند. این کلاس دسترسی مستقیم به تقویم پیش‌فرض کاربر و همچنین امکان بازیابی تقویم‌های اضافی را که کاربر مالک یا مشترک آنهاست، فراهم می‌کند.

خواص

اموال	تایپ کنید	توضیحات
`Color`	`Color`	شماره ای که رنگ های نامگذاری شده موجود در سرویس Calendar را نشان می دهد.
`EventColor`	`EventColor`	شماره ای که رنگ های رویداد نامگذاری شده موجود در سرویس Calendar را نشان می دهد.
`EventType`	`EventType`	شمارش `EventType` .
`GuestStatus`	`GuestStatus`	یک عدد نشان دهنده وضعیت هایی است که یک مهمان می تواند برای یک رویداد داشته باشد.
`Month`	`Month`	عددی که نشان دهنده ماه های سال است.
`Visibility`	`Visibility`	یک عدد که نمایانگر قابل مشاهده بودن یک رویداد است.
`Weekday`	`Weekday`	شماره ای که نشان دهنده روزهای هفته است.

روش ها

روش	نوع برگشت	شرح مختصر
`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.
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`	عنوان رویداد.
`startDate`	`Date`	تاریخ شروع رویداد (فقط از روز استفاده می شود؛ زمان نادیده گرفته می شود).
`endDate`	`Date`	تاریخ پایان رویداد (فقط از روز استفاده می شود؛ زمان نادیده گرفته می شود). تاریخ پایان منحصر به فرد است.

بازگشت

CalendarEvent - رویداد ایجاد شده.

مجوز

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`	عنوان رویداد.
`startDate`	`Date`	تاریخ شروع رویداد (فقط از روز استفاده می شود؛ زمان نادیده گرفته می شود).
`endDate`	`Date`	تاریخ پایان رویداد (فقط از روز استفاده می شود؛ زمان نادیده گرفته می شود). تاریخ پایان منحصر به فرد است.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

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

بازگشت

CalendarEvent - رویداد ایجاد شده.

مجوز

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`	فهرستی از آدرس‌های ایمیل جدا شده با کاما که باید به عنوان مهمان اضافه شوند.
`sendInvites`	`Boolean`	ارسال ایمیل دعوت (پیش‌فرض: `false` ).

بازگشت

CalendarEvent - رویداد ایجاد شده.

مجوز

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`	عنوان رویدادهای سریال
`startDate`	`Date`	تاریخ اولین رویداد در مجموعه (فقط روز استفاده می شود؛ زمان نادیده گرفته می شود)
`recurrence`	`EventRecurrence`	تنظیمات تکرار سری رویداد

بازگشت

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

مجوز

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`	عنوان رویدادهای سریال
`startDate`	`Date`	تاریخ اولین رویداد در مجموعه (فقط روز استفاده می شود؛ زمان نادیده گرفته می شود)
`recurrence`	`EventRecurrence`	تنظیمات تکرار سری رویداد
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

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

بازگشت

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

مجوز

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

`createCalendar(name)`

یک تقویم جدید، متعلق به کاربر ایجاد می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام تقویم جدید

بازگشت

Calendar - تقویم تازه ایجاد شده

مجوز

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

`createCalendar(name, options)`

یک تقویم جدید، متعلق به کاربر ایجاد می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام تقویم جدید
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

نام	تایپ کنید	توضیحات
`location`	`String`	مکان تقویم
`description`	`String`	توضیحات تقویم
`timeZone`	`String`	منطقه زمانی برای تنظیم تقویم، مشخص شده در قالب "طولانی" (به عنوان مثال، "America/New_York"، همانطور که توسط Joda.org فهرست شده است)
`color`	`String`	یک رشته رنگی هگزادسیمال ("#rrggbb") یا یک مقدار از `CalendarApp.Colors`
`hidden`	`Boolean`	آیا تقویم در رابط کاربری پنهان است (پیش‌فرض: `false` )
`selected`	`Boolean`	آیا رویدادهای تقویم در رابط کاربری نمایش داده می شوند (پیش فرض: `true` )

بازگشت

Calendar - تقویم تازه ایجاد شده

مجوز

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`	عنوان رویداد
`startTime`	`Date`	تاریخ و زمان شروع رویداد
`endTime`	`Date`	تاریخ و ساعت پایان رویداد

بازگشت

CalendarEvent - رویداد ایجاد شده

مجوز

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`	عنوان رویداد
`startTime`	`Date`	تاریخ و زمان شروع رویداد
`endTime`	`Date`	تاریخ و ساعت پایان رویداد
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

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

بازگشت

CalendarEvent - رویداد ایجاد شده

مجوز

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 - رویداد ایجاد شده

مجوز

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`	عنوان رویدادهای سریال
`startTime`	`Date`	تاریخ و زمانی که اولین رویداد در مجموعه شروع می شود
`endTime`	`Date`	تاریخ و زمانی که اولین رویداد در مجموعه به پایان می رسد
`recurrence`	`EventRecurrence`	تنظیمات تکرار سری رویداد

بازگشت

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

مجوز

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`	عنوان رویدادهای سریال
`startTime`	`Date`	تاریخ و زمانی که اولین رویداد در مجموعه شروع می شود
`endTime`	`Date`	تاریخ و زمانی که اولین رویداد در مجموعه به پایان می رسد
`recurrence`	`EventRecurrence`	تنظیمات تکرار سری رویداد
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

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

بازگشت

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

مجوز

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

`getAllCalendars()`

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

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

بازگشت

Calendar[] - همه تقویم هایی که کاربر می تواند به آنها دسترسی داشته باشد

مجوز

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

`getAllOwnedCalendars()`

همه تقویم هایی را که کاربر در اختیار دارد دریافت می کند.

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

بازگشت

Calendar[] - همه تقویم هایی که کاربر در اختیار دارد

مجوز

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

`getCalendarById(id)`

تقویم را با شناسه داده شده دریافت می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه تقویم

بازگشت

Calendar - تقویم با شناسه داده شده، یا اگر تقویم وجود نداشته باشد، اگر کاربر نتواند به آن دسترسی داشته باشد، یا اگر کاربر مشترک تقویم نباشد، null .

مجوز

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

`getCalendarsByName(name)`

همه تقویم‌ها را با نام مشخصی که کاربر مالک یا مشترک آن است، دریافت می‌کند. نام ها به حروف بزرگ و کوچک حساس نیستند.

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

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام تقویم

بازگشت

Calendar[] - همه تقویم هایی با این نام که کاربر می تواند به آنها دسترسی داشته باشد

مجوز

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").

مجوز

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

`getDefaultCalendar()`

تقویم پیش فرض کاربر را دریافت می کند.

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

بازگشت

Calendar - تقویم پیش فرض کاربر

مجوز

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 - شرح این تقویم.

مجوز

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

پارامترها

نام	تایپ کنید	توضیحات
`iCalId`	`String`	شناسه رویداد

بازگشت

CalendarEvent - رویدادی با شناسه داده شده، یا اگر رویداد وجود نداشته باشد یا کاربر نتواند به آن دسترسی داشته باشد، null .

مجوز

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

پارامترها

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

بازگشت

CalendarEventSeries - مجموعه ای با شناسه داده شده، یا اگر سری وجود نداشته باشد یا کاربر نتواند به آن دسترسی داشته باشد، null .

مجوز

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

پارامترها

نام	تایپ کنید	توضیحات
`startTime`	`Date`	شروع محدوده زمانی
`endTime`	`Date`	پایان محدوده زمانی، غیر فراگیر

بازگشت

CalendarEvent[] - رویدادهایی که در محدوده زمانی رخ می دهند

مجوز

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

پارامترها

نام	تایپ کنید	توضیحات
`startTime`	`Date`	شروع محدوده زمانی
`endTime`	`Date`	پایان محدوده زمانی، غیر فراگیر
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

نام	تایپ کنید	توضیحات
`start`	`Integer`	شاخص اولین رویدادی که برمی گردد
`max`	`Integer`	حداکثر تعداد رویداد برای بازگشت
`author`	`String`	یک آدرس ایمیل که برای فیلتر کردن نتایج توسط سازنده رویداد استفاده می شود
`search`	`String`	یک عبارت جستجوی متن کامل که برای فیلتر کردن نتایج استفاده می شود
`statusFilters[]`	`GuestStatus`	مجموعه ای از وضعیت ها که برای فیلتر کردن نتایج استفاده می شود

بازگشت

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

مجوز

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[] - رویدادهایی که در تاریخ معین رخ می دهند

مجوز

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

`getEventsForDay(date, options)`

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

// 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`	یک عبارت جستجوی متن کامل که برای فیلتر کردن نتایج استفاده می شود
`statusFilters[]`	`GuestStatus`	مجموعه ای از وضعیت ها که برای فیلتر کردن نتایج استفاده می شود

بازگشت

CalendarEvent[] - رویدادهایی که در تاریخ معین رخ می دهند و با معیارها مطابقت دارند

مجوز

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 - شناسه تقویم.

مجوز

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 - نام این تقویم.

مجوز

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

`getOwnedCalendarById(id)`

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

برای پیدا کردن شناسه تقویم، روی فلش کنار نام تقویم در Google Calendar کلیک کنید و تنظیمات تقویم را انتخاب کنید. شناسه در نزدیکی پایین صفحه تنظیمات نشان داده شده است.

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

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه تقویم

بازگشت

Calendar - تقویم با شناسه داده شده، یا اگر تقویم وجود نداشته باشد یا کاربر مالک آن نباشد، null .

مجوز

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

`getOwnedCalendarsByName(name)`

همه تقویم‌ها را با نام مشخصی که کاربر دارد دریافت می‌کند. نام ها به حروف بزرگ و کوچک حساس نیستند.

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

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام تقویم

بازگشت

Calendar[] - همه تقویم‌هایی با این نام که کاربر مالک آن است

مجوز

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 فهرست شده است).

مجوز

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

مجوز

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

مجوز

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 اگر نه

مجوز

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 اگر نه

مجوز

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

`newRecurrence()`

یک شیء تکراری جدید ایجاد می کند که می تواند برای ایجاد قوانینی برای تکرار رویداد استفاده شود.

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

بازگشت

EventRecurrence - یک شیء تکراری جدید بدون تنظیم قوانین (به عنوان یک عود هفتگی رفتار می کند)

مجوز

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`	یک `CalendarApp.Color` یا یک رشته رنگی هگزادسیمال ("#rrggbb").

بازگشت

Calendar - این تقویم برای زنجیر کردن.

مجوز

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 - این تقویم برای زنجیر کردن

مجوز

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

`setHidden(hidden)`

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

پارامترها

نام	تایپ کنید	توضیحات
`hidden`	`Boolean`	`true` برای مخفی کردن تقویم در رابط کاربری؛ `false` برای نشان دادن آن

بازگشت

Calendar - این تقویم برای زنجیر کردن

مجوز

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 - این تقویم برای زنجیر کردن

مجوز

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 - این تقویم برای زنجیر کردن

مجوز

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

پارامترها

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

بازگشت

Calendar - این تقویم برای زنجیر کردن.

مجوز

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

`subscribeToCalendar(id)`

در صورتی که کاربر مجاز به اشتراک باشد، کاربر را با شناسه داده شده در تقویم مشترک می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه تقویم برای مشترک شدن

بازگشت

Calendar - تقویمی که به تازگی در تقویم مشترک شده است

پرتاب می کند

Error - اگر تقویمی با این شناسه وجود نداشته باشد

مجوز

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

`subscribeToCalendar(id, options)`

در صورتی که کاربر مجاز به اشتراک باشد، کاربر را با شناسه داده شده در تقویم مشترک می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه تقویم برای اشتراک.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	توضیحات
`color`	`String`	یک رشته رنگ هگزادسیمال ("#rrggbb") یا یک مقدار از `CalendarApp.Colors` .
`hidden`	`Boolean`	اینکه آیا تقویم در رابط کاربری پنهان است (پیش‌فرض: `false` ).
`selected`	`Boolean`	آیا رویدادهای تقویم در رابط کاربری نمایش داده می‌شوند (پیش‌فرض: اگر `color` نیز مشخص شده باشد `true` ، در غیر این صورت `false` ).

بازگشت

Calendar - تقویمی که به تازگی مشترک شده است.

پرتاب می کند

Error - اگر تقویمی با این شناسه وجود نداشته باشد

مجوز

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