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.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

פרמטרים

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
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 – האירוע שנוצר.

אישור

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

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

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

חזרה

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

אישור

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
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 — סדרת האירועים שנוצרה

אישור

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
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 — האירוע שנוצר

אישור

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

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

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

חזרה

‫CalendarEvent — האירוע שנוצר

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

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 — האירוע שנוצר

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
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 — סדרת האירועים שנוצרה

אישור

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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();

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם זה יומן מיובא.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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"‎).

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – התיאור של היומן.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

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

`getEventById(iCalId)`

מחזירה את האירוע עם המזהה הנתון. אם הסדרה שייכת ליומן אחר ולא ליומן ברירת המחדל, צריך להפעיל את השיטה הזו מהיומן הזה. הקריאה CalendarApp.getEventById(iCalId) מחזירה רק אירוע ביומן שמוגדר כברירת מחדל.

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

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

// Creates an event for the moon landing.
const event = calendar.createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:05:00 UTC'),
    new Date('July 20, 1969 20:17:00 UTC'),
);

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

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

פרמטרים

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

חזרה

‫CalendarEvent — האירוע עם המזהה שצוין, או null אם האירוע לא קיים או שלמשתמש אין גישה אליו.

אישור

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
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[] – האירועים שמתרחשים בטווח הזמן

אישור

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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.
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log(`Number of events: ${events.length}`);

פרמטרים

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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".
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[] — האירועים שמתרחשים בתאריך הנתון ועומדים בקריטריונים

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – המזהה של היומן.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – השם של היומן הזה.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – אזור הזמן, שצוין בפורמט 'ארוך' (לדוגמה, America/New_York, כמו שמופיע ב-Joda.org).

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 אם הוא לא מוסתר.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 אם לא.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 אם לא.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 אם לא

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – היומן הזה לשרשור.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – היומן הזה לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

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

`setHidden(hidden)`

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

פרמטרים

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – היומן הזה לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – היומן הזה לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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`	אזור הזמן, שמוגדר בפורמט 'ארוך' (למשל, America/New_York, כמו שמופיע ב-Joda.org).

חזרה

‫Calendar – היומן הזה לשרשור.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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();

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם זה יומן שבבעלותכם

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

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

Class Calendar קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

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

מקפיצה את הודעות השגיאה (Throws)

אישור

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