Class CalendarApp

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

// Creates a new calendar named "Travel Plans" with a summary and color.
var calendar = CalendarApp.createCalendar('Travel Plans', {
  summary: '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());

פרמטרים

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

החזרות

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

אישור

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

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

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

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

החזרות

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

אישור

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

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

קבלת כל היומנים שבבעלות המשתמש.

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

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

מקבלת את כל היומנים עם שם פרטי שהמשתמש רשום אליו או שהוא רשום אליו. השמות לא תלויי אותיות רישיות (case-sensitive).

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

פרמטרים

החזרות

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

אישור

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

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

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

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

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

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

החזרות

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

אישור

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

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

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

// 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) תחזיר אירוע רק ביומן ברירת המחדל.

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

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

פרמטרים

החזרות

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

אישור

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

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

הפונקציה מקבלת את סדרת האירועים עם המזהה הנתון. אם המזהה שניתן הוא עבור 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());

פרמטרים

החזרות

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

אישור

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

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

שימו לב שהסינון לפי 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);

פרמטרים

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

החזרות

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

אישור

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

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

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

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

שימו לב שהסינון לפי 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);

פרמטרים

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

החזרות

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

אישור

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

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

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

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

קבלת השם של היומן.

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

קבלת כל היומנים עם שם נתון שבבעלות המשתמש. השמות לא תלויי אותיות רישיות (case-sensitive).

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

פרמטרים

החזרות

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

אישור

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

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

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

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

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

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

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

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

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

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

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

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

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

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
var 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 - אובייקט חזרה חדש ללא כללים מוגדרים (מתנהג כחזרה שבועית)

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

// 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.')

פרמטרים

החזרות

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

אישור

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

אישור

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

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

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

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

פרמטרים

החזרות

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

קליעות

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

אישור

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

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

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

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

פרמטרים

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

החזרות

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

קליעות

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

אישור

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

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