הוספת יומן קיים לרשימת היומנים של המשתמש. רוצים לנסות? או לעיון בדוגמה
בקשה
בקשת 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 |
השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
נדרש כשמוסיפים תזכורת. |
לכתיבה |
defaultReminders[].minutes |
integer |
מספר הדקות לפני תחילת האירוע שבהן התזכורת אמורה להופיע. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). נדרש כשמוסיפים תזכורת. |
לכתיבה |
foregroundColor |
string |
צבע החזית של היומן בפורמט הקסדצימלי '#ffffff '. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, update ו-patch. זה שינוי אופציונלי. |
לכתיבה |
notificationSettings |
object |
ההתראות שהמשתמש המאומת מקבל ביומן הזה. | לכתיבה |
notificationSettings.notifications[].method |
string |
השיטה שבה ההתראה נשלחת. הערך האפשרי הוא:
נדרש כשמוסיפים התראה. |
לכתיבה |
notificationSettings.notifications[].type |
string |
סוג ההתראה. הערכים האפשריים הם:
נדרש כשמוסיפים התראה. |
לכתיבה |
selected |
boolean |
אם תוכן היומן יופיע בממשק המשתמש של היומן. זה שינוי אופציונלי. ברירת המחדל היא False. | לכתיבה |
summaryOverride |
string |
הסיכום שהמשתמש המאומת הגדיר ביומן הזה. זה שינוי אופציונלי. | לכתיבה |
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב CalendarList בגוף התגובה.
דוגמאות
הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).
Java
משתמשת בספריית הלקוח של Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Create a new calendar list entry CalendarListEntry calendarListEntry = new CalendarListEntry(); calendarListEntry.setId("calendarId"); // Insert the new calendar list entry CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute(); System.out.println(createdCalendarListEntry.getSummary());
Python
משתמשים בספריית הלקוח של Python.
calendar_list_entry = { 'id': 'calendarId' } created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute() print created_calendar_list_entry['summary']
PHP
שימוש בספריית הלקוח של PHP.
$calendarListEntry = new Google_Service_Calendar_CalendarListEntry(); $calendarListEntry->setId("calendarId"); $createdCalendarListEntry = $service->calendarList->insert($calendarListEntry); echo $createdCalendarListEntry->getSummary();
Ruby
משתמשת בספריית הלקוח של Ruby.
entry = Google::Apis::CalendarV3::CalendarListEntry.new( id: 'calendarId' ) result = client.insert_calendar_list(entry) print result.summary
נסה בעצמך!
אפשר להשתמש ב-API Explorer שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.