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

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`	اشتراک کاربر را از یک تقویم لغو می کند.

مستندات دقیق

`create All Day Event(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`	تاریخ رویداد (فقط روز استفاده می شود؛ زمان نادیده گرفته می شود).

بازگشت

Calendar Event - رویداد ایجاد شده.

مجوز

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

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

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

بازگشت

Calendar Event - رویداد ایجاد شده.

مجوز

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

`create All Day Event(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` ).

بازگشت

Calendar Event - رویداد ایجاد شده.

مجوز

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

`create All Day Event(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` ).

بازگشت

Calendar Event - رویداد ایجاد شده.

مجوز

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

`create All Day Event Series(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`	تنظیمات تکرار سری رویداد

بازگشت

Calendar Event Series - مجموعه رویدادهای ایجاد شده

مجوز

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

`create All Day Event Series(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` )

بازگشت

Calendar Event Series - مجموعه رویدادهای ایجاد شده

مجوز

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

`create Event(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`	تاریخ و ساعت پایان رویداد

بازگشت

Calendar Event - رویداد ایجاد شده

مجوز

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

`create Event(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` )

بازگشت

Calendar Event - رویداد ایجاد شده

مجوز

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

`create Event From Description(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`	شرحی آزاد از رویداد

بازگشت

Calendar Event - رویداد ایجاد شده

مجوز

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

`create Event Series(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`	تنظیمات تکرار سری رویداد

بازگشت

Calendar Event Series - مجموعه رویدادهای ایجاد شده

مجوز

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

`create Event Series(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` )

بازگشت

Calendar Event Series - مجموعه رویدادهای ایجاد شده

مجوز

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

`delete Calendar()`

تقویم را برای همیشه حذف می کند. کاربر فقط می تواند تقویمی را که متعلق به خود است حذف کند.

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

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

پرتاب می کند

Error - اگر این یک تقویم وارد شده است.

مجوز

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

`get Color()`

رنگ تقویم را می گیرد.

// 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

`get Description()`

توضیحات تقویم را دریافت می کند.

// 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

`get Event By Id(iCalId)`

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

بازگشت

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

مجوز

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

`get Event Series By Id(iCalId)`

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

بازگشت

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

مجوز

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

`get Events(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`	پایان محدوده زمانی، غیر فراگیر

بازگشت

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

مجوز

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

`get Events(startTime, endTime, options)`

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

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

توجه داشته باشید که فیلتر کردن روی فیلترهای author ، search یا status Filters پس از اعمال 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`	مجموعه ای از وضعیت ها که برای فیلتر کردن نتایج استفاده می شود

بازگشت

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

مجوز

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

`get Events For Day(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`	تاریخ بازیابی رویدادها (فقط روز استفاده می شود، زمان نادیده گرفته می شود)

بازگشت

Calendar Event[] - رویدادهایی که در تاریخ معین رخ می دهند

مجوز

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

`get Events For Day(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`	یک عبارت جستجوی متن کامل که برای فیلتر کردن نتایج استفاده می شود
`status Filters[]`	`Guest Status`	مجموعه ای از وضعیت ها که برای فیلتر کردن نتایج استفاده می شود

بازگشت

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

مجوز

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

`get Id()`

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

// 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

`get Name()`

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

// 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

`get Time Zone()`

منطقه زمانی تقویم را دریافت می کند.

// 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

`is Hidden()`

تعیین می کند که آیا تقویم در رابط کاربری پنهان است یا خیر.

// 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

`is My Primary Calendar()`

تعیین می کند که آیا تقویم تقویم اولیه برای کاربر موثر است یا خیر.

// 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

`is Owned By Me()`

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

// 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

`is Selected()`

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

// 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

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

مجوز

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

`set Description(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

`set Hidden(hidden)`

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

پارامترها

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

بازگشت

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

مجوز

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

`set Name(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

`set Selected(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

`set Time Zone(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 - این تقویم برای زنجیر کردن.

مجوز

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

`unsubscribe From Calendar()`

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

// 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 - اگر این یک تقویم متعلق به شما باشد

مجوز

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

Class Calendar با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

روش ها

مستندات دقیق

create All Day Event(title, date)

پارامترها

بازگشت

مجوز

create All Day Event(title, startDate, endDate)

پارامترها

بازگشت

مجوز

create All Day Event(title, startDate, endDate, options)

پارامترها

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

بازگشت

مجوز

create All Day Event(title, date, options)

پارامترها

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

بازگشت

مجوز

create All Day Event Series(title, startDate, recurrence)

پارامترها

بازگشت

مجوز

create All Day Event Series(title, startDate, recurrence, options)

پارامترها

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

بازگشت

مجوز

create Event(title, startTime, endTime)

پارامترها

بازگشت

مجوز

create Event(title, startTime, endTime, options)

پارامترها

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

بازگشت

مجوز

create Event From Description(description)

پارامترها

بازگشت

مجوز

create Event Series(title, startTime, endTime, recurrence)

پارامترها

بازگشت

مجوز

create Event Series(title, startTime, endTime, recurrence, options)

پارامترها

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

بازگشت

مجوز

delete Calendar()

پرتاب می کند

مجوز

get Color()

بازگشت

مجوز

get Description()

بازگشت

مجوز

get Event By Id(iCalId)

پارامترها

بازگشت

مجوز

get Event Series By Id(iCalId)

پارامترها

بازگشت

مجوز

get Events(startTime, endTime)

پارامترها

بازگشت

مجوز

get Events(startTime, endTime, options)

پارامترها

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

بازگشت

مجوز

get Events For Day(date)

پارامترها

Class Calendar

`create All Day Event(title, date)`

`create All Day Event(title, startDate, endDate)`

`create All Day Event(title, startDate, endDate, options)`

`create All Day Event(title, date, options)`

`create All Day Event Series(title, startDate, recurrence)`

`create All Day Event Series(title, startDate, recurrence, options)`

`create Event(title, startTime, endTime)`

`create Event(title, startTime, endTime, options)`

`create Event From Description(description)`

`create Event Series(title, startTime, endTime, recurrence)`

`create Event Series(title, startTime, endTime, recurrence, options)`

`delete Calendar()`

`get Color()`

`get Description()`

`get Event By Id(iCalId)`

`get Event Series By Id(iCalId)`

`get Events(startTime, endTime)`

`get Events(startTime, endTime, options)`

`get Events For Day(date)`

`get Events For Day(date, options)`

`get Id()`

`get Name()`

`get Time Zone()`

`is Hidden()`

`is My Primary Calendar()`

`is Owned By Me()`

`is Selected()`

`set Color(color)`

`set Description(description)`

`set Hidden(hidden)`

`set Name(name)`

`set Selected(selected)`

`set Time Zone(timeZone)`

`unsubscribe From Calendar()`