CalendarList: insert

הערה: נדרשת הרשאה.

הוספה של יומן קיים לרשימת היומנים של המשתמש. רוצים לנסות?

בקשה

בקשת HTTP

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים אופציונליים של שאילתות
colorRgbFormat	boolean	האם להשתמש בשדות foregroundColor ו-backgroundColor כדי לכתוב את צבעים ביומן (RGB). אם משתמשים בתכונה הזו, השדה colorId שמבוסס על האינדקס יוגדר באופן אוטומטי לאפשרות ההתאמה הטובה ביותר. אופציונלי. ברירת המחדל היא False.

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist

מידע נוסף זמין בדף אימות והרשאה.

גוף הבקשה

בגוף הבקשה, מספקים משאב CalendarList עם המאפיינים הבאים:

שם הנכס	ערך	תיאור	הערות
מאפיינים נדרשים
id	string	המזהה של היומן.
מאפיינים אופציונליים
backgroundColor	string	הצבע הראשי של היומן בפורמט הקסדצימלי '#0088aa'. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, ‏ update ו-patch. אופציונלי.	לכתיבה
colorId	string	הצבע של היומן. זהו מזהה שמתייחס לרשומה בקטע calendar של הגדרת הצבעים (ראו נקודת הקצה colors). המאפיין הזה הוחלף במאפיינים backgroundColor ו-foregroundColor, וניתן להתעלם ממנו כשמשתמשים במאפיינים האלה. אופציונלי.	לכתיבה
defaultReminders[]	list	תזכורות ברירת המחדל של המשתמש המאומת ביומן הזה.	לכתיבה
defaultReminders[].method	string	השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם: 'email' – התזכורות נשלחות באימייל. 'popup' – התזכורות נשלחות דרך חלון קופץ בממשק המשתמש. נדרש כשמוסיפים תזכורת.	לכתיבה
defaultReminders[].minutes	integer	מספר הדקות לפני תחילת האירוע שבהן התזכורת אמורה להופיע. הערכים התקפים הם בין 0 ל-40320 (4 שבועות בדקות). נדרש כשמוסיפים תזכורת.	לכתיבה
foregroundColor	string	צבע החזית של היומן בפורמט הקסדצימלי '#ffffff'. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, ‏ update ו-patch. אופציונלי.	לכתיבה
hidden	boolean	אם היומן הוסתר מהרשימה. אופציונלי. המאפיין מוחזר רק כשהיומן מוסתר, ובמקרה כזה הערך הוא true.	לכתיבה
notificationSettings	object	ההתראות שהמשתמש המאומת מקבל ביומן הזה.	לכתיבה
notificationSettings.notifications[].method	string	השיטה שבה ההתראה נשלחת. הערך האפשרי הוא: 'email' – ההתראות נשלחות באימייל. נדרש כשמוסיפים התראה.	לכתיבה
notificationSettings.notifications[].type	string	סוג ההתראה. הערכים האפשריים הם: eventCreation – התראה שנשלחת כשאירוע חדש מתווסף ליומן. 'eventChange' – התראה שנשלחת כשאירוע משתנה. 'eventCancellation' – התראה שנשלחת כשאירוע מבוטל. eventResponse – התראה שנשלחת כשמשתתף משיב להזמנה לאירוע. 'agenda' – יומן עם האירועים של היום (נשלח בבוקר). נדרש כשמוסיפים התראה.	לכתיבה
selected	boolean	אם תוכן היומן יופיע בממשק המשתמש של היומן. אופציונלי. ברירת המחדל היא False.	לכתיבה
summaryOverride	string	הסיכום שהמשתמש המאומת הגדיר ליומן הזה. אופציונלי.	לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב CalendarList בגוף התגובה.

נסה בעצמך!

אפשר להשתמש בכלי הבדיקה של ממשקי ה-API שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.