מייצג אירוע אחד ביומן.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addEmailReminder(minutesBefore) | CalendarEvent | הוספת תזכורת חדשה באימייל לאירוע. |
addGuest(email) | CalendarEvent | הוספת משתתפים לאירוע. |
addPopupReminder(minutesBefore) | CalendarEvent | הוספת התראה קופצת חדשה לאירוע. |
addSmsReminder(minutesBefore) | CalendarEvent | הוספת תזכורת SMS חדשה לאירוע. |
anyoneCanAddSelf() | Boolean | ההגדרה קובעת אם אנשים יוכלו להוסיף את עצמם כאורחים לאירוע ביומן. |
deleteEvent() | void | תמחקו אירוע ביומן. |
deleteTag(key) | CalendarEvent | מחיקה של תג מפתח/ערך מהאירוע. |
getAllDayEndDate() | Date | הפונקציה מקבלת את התאריך שבו מסתיים האירוע הזה ביומן של יום שלם. |
getAllDayStartDate() | Date | הפונקציה מקבלת את התאריך שבו מתחיל האירוע הזה ביומן של יום שלם. |
getAllTagKeys() | String[] | קבלת כל המפתחות של התגים שהוגדרו באירוע. |
getColor() | String | הפונקציה מחזירה את הצבע של האירוע ביומן. |
getCreators() | String[] | משיג יוצרים של אירוע. |
getDateCreated() | Date | הפונקציה מקבלת את התאריך שבו האירוע נוצר. |
getDescription() | String | קבלת התיאור של האירוע. |
getEmailReminders() | Integer[] | הפונקציה מקבלת את ערכי הדקות לכל התזכורות באימייל של האירוע. |
getEndTime() | Date | הפונקציה מקבלת את התאריך והשעה שבהם האירוע ביומן מסתיים. |
getEventSeries() | CalendarEventSeries | הפונקציה מקבלת את סדרת האירועים החוזרים שהאירוע הזה שייך אליהם. |
getGuestByEmail(email) | EventGuest | מקבל אורח באמצעות כתובת אימייל. |
getGuestList() | EventGuest[] | יזמין את המשתתפים לאירוע, לא כולל הבעלים של האירוע. |
getGuestList(includeOwner) | EventGuest[] | משיגים את רשימת המשתתפים באירוע, כולל את הבעלים של האירוע. |
getId() | String | מקבל את ה-iCalUID הייחודי של האירוע. |
getLastUpdated() | Date | הפונקציה מקבלת את התאריך שבו האירוע עודכן לאחרונה. |
getLocation() | String | מקבל את המיקום של האירוע. |
getMyStatus() | GuestStatus | מקבל את סטטוס האירוע (למשל נוכח או מוזמן) של המשתמש האפקטיבי. |
getOriginalCalendarId() | String | יש לאתר את המזהה של היומן שבו האירוע נוצר במקור. |
getPopupReminders() | Integer[] | קבלת ערכי הדקות לכל התזכורות בחלון קופץ עבור האירוע. |
getSmsReminders() | Integer[] | קבלת ערכי הדקות לכל תזכורות ה-SMS של האירוע. |
getStartTime() | Date | הפונקציה מקבלת את התאריך והשעה שבהם האירוע ביומן מתחיל. |
getTag(key) | String | הפונקציה מקבלת את ערך התג של האירוע. |
getTitle() | String | מקבל את שם האירוע. |
getVisibility() | Visibility | מקבל את החשיפה של האירוע. |
guestsCanInviteOthers() | Boolean | האפשרות הזו קובעת אם המשתתפים יוכלו להזמין אורחים אחרים. |
guestsCanModify() | Boolean | האפשרות הזו קובעת אם המשתתפים יוכלו לבצע שינויים באירוע. |
guestsCanSeeGuests() | Boolean | קובעת אם המשתתפים יוכלו לראות אורחים אחרים. |
isAllDayEvent() | Boolean | קובע אם מדובר באירוע של יום שלם. |
isOwnedByMe() | Boolean | מציין אם אתם הבעלים של האירוע. |
isRecurringEvent() | Boolean | קובע אם האירוע הוא חלק מסדרת אירועים. |
removeAllReminders() | CalendarEvent | כל התזכורות יוסרו מהאירוע. |
removeGuest(email) | CalendarEvent | הסרת משתתפים מהאירוע. |
resetRemindersToDefault() | CalendarEvent | איפוס התזכורות לפי הגדרות ברירת המחדל של היומן. |
setAllDayDate(date) | CalendarEvent | מגדיר את תאריך האירוע. |
setAllDayDates(startDate, endDate) | CalendarEvent | מגדיר את תאריכי האירוע. |
setAnyoneCanAddSelf(anyoneCanAddSelf) | CalendarEvent | המדיניות הזו קובעת אם אנשים שאינם אורחים יוכלו להצטרף בעצמם לאירוע. |
setColor(color) | CalendarEvent | הגדרת הצבע של האירוע ביומן. |
setDescription(description) | CalendarEvent | מגדיר את תיאור האירוע. |
setGuestsCanInviteOthers(guestsCanInviteOthers) | CalendarEvent | קובעת אם המשתתפים יכולים להזמין אורחים אחרים. |
setGuestsCanModify(guestsCanModify) | CalendarEvent | קובעת אם המשתתפים יוכלו לשנות את האירוע. |
setGuestsCanSeeGuests(guestsCanSeeGuests) | CalendarEvent | קובעת אם המשתתפים יוכלו לראות אורחים אחרים. |
setLocation(location) | CalendarEvent | מגדיר את מיקום האירוע. |
setMyStatus(status) | CalendarEvent | מגדיר את הסטטוס של האירוע (למשל נוכח או מוזמן) של המשתמש האפקטיבי. |
setTag(key, value) | CalendarEvent | מגדיר תג מפתח/ערך באירוע, לאחסון מטא-נתונים בהתאמה אישית. |
setTime(startTime, endTime) | CalendarEvent | הגדרת התאריכים והשעות של ההתחלה והסיום של האירוע. |
setTitle(title) | CalendarEvent | קביעת שם האירוע. |
setVisibility(visibility) | CalendarEvent | מגדיר את הרשאות הגישה של האירוע. |
מסמכי תיעוד מפורטים
addEmailReminder(minutesBefore)
הוספת תזכורת חדשה באימייל לאירוע. התזכורת חייבת להיות באורך של 5 דקות לכל היותר, ולא יותר מ-4 דקות שבועות (40320 דקות), לפני האירוע.
// 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 | מספר הדקות לפני האירוע |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
קליעות
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 let attendeeEmail = 'user@example.com'; // Email address of the person you need to add let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event let eventId = '123abc'; // ID of event instance let calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } let 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 let attendeeEmail = 'user@example.com'; // Email address of the person you need to add let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events let calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe let 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 (var i = 0; i < calEvents.length; i++) { let event = calEvents[i]; event.addGuest(attendeeEmail); } }
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של האורח. |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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 | מספר הדקות לפני האירוע |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addSmsReminder(minutesBefore)
הוספת תזכורת SMS חדשה לאירוע. התזכורת חייבת להיות באורך של 5 דקות לכל היותר, ולא יותר מ-4 דקות שבועות (40320 דקות), לפני האירוע.
פרמטרים
שם | סוג | תיאור |
---|---|---|
minutesBefore | Integer | מספר הדקות לפני האירוע |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
קליעות
Error
– אם יש יותר מ-5 תזכורות באירוע או אם השעה לא צוינה
בטווח החוקי
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
anyoneCanAddSelf()
ההגדרה קובעת אם אנשים יוכלו להוסיף את עצמם לרשימת המשתתפים באירוע ביומן.
// 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
deleteEvent()
תמחקו אירוע ביומן.
// Gets an event by its ID. // TODO(developer): Replace the string with the ID of the event that you want to delete. const event = CalendarApp.getEventById('abc123456'); // Deletes the event. event.deleteEvent();
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
deleteTag(key)
מחיקה של תג מפתח/ערך מהאירוע.
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | מפתח התג |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllDayEndDate()
הפונקציה מקבלת את התאריך שבו מסתיים האירוע הזה ביומן של יום שלם. (אם לא מדובר באירוע של יום שלם,
השיטה הזו גורמת לחריגה). הערך Date
המוחזר מייצג את חצות בשלב
תחילת היום אחרי סיום האירוע באזור הזמן של הסקריפט. כדי להשתמש
לאזור הזמן של היומן במקום, יש להתקשר למספר getEndTime()
.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Creates an event named 'My all-day event' for May 16, 2023. const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023')); // Gets the event's end date and logs it. const endDate = event.getAllDayEndDate(); console.log(endDate);
חזרה
Date
- תאריך הסיום של האירוע הזה ביומן שנמשך כל היום
קליעות
Error
– אם האירוע הזה לא נמשך כל היום
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllDayStartDate()
הפונקציה מקבלת את התאריך שבו מתחיל האירוע הזה ביומן של יום שלם. (אם לא מדובר באירוע של יום שלם,
השיטה הזו גורמת לחריגה). הערך Date
המוחזר מייצג את חצות בשלב
תחילת היום שבו האירוע מתחיל באזור הזמן של הסקריפט. כדי להשתמש
לאזור הזמן של היומן במקום, יש להתקשר למספר getStartTime()
.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Creates an event named 'My all-day event' for May 16, 2023. const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023')); // Gets the event's start date and logs it. const startDate = event.getAllDayStartDate(); console.log(startDate);
חזרה
Date
- תאריך ההתחלה של האירוע הזה ביומן של כל היום
קליעות
Error
– אם האירוע הזה לא נמשך כל היום
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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
getEndTime()
הפונקציה מקבלת את התאריך והשעה שבהם האירוע ביומן מסתיים. צריכה להיות לכם גישה ליומן. באירועים שאינם של יום שלם, זהו הרגע שבו האירוע הוגדר באופן מיידי סוף. באירועים שנמשכים כל היום ושומרים רק תאריך סיום (לא תאריך ושעה), השעה היא חצות בתחילת היום שאחרי סיום האירוע, באזור הזמן של היומן. הזה מאפשרת השוואה משמעותית בין זמני סיום לכל סוגי האירועים. עם זאת, בהכרח לשמר את היום המקורי בשנה ללא שינוי.
באירועים של יום שלם, getAllDayEndDate()
כמעט
נקראת תמיד בעדיפות לשיטה הזו.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for February 1st, 2023 that takes place // between 4:00 PM and 5:00 PM. const event = calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0]; if (event) { // If an event exists within the given time frame, gets the date and time at which the // event ends and logs it. console.log(event.getEndTime()); } else { // If no event exists within the given time frame, logs that info 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
getEventSeries()
הפונקציה מקבלת את סדרת האירועים החוזרים שהאירוע הזה שייך להם. צריכה להיות לך גישה
יומן. אובייקט CalendarEventSeries
מוחזר גם אם האירוע הזה לא שייך ל-
סדרה, כדי שניתן יהיה להוסיף הגדרות חזרה חדשות.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for February 18th, 2023 that takes place between // 1:00 PM and 2:00 PM. const event = calendar.getEvents(new Date('Feb 18, 2023 13:00:00'), new Date('Feb 18, 2023 14:00:00'))[0]; if (event) { // If an event exists within the given time frame, gets the event series for the event // and sets the color to pale green. event.getEventSeries().setColor(CalendarApp.EventColor.PALE_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'); }
חזרה
CalendarEventSeries
– סדרת האירועים שאליה האירוע הזה שייך, או סדרת אירועים חדשה אם היא עדיין לא שייכת
לסדרה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('alex@example.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('alex@example.com'); event.addGuest('cruz@example.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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()
מקבל את ה-iCalUID הייחודי של האירוע. חשוב לשים לב שה-iCalUID והאירוע id
שבהם משתמשים
ה-API של יומן Google v3 והשירות המתקדם של יומן Google לא זהים,
שלא ניתן להשתמש בו לסירוגין. הבדל אחד בסמנטיקה שלהם הוא שבאירועים חוזרים
לכל המופעים של אירוע אחד יש 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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
getStartTime()
הפונקציה מקבלת את התאריך והשעה שבהם האירוע ביומן מתחיל. באירועים שאינם של יום שלם, הוא ברגע שבו האירוע הוגדר כהתחלה. לאירועים של יום שלם, שכוללים רק לשמור תאריך התחלה (לא תאריך ושעה), החל בחצות בתחילת היום שבו האירוע יתחיל באזור הזמן של היומן. כך ניתן לבצע השוואה משמעותית של שעות התחלה לכל סוגי האירועים; עם זאת, הוא לא בהכרח שומר היום בשנה לא השתנה.
עבור אירועים של יום שלם, getAllDayStartDate()
צריך
נקראת כמעט תמיד העדפה לשיטה הזו.
// 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('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for February 1st, 2023 that takes place // between 4:10 PM and 4:25 PM. const event = calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0]; // Gets the date and time at which this calendar event begins and logs it. const startTime = event.getStartTime(); console.log(startTime);
חזרה
Date
– שעת ההתחלה של האירוע ביומן
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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
isAllDayEvent()
קובע אם מדובר באירוע של יום שלם.
// 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('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for January 31st, 2023 that takes place // between 9:05 AM and 9:15 AM. const event = calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0]; // Determines whether this event is an all-day event and logs it. console.log(event.isAllDayEvent());
חזרה
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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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
isRecurringEvent()
קובע אם האירוע הוא חלק מסדרת אירועים.
// 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('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for Januart 31st, 2023 that takes place // between 9:00 AM and 10:00 AM. const event = calendar.getEvents(new Date('Jan 31, 2023 09:00:00'), new Date('Jan 31, 2023 10:00:00'))[0]; if (event) { // If an event exists within the given time frame, determines whether the event is part of an // event series and logs it. console.log(event.isRecurringEvent()); } 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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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'); }
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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 let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event let eventId = '123abc'; // ID of event instance let calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } let 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 let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events let calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe let 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 (var i = 0; i < calEvents.length; i++) { let event = calEvents[i]; event.removeGuest(attendeeEmail); } }
פרמטרים
שם | סוג | תיאור |
---|---|---|
email | String | כתובת האימייל של האורח |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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'); }
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setAllDayDate(date)
מגדיר את תאריך האירוע. כשמשתמשים בשיטה הזו, המערכת משנה אירוע רגיל לאירוע של יום שלם.
// 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('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for February 17th, 2023 that takes place // between 4:00 PM and 5:00 PM. const event = calendar.getEvents(new Date('Feb 17, 2023 16:00:00'), new Date('Feb 17, 2023 17:00:00'))[0]; if (event) { // If an event exists within the given time frame, sets the date of the event and updates // it to an all-day event. event.setAllDayDate(new Date('Feb 17, 2023')); } 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 | Date | תאריך האירוע (המערכת מתעלמת מהשעה) |
חזרה
CalendarEvent
– האירוע הזה ביומן Google ליצירת שרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setAllDayDates(startDate, endDate)
מגדיר את תאריכי האירוע. כשמשתמשים בשיטה הזו, המערכת משנה אירוע רגיל לאירוע של יום שלם אירוע.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Gets the first event from the calendar for February 18th, 2023 that takes place // between 4:00 PM and 5:00 PM. const event = calendar.getEvents(new Date('Feb 18, 2023 16:00:00'), new Date('Feb 18, 2023 17:00:00'))[0]; if (event) { // If an event exists within the given time frame, sets the event to be an all-day event from // Feb 18th, 2023 until Feb 25th, 2023. Applying this method changes a regular event into an // all-day event. event.setAllDayDates(new Date('Feb 18, 2023'), new Date('Feb 25, 2023')); } 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'); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
startDate | Date | התאריך שבו האירוע מתחיל (המערכת מתעלמת מהשעה) |
endDate | Date | התאריך שבו האירוע מסתיים (המערכת מתעלמת מהשעה) |
חזרה
CalendarEvent
– האירוע הזה ביומן Google ליצירת שרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | האם כל אחד יכול להזמין את עצמו |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 . |
חזרה
CalendarEvent
– האירוע הזה ביומן, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | התיאור החדש |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | אם אורחים יכולים להזמין אחרים |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setGuestsCanModify(guestsCanModify)
קובעת אם המשתתפים יוכלו לשנות את האירוע.
פרמטרים
שם | סוג | תיאור |
---|---|---|
guestsCanModify | Boolean | אם האורחים יכולים לבצע שינויים באירוע |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setGuestsCanSeeGuests(guestsCanSeeGuests)
קובעת אם המשתתפים יוכלו לראות אורחים אחרים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
guestsCanSeeGuests | Boolean | אם האורחים יכולים לראות אנשים אחרים |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | המיקום החדש |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | הסטטוס החדש |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setTag(key, value)
מגדיר תג מפתח/ערך באירוע, לאחסון מטא-נתונים בהתאמה אישית.
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | מפתח התג |
value | String | ערך התג |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTime(startTime, endTime)
הגדרת התאריכים והשעות של ההתחלה והסיום של האירוע. יישום השיטה הזו משנה אירוע של יום שלם לאירוע רגיל.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Declares a start time of 11:00 AM on February 20th, 2023 and an end time of 12:00 PM on // February 20th, 2023. const startTime = new Date('Feb 20,2023 11:00:00'); const endTime = new Date('Feb 20, 2023 12:00:00'); // Creates an all-day event on February 20th, 2023. const event = calendar.createAllDayEvent('Meeting', new Date('Feb 20,2023')); // Updates the all-day event to a regular event by setting a start and end time for the event. event.setTime(startTime, endTime);
פרמטרים
שם | סוג | תיאור |
---|---|---|
startTime | Date | ההתחלה החדשה של האירוע |
endTime | Date | הסוף החדש של האירוע |
חזרה
CalendarEvent
– האירוע הזה ביומן Google ליצירת שרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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('abc123456@group.calendar.google.com'); // 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('abc123456@google.com'); // 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 | השם החדש |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setVisibility(visibility)
מגדיר את הרשאות הגישה של האירוע.
פרמטרים
שם | סוג | תיאור |
---|---|---|
visibility | Visibility |
חזרה
CalendarEvent
– ה-CalendarEvent
הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds