Class CalendarEventSeries

יומןאירועסדרה

מייצג סדרה של אירועים (אירוע חוזר).

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addEmailReminder(minutesBefore)	CalendarEventSeries	הוספת תזכורת חדשה באימייל לאירוע.
addGuest(email)	CalendarEventSeries	הוספת משתתף לאירוע.
addPopupReminder(minutesBefore)	CalendarEventSeries	הוספת התראה קופצת חדשה לאירוע.
addSmsReminder(minutesBefore)	CalendarEventSeries	הוספת תזכורת חדשה ב-SMS לאירוע.
anyoneCanAddSelf()	Boolean	קובע אם אנשים יוכלו להוסיף את עצמם כאורחים לאירוע ביומן Google.
deleteEventSeries()	void	מחיקת סדרת האירועים.
deleteTag(key)	CalendarEventSeries	מחיקה של תג מפתח/ערך מהאירוע.
getAllTagKeys()	String[]	הפונקציה מקבלת את כל המפתחות של התגים שהוגדרו באירוע.
getColor()	String	הפונקציה מחזירה את הצבע של האירוע ביומן.
getCreators()	String[]	הצגת היוצרים של אירוע.
getDateCreated()	Date	הפונקציה מקבלת את התאריך שבו האירוע נוצר.
getDescription()	String	הפונקציה מקבלת את תיאור האירוע.
getEmailReminders()	Integer[]	הפונקציה מקבלת את ערכי הדקות של כל התזכורות באימייל לגבי האירוע.
getEventType()	EventType	אחזור EventType של האירוע הזה.
getGuestByEmail(email)	EventGuest	אחזור של משתתף לפי כתובת האימייל שלו.
getGuestList()	EventGuest[]	הפונקציה מקבלת את רשימת המשתתפים באירוע, לא כולל הבעלים של האירוע.
getGuestList(includeOwner)	EventGuest[]	הפונקציה מקבלת את רשימת המשתתפים באירוע, כולל הבעלים של האירוע.
getId()	String	הפונקציה מקבלת את המזהה הייחודי של האירוע ב-iCal.
getLastUpdated()	Date	הפונקציה מקבלת את התאריך שבו האירוע עודכן לאחרונה.
getLocation()	String	אחזור המיקום של האירוע.
getMyStatus()	GuestStatus	הפונקציה מקבלת את סטטוס האירוע (למשל, נוכח או מוזמן) של המשתמש בפועל.
getOriginalCalendarId()	String	אחזור המזהה של היומן שבו האירוע נוצר במקור.
getPopupReminders()	Integer[]	הפונקציה מקבלת את ערכי הדקות של כל התזכורות הקופצות של האירוע.
getSmsReminders()	Integer[]	הפונקציה מקבלת את ערכי הדקות של כל תזכורות ה-SMS לאירוע.
getTag(key)	String	הפונקציה מקבלת ערך תג של האירוע.
getTitle()	String	הפונקציה מקבלת את שם האירוע.
getVisibility()	Visibility	הפונקציה מקבלת את הרשאות הגישה של האירוע.
guestsCanInviteOthers()	Boolean	קובע אם האורחים יוכלו להזמין אורחים אחרים.
guestsCanModify()	Boolean	קובעת אם האורחים יכולים לשנות את האירוע.
guestsCanSeeGuests()	Boolean	קובעת אם האורחים יוכלו לראות אורחים אחרים.
isOwnedByMe()	Boolean	קובע אם אתם הבעלים של האירוע.
removeAllReminders()	CalendarEventSeries	הסרת כל התזכורות מהאירוע.
removeGuest(email)	CalendarEventSeries	הסרת אורח מהאירוע.
resetRemindersToDefault()	CalendarEventSeries	איפוס התזכורות לפי הגדרות ברירת המחדל של היומן.
setAnyoneCanAddSelf(anyoneCanAddSelf)	CalendarEventSeries	מגדיר אם משתמשים שאינם אורחים יוכלו להוסיף את עצמם לאירוע.
setColor(color)	CalendarEventSeries	הגדרת הצבע של האירוע ביומן.
setDescription(description)	CalendarEventSeries	הגדרת התיאור של האירוע.
setGuestsCanInviteOthers(guestsCanInviteOthers)	CalendarEventSeries	מגדיר אם האורחים יכולים להזמין אורחים אחרים.
setGuestsCanModify(guestsCanModify)	CalendarEventSeries	ההגדרה קובעת אם האורחים יכולים לשנות את האירוע.
setGuestsCanSeeGuests(guestsCanSeeGuests)	CalendarEventSeries	הגדרה שמאפשרת לקבוע אם האורחים יוכלו לראות אורחים אחרים.
setLocation(location)	CalendarEventSeries	מגדיר את המיקום של האירוע.
setMyStatus(status)	CalendarEventSeries	הגדרת סטטוס האירוע (למשל, נוכח או מוזמן) של המשתמש בפועל.
setRecurrence(recurrence, startDate)	CalendarEventSeries	הגדרת כללי המחזוריות של סדרת אירועים שנמשכים יום שלם.
setRecurrence(recurrence, startTime, endTime)	CalendarEventSeries	הגדרת כללי המחזוריות של סדרת האירועים הזו.
setTag(key, value)	CalendarEventSeries	הגדרת תג מפתח/ערך באירוע, לאחסון מטא-נתונים מותאמים אישית.
setTitle(title)	CalendarEventSeries	הגדרת השם של האירוע.
setVisibility(visibility)	CalendarEventSeries	הגדרת החשיפה של האירוע.

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

addEmailReminder(minutesBefore)

הוספת תזכורת חדשה באימייל לאירוע. התזכורת צריכה להופיע לפחות 5 דקות לפני האירוע, לכל היותר 4 שבועות (40,320 דקות).

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds an email notification for 15 minutes before the event.
event.addEmailReminder(15);

פרמטרים

שם	סוג	תיאור
minutesBefore	Integer	מספר הדקות לפני האירוע

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

זריקות

Error – אם יש יותר מ-5 תזכורות לאירוע או שהשעה לא נמצאת בטווח הזמן החוקי

אישור

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

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

---

addGuest(email)

הוספת משתתף לאירוע.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  const attendeeEmail =
      '[e-mail]';  // Email address of the person you need to add
  const calendarId =
      '[e-mail]';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
  }
  event.addGuest(attendeeEmail);
}

// Example 2: Add a guest to all events on a calendar within a specified
// timeframe
function addAttendeeToAllEvents() {
  // Replace the following values with your own
  const attendeeEmail =
      '[e-mail]';  // Email address of the person you need to add
  const calendarId =
      '[e-mail]';  // ID of calendar with the
  // events
  const startDate =
      new Date('YYYY-MM-DD');  // The first date to add the guest to the events
  const endDate =
      new Date('YYYY-MM-DD');  // The last date to add the guest to the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const calEvents = calendar.getEvents(startDate, endDate);
  console.log(calEvents.length);  // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.addGuest(attendeeEmail);
  }
}

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של האורח.

חזרה

CalendarEventSeries — CalendarEventSeries לשרשור.

אישור

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

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

---

addPopupReminder(minutesBefore)

הוספת התראה קופצת חדשה לאירוע. ההתראה צריכה להישלח לפחות 5 דקות, לכל היותר 4 שבועות (40,320 דקות) לפני האירוע.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds a pop-up notification for 15 minutes before the event.
event.addPopupReminder(15);

פרמטרים

שם	סוג	תיאור
minutesBefore	Integer	מספר הדקות לפני האירוע

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

addSmsReminder(minutesBefore)

הוספת תזכורת חדשה ב-SMS לאירוע. התזכורת צריכה להופיע לפחות 5 דקות לפני האירוע, לכל היותר 4 שבועות (40,320 דקות).

פרמטרים

שם	סוג	תיאור
minutesBefore	Integer	מספר הדקות לפני האירוע

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

זריקות

Error – אם יש יותר מ-5 תזכורות לאירוע או שהשעה לא נמצאת בטווח הזמן החוקי

אישור

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

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

---

anyoneCanAddSelf()

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

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Determines whether people can add themselves as guests to the event and logs
// it.
console.log(event.anyoneCanAddSelf());

חזרה

Boolean — true אם משתמשים שאינם אורחים יכולים להוסיף את עצמם לאירוע, false אם לא

אישור

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

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

---

deleteEventSeries()

מחיקת סדרת האירועים.

אישור

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

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

---

deleteTag(key)

מחיקה של תג מפתח/ערך מהאירוע.

פרמטרים

שם	סוג	תיאור
key	String	מפתח התג

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

getAllTagKeys()

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

חזרה

String[] – מערך של מפתחות מחרוזת

אישור

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

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

---

getColor()

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

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets the color of the calendar event and logs it.
const eventColor = event.getColor();
console.log(eventColor);

חזרה

String — ייצוג המחרוזת של צבע האירוע, כאינדקס (1-11) של ערכים מ-CalendarApp.EventColor.

אישור

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

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

---

getCreators()

הצגת היוצרים של אירוע.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets a list of the creators of the event and logs it.
console.log(event.getCreators());

חזרה

String[] – כתובות האימייל של היוצרים של האירוע

אישור

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

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

---

getDateCreated()

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

// Opens the calendar by using its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the calendar ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 8:10 AM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 08:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the date that the
  // event was created and logs it.
  const eventCreated = event.getDateCreated();
  console.log(eventCreated);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Date – תאריך היצירה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-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.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 4:00 PM and 5:00 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 16:00:00'),
    new Date('Feb 04, 2023 17:00:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the description of the
  // event.
  event.setDescription('Important meeting');

  // Gets the description of the event and logs it.
  const description = event.getDescription();
  console.log(description);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

String – התיאור

אישור

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

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

---

getEmailReminders()

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:00 PM and 6:00 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 15:00:00'),
    new Date('Feb 04, 2023 18:00:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, adds email reminders for
  // the user to be sent at 4 and 7 minutes before the event.
  event.addEmailReminder(4);
  event.addEmailReminder(7);

  // Gets the minute values for all email reminders that are set up for the user
  // for this event and logs it.
  const emailReminder = event.getEmailReminders();
  console.log(emailReminder);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Integer[] – מערך שבו כל ערך תואם למספר הדקות לפני האירוע שבו תופעל התזכורת

אישור

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

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

---

getEventType()

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

// Opens the default calendar and logs all out-of-office events for the current day.
const calendar = CalendarApp.getDefaultCalendar();
const events = calendar.getEventsForDay(new Date());
console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));

חזרה

EventType – סוג האירוע.

אישור

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

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

---

getGuestByEmail(email)

אחזור של משתתף לפי כתובת האימייל שלו.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Gets a guest by email address.
const guestEmailId = event.getGuestByEmail('[e-mail]');

// If the email address corresponds to an event guest, logs the email address.
if (guestEmailId) {
  console.log(guestEmailId.getEmail());
}

פרמטרים

שם	סוג	תיאור
email	String	הכתובת של האורח

חזרה

EventGuest – המשתתף, או null אם כתובת האימייל לא תואמת למשתתף

אישור

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

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

---

getGuestList()

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Adds two guests to the event by using their email addresses.
event.addGuest('[e-mail]');
event.addGuest('[e-mail]');

// Gets the guests list for the event.
const guestList = event.getGuestList();

// Loops through the list to get all the guests and logs their email addresses.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

חזרה

EventGuest[] – מערך של האורחים

אישור

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

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

---

getGuestList(includeOwner)

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Gets the guests list for the event, including the owner of the event.
const guestList = event.getGuestList(true);

// Loops through the list to get all the guests and logs it.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

פרמטרים

שם	סוג	תיאור
includeOwner	Boolean	אם לכלול את הבעלים כאורח

חזרה

EventGuest[] – מערך של האורחים

אישור

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

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

---

getId()

הפונקציה מקבלת את המזהה הייחודי של האירוע ב-iCal. חשוב לזכור שה-iCalUID והאירוע id שבהם נעשה שימוש ב-Calendar v3 API וב-Calendar advanced service הם לא זהים, ואי אפשר להשתמש בהם באופן חלופי. אחד ההבדלים בסמנטיקה שלהם הוא שבאירועים חוזרים, לכל המופעים של אירוע אחד יש ids שונה, אבל לכל המופעים יש את אותו מזהה iCalUID.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for January 5th, 2023 that takes place
// between 9:00 AM and 9:25 AM.
// For an event series, use calendar.getEventSeriesById('[e-mail]');
// and replace the series ID with your own.
const event = calendar.getEvents(
    new Date('Jan 05, 2023 09:00:00'),
    new Date('Jan 05, 2023 09:25:00'),
    )[0];

// Gets the ID of the event and logs it.
console.log(event.getId());

חזרה

String – ה-iCalUID של האירוע

אישור

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

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

---

getLastUpdated()

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

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:00 PM and 5:00 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:00:00'),
    new Date('Feb 01, 2023 17:00:00'),
    )[0];

// Gets the date the event was last updated and logs it.
const eventUpdatedDate = event.getLastUpdated();
console.log(eventUpdatedDate);

חזרה

Date – תאריך העדכון האחרון

אישור

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

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

---

getLocation()

אחזור המיקום של האירוע.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the location of the
  // event to Mumbai.
  event.setLocation('Mumbai');

  // Gets the location of the event and logs it.
  const eventLocation = event.getLocation();
  console.log(eventLocation);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

String – מיקום האירוע

אישור

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

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

---

getMyStatus()

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail].',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the event status of
  // the effective user and logs it.
  const myStatus = event.getMyStatus();
  console.log(myStatus.toString());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

GuestStatus – הסטטוס

אישור

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

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

---

getOriginalCalendarId()

אחזור המזהה של היומן שבו האירוע נוצר במקור.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 4:00 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 16:00:00'),
    new Date('Feb 25,2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the ID of the calendar
  // where the event was originally created and logs it.
  const calendarId = event.getOriginalCalendarId();
  console.log(calendarId);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

String – המזהה של היומן המקורי

אישור

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

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

---

getPopupReminders()

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:05 PM and 5:35 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 17:05:00'),
    new Date('Feb 04, 2023 17:35:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, adds two pop-up reminders
  // to the event. The first reminder pops up 5 minutes before the event starts
  // and the second reminder pops up 3 minutes before the event starts.
  event.addPopupReminder(3);
  event.addPopupReminder(5);

  // Gets the minute values for all pop-up reminders for the event and logs it.
  const popUpReminder = event.getPopupReminders();
  console.log(popUpReminder);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Integer[] – מערך שבו כל ערך תואם למספר הדקות לפני האירוע שבו תופעל התזכורת

אישור

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

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

---

getSmsReminders()

הפונקציה מקבלת את ערכי הדקות של כל תזכורות ה-SMS לאירוע.

חזרה

Integer[] – מערך שבו כל ערך תואם למספר הדקות לפני האירוע שבו תופעל התזכורת

אישור

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

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

---

getTag(key)

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

פרמטרים

שם	סוג	תיאור
key	String	המפתח

חזרה

String – ערך התג

אישור

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

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

---

getTitle()

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, logs the title of the
  // event.
  console.log(event.getTitle());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

String – הכותרת

אישור

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

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

---

getVisibility()

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the visibility of the
  // event and logs it.
  const eventVisibility = event.getVisibility();
  console.log(eventVisibility.toString());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Visibility – ערך החשיפה

אישור

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

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

---

guestsCanInviteOthers()

קובע אם האורחים יוכלו להזמין אורחים אחרים.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether guests
  // can invite other guests and logs it.
  console.log(event.guestsCanInviteOthers());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Boolean — true אם האורחים יכולים להזמין אורחים אחרים, false אם לא

אישור

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

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

---

guestsCanModify()

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // guests can't modify it.
  event.setGuestsCanModify(false);

  // Determines whether guests can modify the event and logs it.
  console.log(event.guestsCanModify());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Boolean — true אם האורחים יכולים לשנות את האירוע, false אם לא

אישור

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

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

---

guestsCanSeeGuests()

קובעת אם האורחים יוכלו לראות אורחים אחרים.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether guests
  // can see other guests and logs it.
  console.log(event.guestsCanSeeGuests());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Boolean — true אם האורחים יכולים לראות אורחים אחרים, false אם לא

אישור

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

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

---

isOwnedByMe()

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

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether you're
  // the owner of the event and logs it.
  console.log(event.isOwnedByMe());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

Boolean — true אם האירוע בבעלות המשתמש בפועל, false אם לא

אישור

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

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

---

removeAllReminders()

הסרת כל התזכורות מהאירוע.

// Opens the calendar by its ID. You must have edit access to the calendar
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 1,2023 16:10:00'),
    new Date('Feb 1,2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, removes all reminders from
  // the event.
  event.removeAllReminders();
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

removeGuest(email)

הסרת אורח מהאירוע.

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  const attendeeEmail =
      '[e-mail]';  // Email address of the person you need to remove
  const calendarId =
      '[e-mail]';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
  }
  event.removeGuest(attendeeEmail);
}

// Example 2: Remove a guest from all events on a calendar within a specified
// timeframe
function removeGuestFromAllEvents() {
  // Replace the following values with your own
  const attendeeEmail =
      '[e-mail]';  // Email address of the person you need to remove
  const calendarId =
      '[e-mail]';  // ID of calendar with the
  // events
  const startDate = new Date(
      'YYYY-MM-DD');  // The first date to remove the guest from the events
  const endDate = new Date(
      'YYYY-MM-DD');  // The last date to remove the attendee from the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const calEvents = calendar.getEvents(startDate, endDate);
  console.log(calEvents.length);  // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.removeGuest(attendeeEmail);
  }
}

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של האורח

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

resetRemindersToDefault()

איפוס התזכורות לפי הגדרות ברירת המחדל של היומן.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 1, 2023 16:10:00'),
    new Date('Feb 1, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, resets the reminders using
  // the calendar's default settings.
  event.resetRemindersToDefault();
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setAnyoneCanAddSelf(anyoneCanAddSelf)

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 15th, 2023 that takes
// place between 3:30 PM and 4:30 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 15, 2023 15:30:00'),
    new Date('Feb 15, 2023 16:30:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // non-guests can't add themselves to the event.
  event.setAnyoneCanAddSelf(false);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

שם	סוג	תיאור
anyoneCanAddSelf	Boolean	אם כל אחד יכול להזמין את עצמו

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setColor(color)

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the color of the
  // calendar event to green.
  event.setColor(CalendarApp.EventColor.GREEN);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

שם	סוג	תיאור
color	String	אינדקס צבע שלם כמחרוזת, או ערך מ-CalendarApp.EventColor.

חזרה

CalendarEventSeries – האירוע הזה ביומן, לצורך קישור.

אישור

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

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

---

setDescription(description)

הגדרת התיאור של האירוע.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:05 PM and 5:35 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 17:05:00'),
    new Date('Feb 04, 2023 17:35:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the description of the
  // event to 'Meeting.'
  event.setDescription('Meeting');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

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

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setGuestsCanInviteOthers(guestsCanInviteOthers)

מגדיר אם האורחים יכולים להזמין אורחים אחרים.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own. You must have edit access to
// the calendar.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // guests can invite other guests.
  event.setGuestsCanInviteOthers(true);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

שם	סוג	תיאור
guestsCanInviteOthers	Boolean	אם האורחים יכולים להזמין אנשים אחרים

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setGuestsCanModify(guestsCanModify)

ההגדרה קובעת אם האורחים יכולים לשנות את האירוע.

פרמטרים

שם	סוג	תיאור
guestsCanModify	Boolean	אם האורחים יכולים לשנות את האירוע

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setGuestsCanSeeGuests(guestsCanSeeGuests)

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

פרמטרים

שם	סוג	תיאור
guestsCanSeeGuests	Boolean	אם האורחים יוכלו לראות משתתפים אחרים

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setLocation(location)

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the location of the
  // event to Noida.
  event.setLocation('Noida');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

שם	סוג	תיאור
location	String	המיקום החדש

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setMyStatus(status)

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

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event status for
  // the current user to maybe.
  event.setMyStatus(CalendarApp.GuestStatus.MAYBE);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

שם	סוג	תיאור
status	GuestStatus	הסטטוס החדש

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setRecurrence(recurrence, startDate)

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

// Sets the events in a series to take place every Wednesday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '[e-mail]',
);
const startDate = new Date('January 2, 2013 03:00:00 PM EST');
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startDate);

פרמטרים

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

חזרה

CalendarEventSeries – האירוע הזה בסדרת האירועים ביומן לצורך קישור

אישור

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

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

---

setRecurrence(recurrence, startTime, endTime)

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

// Sets the events in a series to take place from 3pm to 4pm every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '[e-mail]',
);
const startTime = new Date('January 1, 2013 03:00:00 PM EST');
const endTime = new Date('January 1, 2013 04:00:00 PM EST');
const recurrence =
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startTime, endTime);

פרמטרים

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

חזרה

CalendarEventSeries – האירוע הזה בסדרת האירועים ביומן לצורך קישור

אישור

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

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

---

setTag(key, value)

הגדרת תג מפתח/ערך באירוע, לאחסון מטא-נתונים מותאמים אישית.

פרמטרים

שם	סוג	תיאור
key	String	מפתח התג
value	String	ערך התג

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setTitle(title)

הגדרת השם של האירוע.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    '[e-mail]',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('[e-mail]'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, changes its title to
  // Event1.
  event.setTitle('Event1');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

פרמטרים

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

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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

---

setVisibility(visibility)

הגדרת החשיפה של האירוע.

פרמטרים

שם	סוג	תיאור
visibility	Visibility

חזרה

CalendarEventSeries — CalendarEventSeries הזה לשרשור

אישור

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

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