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

למידע נוסף, עיינו בדף אימות והרשאה.

גוף הבקשה

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

שם הנכס ערך תיאור הערות
מאפייני חובה
id string מזהה היומן.
מאפיינים אופציונליים
backgroundColor string הצבע העיקרי של היומן בפורמט ההקסדצימלי "#0088aa". הנכס הזה מחליף את המאפיין colorId המבוסס על אינדקס. כדי להגדיר או לשנות את הנכס הזה, עליך לציין את colorRgbFormat=true בפרמטרים של השיטות הוספה, עדכון ותיקון. אופציונלי. ניתן לכתיבה
colorId string הצבע של היומן. זהו מזהה ההפניה לרשומה בקטע calendar של הגדרת הצבעים (מידע נוסף זמין בנקודת הקצה של הצבעים). הנכס הזה הוחלף על ידי הנכסים backgroundColor ו-foregroundColor ואפשר להתעלם ממנו כשמשתמשים בנכסים האלה. אופציונלי. ניתן לכתיבה
defaultReminders[] list תזכורות ברירת המחדל שיש למשתמש המאומת עבור היומן הזה. ניתן לכתיבה
defaultReminders[].method string השיטה שבה נעשה שימוש בתזכורת זו. הערכים האפשריים הם:
  • "email" – התזכורות נשלחות באימייל.
  • "popup" – התזכורות נשלחות דרך חלון קופץ בממשק המשתמש.

נדרש כשמוסיפים תזכורת.

 ניתן לכתיבה
defaultReminders[].minutes integer מספר הדקות לפני תחילת האירוע שבו התזכורת צריכה להתחיל. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות).

נדרש כשמוסיפים תזכורת.

 ניתן לכתיבה
foregroundColor string הצבע החזיתי של היומן בפורמט ההקסדצימלי "#ffffff". הנכס הזה מחליף את המאפיין colorId המבוסס על אינדקס. כדי להגדיר או לשנות את הנכס הזה, עליך לציין את colorRgbFormat=true בפרמטרים של השיטות הוספה, עדכון ותיקון. אופציונלי. ניתן לכתיבה
hidden boolean אם היומן הוסתר מהרשימה. אופציונלי. המאפיין מוחזר רק כאשר היומן מוסתר, ובמקרה זה הערך הוא true. ניתן לכתיבה
notificationSettings object ההתראות שהמשתמש המאומת מקבל עבור היומן הזה. ניתן לכתיבה
notificationSettings.notifications[].method string השיטה שמשמשת לשליחת ההתראה. הערך האפשרי הוא:
  • "email" – ההתראות נשלחות באימייל.

נדרש כשמוסיפים התראה.

 ניתן לכתיבה
notificationSettings.notifications[].type string סוג ההתראה. הערכים האפשריים הם:
  • "eventCreation" - ההודעה נשלחה כשאירוע חדש מוצב ביומן.
  • "eventChange" – התראה נשלחת כשאירוע משתנה.
  • "eventCancellation" – ההתראה נשלחת כשאירוע מבוטל.
  • "eventResponse" – התראה נשלחת כשמשתתף מגיב להזמנה לאירוע.
  • "agenda" - סדר יום עם אירועי היום (נשלח בבוקר).

נדרש כשמוסיפים התראה.

 ניתן לכתיבה
selected boolean אם התוכן של היומן יופיע בממשק המשתמש של היומן. אופציונלי. ברירת המחדל היא False. ניתן לכתיבה
summaryOverride string הסיכום שהמשתמש המאומת הגדיר עבור היומן הזה. אופציונלי. ניתן לכתיבה

תשובה

אם הצלחת, בשיטה הזו מוחזר משאב ListList בגוף התגובה.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

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

משתמש בספריית הלקוחות של Rubby.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

רוצה לנסות?

כדי לקרוא לשיטה הזו על נתונים בזמן אמת ולראות את התגובה, צריך להשתמש ב-APIs Explorer בהמשך.