מאפשר לסקריפט לקרוא ולעדכן את יומן Google של המשתמש. המחלקה הזו מספקת גישה ישירה ליומן ברירת המחדל של המשתמש, וכן אפשרות לאחזר יומנים נוספים שבבעלות המשתמש או שיש לו מינוי אליהם.
תכונות
מאפיין (property) | סוג | תיאור |
---|---|---|
Color | Color | טיפוסים בני מנייה (enum) שמייצגים את הצבעים בעלי השם הזמינים בשירות היומן. |
EventColor | EventColor | טיפוסים בני מנייה (enum) שמייצגים את צבעי האירועים בעלי שם שזמינים בשירות היומן. |
GuestStatus | GuestStatus | זהו 'טיפוסים בני מנייה (enum)' שמייצגים את הסטטוסים שאפשר לבחור עבור אירוע מסוים. |
Month | Month | טיפוסים בני מנייה (enum) שמייצגים את החודשים בשנה. |
Visibility | Visibility | ערך 'טיפוסים בני מנייה (enum)' שמייצג את החשיפה של אירוע מסוים. |
Weekday | Weekday | מספר טיפוסים (enum) שמייצג את הימים בשבוע. |
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | יצירת אירוע חדש של יום שלם. |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | יצירת אירוע חדש של יום שלם שיכול להתפרס על כמה ימים. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | יצירת אירוע חדש של יום שלם שיכול להתפרס על כמה ימים. |
createAllDayEvent(title, date, options) | CalendarEvent | יצירת אירוע חדש של יום שלם. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | יצירה של סדרת אירועים חדשה של יום שלם. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | יצירה של סדרת אירועים חדשה של יום שלם. |
createCalendar(name) | Calendar | יוצר יומן חדש שבבעלות המשתמש. |
createCalendar(name, options) | Calendar | יוצר יומן חדש שבבעלות המשתמש. |
createEvent(title, startTime, endTime) | CalendarEvent | ייווצר אירוע חדש. |
createEvent(title, startTime, endTime, options) | CalendarEvent | ייווצר אירוע חדש. |
createEventFromDescription(description) | CalendarEvent | יצירת אירוע מתיאור בניסוח חופשי. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | יצירה של סדרת אירועים חדשה. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | יצירה של סדרת אירועים חדשה. |
getAllCalendars() | Calendar[] | קבלת כל היומנים שבבעלות המשתמש או שיש לו מינוי אליהם. |
getAllOwnedCalendars() | Calendar[] | קבלת כל היומנים שבבעלות המשתמש. |
getCalendarById(id) | Calendar | הפונקציה מקבלת את היומן עם המזהה הנתון. |
getCalendarsByName(name) | Calendar[] | מקבלת את כל היומנים עם שם פרטי שהמשתמש רשום אליו או שהוא רשום אליו. |
getColor() | String | קבלת הצבע של היומן. |
getDefaultCalendar() | Calendar | מקבלת את יומן ברירת המחדל של המשתמש. |
getDescription() | String | קבלת התיאור של היומן. |
getEventById(iCalId) | CalendarEvent | הפונקציה מקבלת את האירוע עם המזהה הנתון. |
getEventSeriesById(iCalId) | CalendarEventSeries | הפונקציה מקבלת את סדרת האירועים עם המזהה הנתון. |
getEvents(startTime, endTime) | CalendarEvent[] | הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון. |
getEvents(startTime, endTime, options) | CalendarEvent[] | הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון ועומדים בקריטריונים שצוינו. |
getEventsForDay(date) | CalendarEvent[] | הפונקציה מקבלת את כל האירועים שמתרחשים ביום נתון. |
getEventsForDay(date, options) | CalendarEvent[] | הפונקציה מקבלת את כל האירועים שמתרחשים ביום מסוים ועומדים בקריטריונים שהוגדרו. |
getId() | String | הפונקציה מקבלת את המזהה של היומן. |
getName() | String | קבלת השם של היומן. |
getOwnedCalendarById(id) | Calendar | קבלת היומן עם המזהה הנתון, אם המשתמש הוא הבעלים שלו. |
getOwnedCalendarsByName(name) | Calendar[] | קבלת כל היומנים עם שם נתון שבבעלות המשתמש. |
getTimeZone() | String | הפונקציה מקבלת את אזור הזמן של היומן. |
isHidden() | Boolean | ההגדרה קובעת אם היומן מוסתר בממשק המשתמש. |
isMyPrimaryCalendar() | Boolean | ההגדרה קובעת אם היומן ישמש כיומן הראשי של המשתמש בפועל. |
isOwnedByMe() | Boolean | ההגדרה קובעת אם היומן בבעלותכם. |
isSelected() | Boolean | ההגדרה קובעת אם האירועים ביומן יוצגו בממשק המשתמש. |
newRecurrence() | EventRecurrence | יוצר אובייקט חזרה חדש, שיכול לשמש ליצירת כללים לחזרה של אירוע. |
setColor(color) | Calendar | הגדרת הצבע של היומן. |
setDescription(description) | Calendar | מגדיר את התיאור של היומן. |
setHidden(hidden) | Calendar | מגדירה אם היומן גלוי בממשק המשתמש. |
setName(name) | Calendar | מגדיר את שם היומן. |
setSelected(selected) | Calendar | ההגדרה קובעת אם האירועים ביומן יוצגו בממשק המשתמש. |
setTimeZone(timeZone) | Calendar | מגדיר את אזור הזמן של היומן. |
subscribeToCalendar(id) | Calendar | רישום המשתמש ליומן עם המזהה הנתון, אם למשתמש יש הרשאה להירשם. |
subscribeToCalendar(id, options) | Calendar | רישום המשתמש ליומן עם המזהה הנתון, אם למשתמש יש הרשאה להירשם. |
תיעוד מפורט
createAllDayEvent(title, date)
יצירת אירוע חדש של יום שלם.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969')); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע. |
date | Date | תאריך האירוע (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). |
החזרות
CalendarEvent
– האירוע שנוצר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
יצירת אירוע חדש של יום שלם שיכול להתפרס על כמה ימים.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969')); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע. |
startDate | Date | התאריך שבו האירוע מתחיל (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). |
endDate | Date | התאריך שבו האירוע מסתיים (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). תאריך הסיום בלעדי. |
החזרות
CalendarEvent
– האירוע שנוצר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
יצירת אירוע חדש של יום שלם שיכול להתפרס על כמה ימים.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע. |
startDate | Date | התאריך שבו האירוע מתחיל (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). |
endDate | Date | התאריך שבו האירוע מסתיים (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). תאריך הסיום בלעדי. |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמתואר בהמשך. |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור האירוע. |
location | String | מיקום האירוע. |
guests | String | רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים. |
sendInvites | Boolean | האם לשלוח הזמנות באימייל (ברירת מחדל: false ). |
החזרות
CalendarEvent
– האירוע שנוצר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
יצירת אירוע חדש של יום שלם.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע. |
date | Date | תאריך האירוע (נעשה שימוש רק ביום מסוים, והמערכת מתעלמת מהשעה). |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמתואר בהמשך. |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור האירוע. |
location | String | מיקום האירוע. |
guests | String | רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים. |
sendInvites | Boolean | האם לשלוח הזמנות באימייל (ברירת מחדל: false ). |
החזרות
CalendarEvent
– האירוע שנוצר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
יצירה של סדרת אירועים חדשה של יום שלם.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירועים בסדרה |
startDate | Date | התאריך של האירוע הראשון בסדרה (נעשה שימוש רק ביום מסוים, המערכת מתעלמת מהשעה) |
recurrence | EventRecurrence | הגדרות החזרה של סדרת האירועים |
החזרות
CalendarEventSeries
– סדרת האירועים שנוצרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
יצירה של סדרת אירועים חדשה של יום שלם.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}); Logger.log('Event Series ID: ' + eventSeries.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירועים בסדרה |
startDate | Date | התאריך של האירוע הראשון בסדרה (נעשה שימוש רק ביום מסוים, המערכת מתעלמת מהשעה) |
recurrence | EventRecurrence | הגדרות החזרה של סדרת האירועים |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור האירועים בסדרה |
location | String | מיקום האירועים בסדרה |
guests | String | רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים לאירועים בסדרה |
sendInvites | Boolean | אם לשלוח הזמנות באימייל (ברירת מחדל: false ) |
החזרות
CalendarEventSeries
– סדרת האירועים שנוצרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name)
יוצר יומן חדש שבבעלות המשתמש.
// Creates a new calendar named "Travel Plans". var calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | השם של היומן החדש |
החזרות
Calendar
– היומן החדש שנוצר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name, options)
יוצר יומן חדש שבבעלות המשתמש.
// Creates a new calendar named "Travel Plans" with a summary and color. var calendar = CalendarApp.createCalendar('Travel Plans', { summary: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE }); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | השם של היומן החדש |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
location | String | את המיקום של היומן |
summary | String | תיאור היומן |
timeZone | String | אזור הזמן שבו יש להגדיר את היומן, בפורמט "long" (למשל, "America/New_York", כפי שצוין על ידי Joda.org) |
color | String | מחרוזת צבע הקסדצימאלית ("#rrggbb") או ערך מ-CalendarApp.Colors |
hidden | Boolean | אם היומן מוסתר בממשק המשתמש (ברירת המחדל:
false ) |
selected | Boolean | אם האירועים ביומן מוצגים בממשק המשתמש (ברירת המחדל: true ) |
החזרות
Calendar
– היומן החדש שנוצר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
ייווצר אירוע חדש.
אם לא מציינים אזור זמן, ערכי הזמן מתפרשים בהקשר של אזור הזמן של הסקריפט, שעשוי להיות שונה מאזור הזמן של היומן.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC')); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע |
startTime | Date | התאריך והשעה שבהם האירוע מתחיל |
endTime | Date | התאריך והשעה שבהם האירוע מסתיים |
החזרות
CalendarEvent
– האירוע שנוצר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
ייווצר אירוע חדש.
אם לא מציינים אזור זמן, ערכי הזמן מתפרשים בהקשר של אזור הזמן של הסקריפט, שעשוי להיות שונה מאזור הזמן של היומן.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירוע |
startTime | Date | התאריך והשעה שבהם האירוע מתחיל |
endTime | Date | התאריך והשעה שבהם האירוע מסתיים |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור האירוע |
location | String | מיקום האירוע |
guests | String | רשימה מופרדת בפסיקים של כתובות אימייל שיש להוסיף כאורחים |
sendInvites | Boolean | אם לשלוח הזמנות באימייל (ברירת מחדל: false ) |
החזרות
CalendarEvent
– האירוע שנוצר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
יצירת אירוע מתיאור בניסוח חופשי.
הפורמט של התיאור צריך להיות זהה לזה של התכונה 'הוספה מהירה' בממשק המשתמש.
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור חופשי של האירוע |
החזרות
CalendarEvent
– האירוע שנוצר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
יצירה של סדרת אירועים חדשה.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירועים בסדרה |
startTime | Date | התאריך והשעה שבהם מתחיל האירוע הראשון בסדרה |
endTime | Date | התאריך והשעה שבהם האירוע הראשון בסדרה מסתיים |
recurrence | EventRecurrence | הגדרות החזרה של סדרת האירועים |
החזרות
CalendarEventSeries
– סדרת האירועים שנוצרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
יצירה של סדרת אירועים חדשה.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}); Logger.log('Event Series ID: ' + eventSeries.getId());
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | שם האירועים בסדרה |
startTime | Date | התאריך והשעה שבהם מתחיל האירוע הראשון בסדרה |
endTime | Date | התאריך והשעה שבהם האירוע הראשון בסדרה מסתיים |
recurrence | EventRecurrence | הגדרות החזרה של סדרת האירועים |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
description | String | תיאור האירועים בסדרה |
location | String | מיקום האירועים בסדרה |
guests | String | רשימה מופרדת בפסיקים של כתובות אימייל שצריך להוסיף כאורחים לאירועים בסדרה |
sendInvites | Boolean | אם לשלוח הזמנות באימייל (ברירת מחדל: false ) |
החזרות
CalendarEventSeries
– סדרת האירועים שנוצרה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllCalendars()
קבלת כל היומנים שבבעלות המשתמש או שיש לו מינוי אליהם.
// Determines how many calendars the user can access. var calendars = CalendarApp.getAllCalendars(); Logger.log('This user owns or is subscribed to %s calendars.', calendars.length);
החזרות
Calendar[]
– כל היומנים שהמשתמש יכול לגשת אליהם
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllOwnedCalendars()
קבלת כל היומנים שבבעלות המשתמש.
// Determines how many calendars the user owns. var calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);
החזרות
Calendar[]
– כל היומנים שבבעלות המשתמש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarById(id)
הפונקציה מקבלת את היומן עם המזהה הנתון.
// Gets the public calendar "US Holidays" by ID. var calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String | מזהה היומן |
החזרות
Calendar
- היומן עם המזהה הנתון, או null
אם היומן לא קיים, אם למשתמש אין גישה אליו או אם המשתמש לא רשום ליומן
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarsByName(name)
מקבלת את כל היומנים עם שם פרטי שהמשתמש רשום אליו או שהוא רשום אליו. השמות לא תלויי אותיות רישיות (case-sensitive).
// Gets the public calendar named "US Holidays". var calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם היומן |
החזרות
Calendar[]
– כל היומנים עם השם הזה שלמשתמש יש גישה אליהם
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getColor()
קבלת הצבע של היומן.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the color of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getColor() instead. const calendarColor = calendar.getColor(); console.log(calendarColor);
החזרות
String
- מחרוזת צבע הקסדצימלית ("#rrggbb").
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDefaultCalendar()
מקבלת את יומן ברירת המחדל של המשתמש.
// Determines the time zone of the user's default calendar. var calendar = CalendarApp.getDefaultCalendar(); Logger.log('My default calendar is set to the time zone "%s".', calendar.getTimeZone());
החזרות
Calendar
- יומן ברירת המחדל של המשתמש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
קבלת התיאור של היומן.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the description of the calendar to 'Test description.' calendar.setDescription('Test description'); // Gets the description of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getDescription() instead. const description = calendar.getDescription(); console.log(description);
החזרות
String
- התיאור של היומן הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
הפונקציה מקבלת את האירוע עם המזהה הנתון. אם הסדרה שייכת ליומן אחר שאינו יומן ברירת המחדל, צריך לקרוא לשיטה הזו מאותו יומן. קריאה ל-getEventById(iCalId)
תחזיר אירוע רק ביומן ברירת המחדל.
אם יש כמה אירועים בסדרה, המזהה שלהם יכול להיות זהה. במקרה כזה, השיטה מחזירה רק את האירוע הראשון מהסדרה הזו.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com') // Creates an event for the moon landing. const event = calendar.createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:05:00 UTC'), new Date('July 20, 1969 20:17:00 UTC')); // Gets the calendar event ID and logs it to the console. const iCalId = event.getId(); console.log(iCalId); // Gets the event by its ID and logs the title of the event to the console. // For the default calendar, you can use CalendarApp.getEventById(iCalId) instead. const myEvent = calendar.getEventById(iCalId); console.log(myEvent.getTitle());
פרמטרים
שם | סוג | תיאור |
---|---|---|
iCalId | String | מזהה האירוע. |
החזרות
CalendarEvent
– האירוע עם המזהה הנתון, או null
אם האירוע לא קיים או שלמשתמש אין גישה אליו.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
הפונקציה מקבלת את סדרת האירועים עם המזהה הנתון. אם המזהה שניתן הוא עבור CalendarEvent
יחיד,
מוחזר CalendarEventSeries
עם אירוע אחד בסדרה. שימו לב שאם סדרת האירועים שייכת ליומן אחר שאינו יומן ברירת המחדל, צריך לקרוא לשיטה הזו מה-CalendarApp
הזה. קריאה ל-getEventSeriesById(iCalId)
מחזירה ישירות רק סדרת אירועים הקיימת ביומן ברירת המחדל.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event series for a daily team meeting from 1 PM to 2 PM. // The series adds the daily event from January 1, 2023 through December 31, 2023. const eventSeries = calendar.createEventSeries('Team meeting', new Date('Jan 1, 2023 13:00:00'), new Date('Jan 1, 2023 14:00:00'), CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024'))); // Gets the ID of the event series. const iCalId = eventSeries.getId(); // Gets the event series by its ID and logs the series title to the console. // For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) instead. console.log(calendar.getEventSeriesById(iCalId).getTitle());
פרמטרים
שם | סוג | תיאור |
---|---|---|
iCalId | String | המזהה של סדרת האירועים. |
החזרות
CalendarEventSeries
– הסדרה עם המזהה הנתון, או null
אם הסדרה לא קיימת או שלמשתמש
אין גישה אליה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון.
השיטה הזו מחזירה אירועים שמתחילים במהלך טווח הזמן הנתון, מסתיימים במהלך טווח הזמן או מקיפים את טווח הזמן. אם לא מציינים אזור זמן, ערכי הזמן מתפרשים בהקשר של אזור הזמן של הסקריפט, שיכול להיות שונה מאזור הזמן של היומן.
// Determines how many events are happening in the next two hours. var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log('Number of events: ' + events.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
startTime | Date | תחילת טווח הזמן |
endTime | Date | סוף טווח הזמן, לא כולל |
החזרות
CalendarEvent[]
– האירועים שמתרחשים בטווח הזמן
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
הפונקציה מקבלת את כל האירועים שמתרחשים בטווח זמן נתון ועומדים בקריטריונים שצוינו.
השיטה הזו מחזירה אירועים שמתחילים במהלך טווח הזמן הנתון, מסתיימים במהלך טווח הזמן או מקיפים את טווח הזמן. אם לא מציינים אזור זמן, ערכי הזמן מתפרשים בהקשר של אזור הזמן של הסקריפט, שיכול להיות שונה מאזור הזמן של היומן.
שימו לב שהסינון לפי author
, search
או statusFilters
מתרחש אחרי החלת start
ו-max
. כלומר, מספר האירועים שיוחזרו עשוי להיות קטן מ-max
, על אף שאירועים נוספים עומדים בקריטריונים.
// Determines how many events are happening in the next two hours that contain the term // "meeting". var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
startTime | Date | תחילת טווח הזמן |
endTime | Date | סוף טווח הזמן, לא כולל |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורט בהמשך |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
start | Integer | האינדקס של האירוע הראשון שצריך להחזיר |
max | Integer | המספר המקסימלי של אירועים שיש להחזיר |
author | String | כתובת אימייל המשמשת לסינון תוצאות לפי יוצר האירוע |
search | String | שאילתת חיפוש בטקסט מלא המשמשת לסינון תוצאות |
statusFilters[] | GuestStatus | מערך סטטוסים המשמשים לסינון התוצאות |
החזרות
CalendarEvent[]
— האירועים שמתרחשים בטווח הזמן ומתאימים לקריטריונים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
הפונקציה מקבלת את כל האירועים שמתרחשים ביום נתון.
השיטה הזו מחזירה אירועים אם הם מתחילים במהלך יום מסוים, מסתיימים במהלך היום או מקיפים אותם.
הערה: נעשה שימוש רק בחלק התאריך של האובייקט 'תאריך', והמערכת מתעלמת מהחלק של השעה. התאריך מתפרש מחצות באותו יום עד חצות ביום הבא באזור הזמן של היומן.
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
date | Date | התאריך שעבורו רוצים לאחזר אירועים (המערכת משתמשת רק ביום מסוים, והמערכת מתעלמת מהשעה) |
החזרות
CalendarEvent[]
– האירועים שמתרחשים בתאריך הנתון
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
הפונקציה מקבלת את כל האירועים שמתרחשים ביום מסוים ועומדים בקריטריונים שהוגדרו.
השיטה הזו מחזירה אירועים אם הם מתחילים במהלך יום מסוים, מסתיימים במהלך היום או מקיפים אותם.
הערה: נעשה שימוש רק בחלק התאריך של האובייקט 'תאריך', והמערכת מתעלמת מהחלק של השעה. התאריך מתפרש מחצות באותו יום עד חצות ביום הבא באזור הזמן של היומן.
שימו לב שהסינון לפי author
, search
או statusFilters
מתרחש אחרי החלת start
ו-max
. כלומר, מספר האירועים שיוחזרו עשוי להיות קטן מ-max
, על אף שאירועים נוספים עומדים בקריטריונים.
// Determines how many events are happening today and contain the term "meeting". var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
date | Date | התאריך שעבורו רוצים לאחזר אירועים (המערכת משתמשת רק ביום מסוים, והמערכת מתעלמת מהשעה) |
options | Object | אפשרויות סינון מתקדמות |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
start | Integer | האינדקס של האירוע הראשון שצריך להחזיר |
max | Integer | המספר המקסימלי של אירועים שיש להחזיר |
author | String | כתובת אימייל המשמשת לסינון תוצאות לפי יוצר האירוע |
search | String | שאילתת חיפוש בטקסט מלא המשמשת לסינון תוצאות |
statusFilters[] | GuestStatus | מערך סטטוסים המשמשים לסינון התוצאות |
החזרות
CalendarEvent[]
– האירועים שמתרחשים בתאריך הנתון ומתאימים לקריטריונים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
הפונקציה מקבלת את המזהה של היומן. המזהה של יומן ברירת המחדל של משתמש הוא כתובת האימייל שלו.
// Opens the calendar by its ID. // To get the user's default calendar, use CalendarApp.getDefaultCalendar(). // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the ID of the calendar and logs it to the console. const calendarId = calendar.getId(); console.log(calendarId);
החזרות
String
- מזהה היומן.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
קבלת השם של היומן.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the name of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getName() instead. const calendarName = calendar.getName(); console.log(calendarName);
החזרות
String
– שם היומן הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarById(id)
קבלת היומן עם המזהה הנתון, אם המשתמש הוא הבעלים שלו.
כדי למצוא את מזהה היומן, לוחצים על החץ ליד שם היומן ביומן Google ובוחרים באפשרות הגדרות היומן. המזהה מופיע בחלק התחתון של דף ההגדרות.
// Gets a (non-existent) private calendar by ID. var calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String | מזהה היומן |
החזרות
Calendar
- היומן עם המזהה הנתון, או null
אם היומן לא קיים או שהמשתמש לא הבעלים שלו
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarsByName(name)
קבלת כל היומנים עם שם נתון שבבעלות המשתמש. השמות לא תלויי אותיות רישיות (case-sensitive).
// Gets a private calendar named "Travel Plans". var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם היומן |
החזרות
Calendar[]
– כל היומנים עם השם הזה שבבעלות המשתמש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
הפונקציה מקבלת את אזור הזמן של היומן.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the time zone of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getTimeZone() instead. const timeZone = calendar.getTimeZone(); console.log(timeZone);
החזרות
String
- אזור הזמן, שצוין בפורמט "long" (לדוגמה, "America/New_York", כפי שצוין
על ידי Joda.org).
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
ההגדרה קובעת אם היומן מוסתר בממשק המשתמש.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is hidden in the user interface and logs it to the console. // For the default calendar, you can use CalendarApp.isHidden() instead. const isHidden = calendar.isHidden(); console.log(isHidden);
החזרות
Boolean
- true
אם היומן מוסתר בממשק המשתמש. אם היומן לא מוסתר בממשק המשתמש, false
.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
ההגדרה קובעת אם היומן ישמש כיומן הראשי של המשתמש בפועל.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is the default calendar for // the effective user and logs it to the console. // For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead. const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar(); console.log(isMyPrimaryCalendar);
החזרות
Boolean
- true
אם היומן הוא יומן ברירת המחדל של המשתמש בפועל; false
אם הוא לא יומן ברירת המחדל.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
ההגדרה קובעת אם היומן בבעלותכם.
// Gets a calendar by its ID. To get the user's default calendar, use // CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with the calendar ID that you want to use. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Determines whether the calendar is owned by you and logs it. console.log(calendar.isOwnedByMe());
החזרות
Boolean
- true
אם היומן בבעלותכם; אם לא, false
.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
ההגדרה קובעת אם האירועים ביומן יוצגו בממשק המשתמש.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Determines whether the calendar's events are displayed in the user interface and logs it. console.log(calendar.isSelected());
החזרות
Boolean
- true
אם האירועים ביומן מוצגים בממשק המשתמש; false
אם לא מוצגים אירועים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
newRecurrence()
יוצר אובייקט חזרה חדש, שיכול לשמש ליצירת כללים לחזרה של אירוע.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var recurrence = CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence); Logger.log('Event Series ID: ' + eventSeries.getId());
החזרות
EventRecurrence
- אובייקט חזרה חדש ללא כללים מוגדרים (מתנהג כחזרה שבועית)
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
הגדרת הצבע של היומן.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the color of the calendar to pink using the Calendar Color enum. // For the default calendar, you can use CalendarApp.setColor() instead. calendar.setColor(CalendarApp.Color.PINK);
פרמטרים
שם | סוג | תיאור |
---|---|---|
color | String | CalendarApp.Color או מחרוזת של צבע הקסדצימאלי
("#rrggbb"). |
החזרות
Calendar
– היומן הזה לשרשורים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
מגדיר את התיאור של היומן.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the description of the calendar. // TODO(developer): Update the string with the description that you want to use. calendar.setDescription('Updated calendar description.')
פרמטרים
שם | סוג | תיאור |
---|---|---|
description | String | התיאור של היומן הזה |
החזרות
Calendar
– היומן הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
מגדירה אם היומן גלוי בממשק המשתמש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
hidden | Boolean | true כדי להסתיר את היומן בממשק המשתמש, false כדי להציג אותו |
החזרות
Calendar
– היומן הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
מגדיר את שם היומן.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the name of the calendar. // TODO(developer): Update the string with the name that you want to use. calendar.setName('Example calendar name');
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | השם החדש |
החזרות
Calendar
– היומן הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
ההגדרה קובעת אם האירועים ביומן יוצגו בממשק המשתמש.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Selects the calendar so that its events are displayed in the user interface. To // unselect the calendar, set the parameter to false. calendar.setSelected(true);
פרמטרים
שם | סוג | תיאור |
---|---|---|
selected | Boolean | true כדי להציג את האירועים ביומן בממשק המשתמש; false כדי להסתיר אותם |
החזרות
Calendar
– היומן הזה לשרשורים
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
מגדיר את אזור הזמן של היומן.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the time zone of the calendar to America/New York (US/Eastern) time. calendar.setTimeZone('America/New_York');
פרמטרים
שם | סוג | תיאור |
---|---|---|
timeZone | String | אזור הזמן, שצוין בפורמט "long" (למשל, "America/New_York", כפי שרשום על ידי Joda.org). |
החזרות
Calendar
– היומן הזה לשרשורים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id)
רישום המשתמש ליומן עם המזהה הנתון, אם למשתמש יש הרשאה להירשם.
// Subscribe to the calendar "US Holidays". var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String | המזהה של היומן שאליו צריך להירשם |
החזרות
Calendar
– ההרשמה החדשה ליומן
קליעות
Error
– אם אין יומן עם המזהה הזה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id, options)
רישום המשתמש ליומן עם המזהה הנתון, אם למשתמש יש הרשאה להירשם.
// Subscribe to the calendar "US Holidays", and set it to the color blue. var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', { color: CalendarApp.Color.BLUE }); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String | המזהה של היומן שאליו צריך להירשם. |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמתואר בהמשך. |
פרמטרים מתקדמים
שם | סוג | תיאור |
---|---|---|
color | String | מחרוזת צבע הקסדצימלית ("#rrggbb") או ערך מ-CalendarApp.Colors . |
hidden | Boolean | האם היומן מוסתר בממשק המשתמש (ברירת המחדל: false ). |
selected | Boolean | האם האירועים ביומן מוצגים בממשק המשתמש (ברירת המחדל: true אם מציינים גם color , אחרת false ). |
החזרות
Calendar
– היומן החדש שנרשמתם אליו.
קליעות
Error
– אם אין יומן עם המזהה הזה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה באחד או יותר מההיקפים הבאים או בהיקפים המתאימים מה-API ל-REST הרלוונטי:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds