Class Calendar

שיטה	סוג הערך המוחזר	תיאור קצר
`createAllDayEvent(title, date)`	`CalendarEvent`	יצירת אירוע חדש של יום שלם.
`createAllDayEvent(title, startDate, endDate)`	`CalendarEvent`	יצירת אירוע חדש של יום שלם שיכול להימשך כמה ימים.
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	יצירת אירוע חדש של יום שלם שיכול להימשך כמה ימים.
`createAllDayEvent(title, date, options)`	`CalendarEvent`	יצירת אירוע חדש של יום שלם.
`createAllDayEventSeries(title, startDate, recurrence)`	`CalendarEventSeries`	יצירת סדרה חדשה של אירועים של יום שלם.
`createAllDayEventSeries(title, startDate, recurrence, options)`	`CalendarEventSeries`	יצירת סדרה חדשה של אירועים של יום שלם.
`createEvent(title, startTime, endTime)`	`CalendarEvent`	ייווצר אירוע חדש.
`createEvent(title, startTime, endTime, options)`	`CalendarEvent`	ייווצר אירוע חדש.
`createEventFromDescription(description)`	`CalendarEvent`	יצירת אירוע מתיאור חופשי.
`createEventSeries(title, startTime, endTime, recurrence)`	`CalendarEventSeries`	יצירה של סדרת אירועים חדשה.
`createEventSeries(title, startTime, endTime, recurrence, options)`	`CalendarEventSeries`	יצירה של סדרת אירועים חדשה.
`deleteCalendar()`	`void`	היומן יימחק לתמיד.
`getColor()`	`String`	מקבל את הצבע של היומן.
`getDescription()`	`String`	קבלת התיאור של היומן.
`getEventById(iCalId)`	`CalendarEvent`	הפונקציה מקבלת את האירוע עם המזהה הנתון.
`getEventSeriesById(iCalId)`	`CalendarEventSeries`	הפונקציה מקבלת את סדרת האירועים עם המזהה הנתון.
`getEvents(startTime, endTime)`	`CalendarEvent[]`	הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון.
`getEvents(startTime, endTime, options)`	`CalendarEvent[]`	הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון ועומדים בקריטריונים שצוינו.
`getEventsForDay(date)`	`CalendarEvent[]`	הפונקציה מקבלת את כל האירועים שהתרחשו ביום נתון.
`getEventsForDay(date, options)`	`CalendarEvent[]`	הפונקציה מקבלת את כל האירועים שמתרחשים ביום נתון ועומדים בקריטריונים שצוינו.
`getId()`	`String`	הפונקציה מקבלת את המזהה של היומן.
`getName()`	`String`	הפונקציה מקבלת את שם היומן.
`getTimeZone()`	`String`	הפונקציה מקבלת את אזור הזמן של היומן.
`isHidden()`	`Boolean`	ההגדרה הזו קובעת אם היומן מוסתר בממשק המשתמש.
`isMyPrimaryCalendar()`	`Boolean`	קובע אם היומן הוא היומן הראשי של המשתמש האפקטיבי.
`isOwnedByMe()`	`Boolean`	מציין אם היומן בבעלותכם.
`isSelected()`	`Boolean`	קובעת אם האירועים של היומן יוצגו בממשק המשתמש.
`setColor(color)`	`Calendar`	הגדרת הצבע של היומן.
`setDescription(description)`	`Calendar`	מגדיר את התיאור של היומן.
`setHidden(hidden)`	`Calendar`	המדיניות הזו קובעת אם היומן גלוי בממשק המשתמש.
`setName(name)`	`Calendar`	מגדיר את שם היומן.
`setSelected(selected)`	`Calendar`	המדיניות הזו קובעת אם האירועים של היומן יוצגו בממשק המשתמש.
`setTimeZone(timeZone)`	`Calendar`	הגדרת אזור הזמן של היומן.
`unsubscribeFromCalendar()`	`void`	מבטל את ההרשמה של המשתמש ליומן.

`createAllDayEvent(title, date)`

יצירת אירוע חדש של יום שלם.

// Creates an all-day event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'));
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע.
`date`	`Date`	תאריך האירוע (מופיע רק היום; המערכת מתעלמת מהשעה).

חזרה

CalendarEvent – האירוע שנוצר.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createAllDayEvent(title, startDate, endDate)`

יצירת אירוע חדש של יום שלם שיכול להימשך כמה ימים.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'));
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע.
`startDate`	`Date`	התאריך שבו האירוע מתחיל (מופיע רק היום; המערכת מתעלמת מהשעה).
`endDate`	`Date`	התאריך שבו האירוע מסתיים (רק היום מופיע, המערכת מתעלמת מהשעה). תאריך הסיום הוא בלעדי.

חזרה

CalendarEvent – האירוע שנוצר.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createAllDayEvent(title, startDate, endDate, options)`

יצירת אירוע חדש של יום שלם שיכול להימשך כמה ימים.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
    {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true});
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע.
`startDate`	`Date`	התאריך שבו האירוע מתחיל (מופיע רק היום; המערכת מתעלמת מהשעה).
`endDate`	`Date`	התאריך שבו האירוע מסתיים (רק היום מופיע, המערכת מתעלמת מהשעה). תאריך הסיום הוא בלעדי.
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך.

פרמטרים מתקדמים

שם	סוג	תיאור
`description`	`String`	תיאור האירוע.
`location`	`String`	מיקום האירוע.
`guests`	`String`	רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים.
`sendInvites`	`Boolean`	הגדרה שקובעת אם לשלוח הזמנות באימייל (ברירת המחדל: `false`).

חזרה

CalendarEvent – האירוע שנוצר.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createAllDayEvent(title, date, options)`

יצירת אירוע חדש של יום שלם.

// Creates an all-day event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'),
    {location: 'The Moon'});
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע.
`date`	`Date`	תאריך האירוע (מופיע רק היום; המערכת מתעלמת מהשעה).
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך.

פרמטרים מתקדמים

שם	סוג	תיאור
`description`	`String`	תיאור האירוע.
`location`	`String`	מיקום האירוע.
`guests`	`String`	רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים.
`sendInvites`	`Boolean`	הגדרה שקובעת אם לשלוח הזמנות באימייל (ברירת המחדל: `false`).

חזרה

CalendarEvent – האירוע שנוצר.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createAllDayEventSeries(title, startDate, recurrence)`

יצירת סדרה חדשה של אירועים של יום שלם.

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

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירועים בסדרה
`startDate`	`Date`	התאריך של האירוע הראשון בסדרה (נעשה שימוש רק ביום; השעה היא המערכת מתעלמת מהצומת)
`recurrence`	`EventRecurrence`	הגדרות החזרה של סדרת האירועים

חזרה

CalendarEventSeries – סדרת האירועים שנוצרו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createAllDayEventSeries(title, startDate, recurrence, options)`

יצירת סדרה חדשה של אירועים של יום שלם.

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

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירועים בסדרה
`startDate`	`Date`	התאריך של האירוע הראשון בסדרה (נעשה שימוש רק ביום; השעה היא המערכת מתעלמת מהצומת)
`recurrence`	`EventRecurrence`	הגדרות החזרה של סדרת האירועים
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך

פרמטרים מתקדמים

שם	סוג	תיאור
`description`	`String`	תיאור האירועים בסדרה
`location`	`String`	מיקום האירועים בסדרה
`guests`	`String`	רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים באירועים בסדרה
`sendInvites`	`Boolean`	האם לשלוח הזמנות באימייל (ברירת מחדל: `false`)

חזרה

CalendarEventSeries – סדרת האירועים שנוצרו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createEvent(title, startTime, endTime)`

ייווצר אירוע חדש.

אם לא צוין אזור זמן, ערכי הזמן מפורשים בהקשר של אזור הזמן, שעשוי להיות שונה מאזור הזמן של היומן.

// Creates an event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 21, 1969 21:00:00 UTC'));
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע
`startTime`	`Date`	התאריך והשעה שבהם האירוע מתחיל
`endTime`	`Date`	התאריך והשעה שבהם האירוע יסתיים

חזרה

CalendarEvent – האירוע שנוצר

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createEvent(title, startTime, endTime, options)`

ייווצר אירוע חדש.

אם לא צוין אזור זמן, ערכי הזמן מפורשים בהקשר של אזור הזמן, שעשוי להיות שונה מאזור הזמן של היומן.

// Creates an event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 20, 1969 21:00:00 UTC'),
    {location: 'The Moon'});
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירוע
`startTime`	`Date`	התאריך והשעה שבהם האירוע מתחיל
`endTime`	`Date`	התאריך והשעה שבהם האירוע יסתיים
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך

פרמטרים מתקדמים

שם	סוג	תיאור
`description`	`String`	תיאור האירוע
`location`	`String`	מיקום האירוע
`guests`	`String`	רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים
`sendInvites`	`Boolean`	האם לשלוח הזמנות באימייל (ברירת מחדל: `false`)

חזרה

CalendarEvent – האירוע שנוצר

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createEventFromDescription(description)`

יצירת אירוע מתיאור חופשי.

התיאור צריך להיות בפורמט זהה לזה של התכונה הוספה מהירה בממשק המשתמש.

// Creates a new event and logs its ID.
var event = CalendarApp.getDefaultCalendar()
    .createEventFromDescription('Lunch with Mary, Friday at 1PM');
Logger.log('Event ID: ' + event.getId());

פרמטרים

שם	סוג	תיאור
`description`	`String`	תיאור חופשי של האירוע

חזרה

CalendarEvent – האירוע שנוצר

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createEventSeries(title, startTime, endTime, recurrence)`

יצירה של סדרת אירועים חדשה.

// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')));
Logger.log('Event Series ID: ' + eventSeries.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירועים בסדרה
`startTime`	`Date`	התאריך והשעה שבהם מתחיל האירוע הראשון בסדרה
`endTime`	`Date`	התאריך והשעה שבהם מסתיים האירוע הראשון בסדרה
`recurrence`	`EventRecurrence`	הגדרות החזרה של סדרת האירועים

חזרה

CalendarEventSeries – סדרת האירועים שנוצרו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`createEventSeries(title, startTime, endTime, recurrence, options)`

יצירה של סדרת אירועים חדשה.

// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
    {location: 'Conference Room'});
Logger.log('Event Series ID: ' + eventSeries.getId());

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם האירועים בסדרה
`startTime`	`Date`	התאריך והשעה שבהם מתחיל האירוע הראשון בסדרה
`endTime`	`Date`	התאריך והשעה שבהם מסתיים האירוע הראשון בסדרה
`recurrence`	`EventRecurrence`	הגדרות החזרה של סדרת האירועים
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך

פרמטרים מתקדמים

שם	סוג	תיאור
`description`	`String`	תיאור האירועים בסדרה
`location`	`String`	מיקום האירועים בסדרה
`guests`	`String`	רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים באירועים בסדרה
`sendInvites`	`Boolean`	האם לשלוח הזמנות באימייל (ברירת מחדל: `false`)

חזרה

CalendarEventSeries – סדרת האירועים שנוצרו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`deleteCalendar()`

היומן יימחק לתמיד. משתמש יכול למחוק רק יומן שבבעלותו.

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

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

קליעות

Error – אם מדובר ביומן מיובא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getColor()`

מקבל את הצבע של היומן.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

חזרה

String — מחרוזת הקסדצימלית של צבע (" #rrggbb").

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getDescription()`

קבלת התיאור של היומן.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

חזרה

String – התיאור של היומן הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEventById(iCalId)`

הפונקציה מקבלת את האירוע עם המזהה הנתון. אם הסדרה שייכת ליומן שונה מברירת המחדל של Google, צריך לקרוא לשיטה הזו מהיומן הזה. התקשרות אל 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 אם האירוע לא קיים או המשתמש לא ניתן לגשת אליו.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEventSeriesById(iCalId)`

הפונקציה מקבלת את סדרת האירועים עם המזהה הנתון. אם המזהה שניתן הוא עבור CalendarEvent בודד, אז מוחזר CalendarEventSeries עם אירוע אחד בסדרה. שימו לב שאם סדרת האירועים שייכת ליומן שאינו יומן ברירת המחדל, השיטה הזו חייבת להיות שנקראה מאותו Calendar; שיחה אל CalendarApp.getEventSeriesById(iCalId) הפונקציה מחזירה ישירות רק סדרת אירועים שמופיעה ביומן ברירת המחדל.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31, 2023.
const eventSeries = calendar.createEventSeries('Team meeting',
  new Date('Jan 1, 2023 13:00:00'),
  new Date('Jan 1, 2023 14:00:00'),
  CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')));

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

// Gets the event series by its ID and logs the series title to the console.
// For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) instead.
console.log(calendar.getEventSeriesById(iCalId).getTitle());

פרמטרים

שם	סוג	תיאור
`iCalId`	`String`	המזהה של סדרת האירועים.

חזרה

CalendarEventSeries – הסדרה עם המזהה הנתון, או null אם הסדרה לא קיימת או המשתמש לא ניתן לגשת אליו.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEvents(startTime, endTime)`

הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון.

השיטה הזו מחזירה אירועים שמתחילים בטווח הזמן הנתון, ומסתיימים בזמן טווח זמן, או להקיף את טווח הזמן. אם לא צוין אזור זמן, ערכי הזמן בהקשר של אזור הזמן של התסריט, שעשוי להיות שונה אזור הזמן של היומן.

// Determines how many events are happening in the next two hours.
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log('Number of events: ' + events.length);

פרמטרים

שם	סוג	תיאור
`startTime`	`Date`	תחילת טווח הזמן
`endTime`	`Date`	סוף טווח הזמן, לא כולל

חזרה

CalendarEvent[] – האירועים שמתרחשים בטווח הזמן

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEvents(startTime, endTime, options)`

הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון ועומדים בקריטריונים שצוינו.

השיטה הזו מחזירה אירועים שמתחילים בטווח הזמן הנתון ומסתיימים בטווח הזמן הזה טווח זמן, או שכולל את טווח הזמן. אם לא צוין אזור זמן, ערכי הזמן בהקשר של אזור הזמן של התסריט, שעשוי להיות שונה אזור הזמן של היומן.

חשוב לדעת שהסינון לפי author, search או statusFilters לוקח מקום אחרי החלת start ו-max. המשמעות היא שמספר האירועים שהוחזרו צריכים להיות פחות מ-max, למרות שאירועים נוספים עומדים בקריטריונים.

// Determines how many events are happening in the next two hours that contain the term
// "meeting".
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow,
    {search: 'meeting'});
Logger.log('Number of events: ' + events.length);

פרמטרים

שם	סוג	תיאור
`startTime`	`Date`	תחילת טווח הזמן
`endTime`	`Date`	סוף טווח הזמן, לא כולל
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך

פרמטרים מתקדמים

שם	סוג	תיאור
`start`	`Integer`	האינדקס של האירוע הראשון שמוחזר
`max`	`Integer`	המספר המקסימלי של אירועים שצריך להחזיר
`author`	`String`	כתובת אימייל שמשמשת לסינון התוצאות לפי יוצר האירוע
`search`	`String`	שאילתת חיפוש בטקסט מלא שמשמשת לסינון התוצאות
`statusFilters[]`	`GuestStatus`	מערך של סטטוסים שמשמשים לסינון התוצאות

חזרה

CalendarEvent[] – האירועים שמתקיימים בטווח הזמן ותואמים לקריטריונים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEventsForDay(date)`

הפונקציה מקבלת את כל האירועים שהתרחשו ביום נתון.

השיטה הזו מחזירה אירועים אם הם מתחילים במהלך יום נתון, מסתיימים במהלך יום, או את היום.

שימו לב שנעשה שימוש רק בחלק התאריך של האובייקט Date, והמערכת מתעלמת מהחלק של השעה. התאריך מתפרש כחצות באותו יום עד חצות ביום שלמחרת לפי לוח השנה תחום.

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

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך שבו יש לאחזר את האירועים (רק היום משמש, המערכת מתעלמת מהשעה)

חזרה

CalendarEvent[] – האירועים שמתרחשים בתאריך הנתון

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getEventsForDay(date, options)`

הפונקציה מקבלת את כל האירועים שמתרחשים ביום נתון ועומדים בקריטריונים שצוינו.

השיטה הזו מחזירה אירועים אם הם מתחילים במהלך יום נתון, מסתיימים במהלך יום, או את היום.

שימו לב שנעשה שימוש רק בחלק התאריך של האובייקט Date, והמערכת מתעלמת מהחלק של השעה. התאריך מתפרש כחצות באותו יום עד חצות ביום שלמחרת לפי לוח השנה תחום.

חשוב לדעת שהסינון לפי author, search או statusFilters לוקח מקום אחרי החלת start ו-max. המשמעות היא שמספר האירועים שהוחזרו צריכים להיות פחות מ-max, למרות שאירועים נוספים עומדים בקריטריונים.

// Determines how many events are happening today and contain the term "meeting".
var today = new Date();
var 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[] – האירועים שמתרחשים בתאריך הנתון ותואמים לקריטריונים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getId()`

הפונקציה מקבלת את המזהה של היומן. המזהה של יומן ברירת המחדל של המשתמש הוא כתובת האימייל שלו.

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the ID of the calendar and logs it to the console.
const calendarId = calendar.getId();
console.log(calendarId);

חזרה

String – מזהה היומן.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getName()`

הפונקציה מקבלת את שם היומן.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

חזרה

String – השם של היומן הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`getTimeZone()`

הפונקציה מקבלת את אזור הזמן של היומן.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

חזרה

String – אזור הזמן, מצוין בשדה 'long' פורמט (לדוגמה, 'America/New_York', כפי שנרשם מאת Joda.org).

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`isHidden()`

ההגדרה הזו קובעת אם היומן מוסתר בממשק המשתמש.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is hidden in the user interface and logs it to the console.
// For the default calendar, you can use CalendarApp.isHidden() instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

חזרה

Boolean — true אם היומן מוסתר בממשק המשתמש; false אם לא מדויק.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`isMyPrimaryCalendar()`

קובע אם היומן הוא היומן הראשי של המשתמש האפקטיבי.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

חזרה

Boolean — true אם היומן הוא יומן ברירת המחדל של המשתמש האפקטיבי; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`isOwnedByMe()`

מציין אם היומן בבעלותכם.

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

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

חזרה

Boolean — true אם היומן בבעלותך; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`isSelected()`

קובעת אם האירועים של היומן יוצגו בממשק המשתמש.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Determines whether the calendar's events are displayed in the user interface and logs it.
console.log(calendar.isSelected());

חזרה

Boolean — true אם האירועים של היומן מוצגים בממשק המשתמש; false אם לא

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setColor(color)`

הגדרת הצבע של היומן.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

פרמטרים

שם	סוג	תיאור
`color`	`String`	`CalendarApp.Color` או מחרוזת צבע הקסדצימלית (" #rrggbb").

חזרה

Calendar – היומן הזה ליצירת שרשורים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setDescription(description)`

מגדיר את התיאור של היומן.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.')

פרמטרים

שם	סוג	תיאור
`description`	`String`	התיאור של היומן הזה

חזרה

Calendar – היומן הזה לשרשורים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setHidden(hidden)`

המדיניות הזו קובעת אם היומן גלוי בממשק המשתמש.

פרמטרים

שם	סוג	תיאור
`hidden`	`Boolean`	`true` כדי להסתיר את היומן בממשק המשתמש; `false` כדי להציג אותו

חזרה

Calendar – היומן הזה לשרשורים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setName(name)`

מגדיר את שם היומן.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם החדש

חזרה

Calendar – היומן הזה לשרשורים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setSelected(selected)`

המדיניות הזו קובעת אם האירועים של היומן יוצגו בממשק המשתמש.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Selects the calendar so that its events are displayed in the user interface. To
// unselect the calendar, set the parameter to false.
calendar.setSelected(true);

פרמטרים

שם	סוג	תיאור
`selected`	`Boolean`	`true` כדי להציג את האירועים של היומן בממשק המשתמש; `false` כדי להסתיר אותם

חזרה

Calendar – היומן הזה לשרשורים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`setTimeZone(timeZone)`

הגדרת אזור הזמן של היומן.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

פרמטרים

שם	סוג	תיאור
`timeZone`	`String`	אזור הזמן, מצוין ב-'long' (כגון "America/New_York", רשום על ידי Joda.org).

חזרה

Calendar – היומן הזה ליצירת שרשורים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

`unsubscribeFromCalendar()`

מבטל את ההרשמה של המשתמש ליומן. המשתמש לא יכול לבטל את ההרשמה ליומנים שרשומים מתחת הרשימה היומנים שלי. הם יכולים לבטל את ההרשמה ליומנים שרשומים בקטע אחר יומנים.

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

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

קליעות

Error – אם מדובר ביומן בבעלות

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

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

שיטות

מסמכי תיעוד מפורטים

createAllDayEvent(title, date)

פרמטרים

חזרה

אישור

createAllDayEvent(title, startDate, endDate)

פרמטרים

חזרה

אישור

createAllDayEvent(title, startDate, endDate, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

createAllDayEvent(title, date, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

createAllDayEventSeries(title, startDate, recurrence)

פרמטרים

חזרה

אישור

createAllDayEventSeries(title, startDate, recurrence, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

createEvent(title, startTime, endTime)

פרמטרים

חזרה

אישור

createEvent(title, startTime, endTime, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

createEventFromDescription(description)

פרמטרים

חזרה

אישור

createEventSeries(title, startTime, endTime, recurrence)

פרמטרים

חזרה

אישור

createEventSeries(title, startTime, endTime, recurrence, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

deleteCalendar()

קליעות

אישור

getColor()

חזרה

אישור

getDescription()

חזרה

אישור

getEventById(iCalId)

פרמטרים

חזרה

אישור

getEventSeriesById(iCalId)

פרמטרים

חזרה

אישור

getEvents(startTime, endTime)

פרמטרים

חזרה

אישור

getEvents(startTime, endTime, options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

getEventsForDay(date)

פרמטרים

`createAllDayEvent(title, date)`

`createAllDayEvent(title, startDate, endDate)`

`createAllDayEvent(title, startDate, endDate, options)`

`createAllDayEvent(title, date, options)`

`createAllDayEventSeries(title, startDate, recurrence)`

`createAllDayEventSeries(title, startDate, recurrence, options)`

`createEvent(title, startTime, endTime)`

`createEvent(title, startTime, endTime, options)`

`createEventFromDescription(description)`

`createEventSeries(title, startTime, endTime, recurrence)`

`createEventSeries(title, startTime, endTime, recurrence, options)`

`deleteCalendar()`

`getColor()`

`getDescription()`

`getEventById(iCalId)`

`getEventSeriesById(iCalId)`

`getEvents(startTime, endTime)`

`getEvents(startTime, endTime, options)`

`getEventsForDay(date)`

`getEventsForDay(date, options)`

`getId()`

`getName()`

`getTimeZone()`

`isHidden()`

`isMyPrimaryCalendar()`

`isOwnedByMe()`

`isSelected()`

`setColor(color)`

`setDescription(description)`

`setHidden(hidden)`

`setName(name)`

`setSelected(selected)`

`setTimeZone(timeZone)`

`unsubscribeFromCalendar()`