דף זה תורגם על ידי Cloud Translation API.

Class CalendarApp

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

מאפיינים

נכס	סוג	תיאור
`Color`	`Color`	enum שמייצג את הצבעים הזמינים בשירות יומן Google.
`EventColor`	`EventColor`	enum שמייצג את צבעים האירועים הנתונים שזמינים בשירות יומן Google.
`EventType`	`EventType`	המניין `EventType`.
`GuestStatus`	`GuestStatus`	enum שמייצג את הסטטוסים שאורחים יכולים להיות להם באירוע.
`Month`	`Month`	enum שמייצג את החודשים בשנה.
`Visibility`	`Visibility`	enum שמייצג את רמת החשיפה של אירוע.
`Weekday`	`Weekday`	מאפיין enum שמייצג את ימי השבוע.

Methods

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

מסמכים מפורטים

`createAllDayEvent(title, date)`

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

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

פרמטרים

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

חזרה

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

אישור

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

אישור

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

אישור

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

אישור

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

`createAllDayEventSeries(title, startDate, recurrence)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

`createCalendar(name)`

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

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

פרמטרים

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

חזרה

Calendar — היומן החדש שנוצר

אישור

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

`createCalendar(name, options)`

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

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

פרמטרים

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

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

שם	סוג	תיאור
`location`	`String`	המיקום של היומן
`description`	`String`	התיאור של היומן
`timeZone`	`String`	אזור הזמן שבו רוצים להגדיר את היומן, בפורמט 'ארוך' (למשל, 'America/New_York', כפי שמופיע ב-Joda.org)
`color`	`String`	מחרוזת צבע הקסדצימלי ("‎#rrggbb") או ערך מ-`CalendarApp.Colors`
`hidden`	`Boolean`	אם היומן מוסתר בממשק המשתמש (ברירת המחדל: `false`)
`selected`	`Boolean`	אם האירועים ביומן יוצגו בממשק המשתמש (ברירת המחדל: `true`)

חזרה

Calendar — היומן החדש שנוצר

אישור

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

`createEvent(title, startTime, endTime)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

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

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

`createEventFromDescription(description)`

יצירת אירוע מתיאור בפריסה גמישה.

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

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

פרמטרים

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

חזרה

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

אישור

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

`getAllCalendars()`

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

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

חזרה

Calendar[] — כל היומנים שלמשתמש יש גישה אליהם

אישור

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

`getAllOwnedCalendars()`

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

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

חזרה

Calendar[] — כל היומנים שבבעלות המשתמש

אישור

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

`getCalendarById(id)`

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

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

פרמטרים

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

חזרה

Calendar – היומן עם המזהה שצוין, או null אם היומן לא קיים, אם למשתמש אין גישה אליו או אם המשתמש לא רשום למינוי ליומן

אישור

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

`getCalendarsByName(name)`

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

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם היומן

חזרה

Calendar[] – כל היומנים עם השם הזה שהמשתמש יכול לגשת אליהם

אישור

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

`getColor()`

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

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

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

חזרה

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

אישור

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

`getDefaultCalendar()`

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

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

חזרה

Calendar — יומן ברירת המחדל של המשתמש

אישור

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

`getDescription()`

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

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

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

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

חזרה

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

אישור

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

`getEventById(iCalId)`

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

`getEventSeriesById(iCalId)`

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

`getEvents(startTime, endTime)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

`getEvents(startTime, endTime, options)`

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

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

`getEventsForDay(date)`

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

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

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

// Determines how many events are happening today.
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log(`Number of events: ${events.length}`);

פרמטרים

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

חזרה

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

אישור

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

`getEventsForDay(date, options)`

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

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

// Determines how many events are happening today and contain the term
// "meeting".
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {
  search: 'meeting',
});
Logger.log(`Number of events: ${events.length}`);

פרמטרים

שם	סוג	תיאור
`date`	`Date`	התאריך שבו רוצים לאחזר אירועים (המערכת משתמשת רק ביום, והשעה מתעלמת)
`options`	`Object`	אפשרויות סינון מתקדמות

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

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

חזרה

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

אישור

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

`getId()`

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

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

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

חזרה

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

אישור

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

`getName()`

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

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

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

חזרה

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

אישור

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

`getOwnedCalendarById(id)`

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

כדי למצוא את מזהה היומן, לוחצים על החץ ליד שם היומן ביומן Google ובוחרים באפשרות הגדרות יומן. המזהה מופיע בחלק התחתון של דף ההגדרות.

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

פרמטרים

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

חזרה

Calendar – היומן עם המזהה שצוין, או null אם היומן לא קיים או שהוא לא בבעלות המשתמש

אישור

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

`getOwnedCalendarsByName(name)`

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

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם היומן

חזרה

Calendar[] – כל היומנים בשם הזה שבבעלות המשתמש

אישור

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

`getTimeZone()`

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

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

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

חזרה

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

אישור

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

`isHidden()`

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

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

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

חזרה

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

אישור

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

`isMyPrimaryCalendar()`

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

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

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

חזרה

Boolean – true אם היומן הוא יומן ברירת המחדל של המשתמש בפועל, false אם לא.

אישור

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

`isOwnedByMe()`

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

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

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

חזרה

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

אישור

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

`isSelected()`

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

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

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

חזרה

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

אישור

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

`newRecurrence()`

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

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

חזרה

EventRecurrence – אובייקט חוזר חדש ללא כללים מוגדרים (פועל כחזרה שבועית)

אישור

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

`setColor(color)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

`setDescription(description)`

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

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

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

פרמטרים

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

חזרה

Calendar — היומן הזה לשרשור

אישור

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

`setHidden(hidden)`

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

פרמטרים

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

חזרה

Calendar — היומן הזה לשרשור

אישור

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

`setName(name)`

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

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

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

פרמטרים

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

חזרה

Calendar — היומן הזה לשרשור

אישור

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

`setSelected(selected)`

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

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

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

פרמטרים

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

חזרה

Calendar — היומן הזה לשרשור

אישור

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

`setTimeZone(timeZone)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

`subscribeToCalendar(id)`

הרשמה של המשתמש ליומן עם המזהה שצוין, אם המשתמש מורשה להירשם.

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

פרמטרים

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

חזרה

Calendar – היומן החדש שאליו נרשמת

זריקות

Error – אם אין יומן עם המזהה הזה

אישור

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

`subscribeToCalendar(id, options)`

הרשמה של המשתמש ליומן עם המזהה שצוין, אם המשתמש מורשה להירשם.

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

פרמטרים

שם	סוג	תיאור
`id`	`String`	המזהה של היומן שאליו רוצים להירשם.
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך.

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

שם	סוג	תיאור
`color`	`String`	מחרוזת צבע הקסדצימלי ("‎#rrggbb") או ערך מ-`CalendarApp.Colors`.
`hidden`	`Boolean`	אם היומן מוסתר בממשק המשתמש (ברירת המחדל: `false`).
`selected`	`Boolean`	האם האירועים ביומן יוצגו בממשק המשתמש (ברירת המחדל: `true` אם `color` צוין גם כן, `false` במקרים אחרים).

חזרה

Calendar – היומן החדש שאליו נרשמת.

זריקות

Error – אם אין יומן עם המזהה הזה

אישור

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