Events: quickAdd

יוצרת אירוע על סמך מחרוזת טקסט פשוטה. אפשר לנסות עכשיו או לראות דוגמה.

בקשה

בקשת HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/quickAdd

פרמטרים

שם הפרמטר Value התיאור
פרמטרים של נתיב
calendarId string מזהה היומן. כדי לאחזר מזהי יומנים, צריך לקרוא לשיטה calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, צריך להשתמש במילת המפתח "primary".
הפרמטרים הנדרשים של השאילתה
text string טקסט שמתאר את האירוע שצריך ליצור.
פרמטרים אופציונליים של שאילתה
sendNotifications boolean הוּצא משימוש. במקומו צריך להשתמש ב-sendUpdates.

כדי לשלוח התראות על יצירת האירוע. לתשומת ליבך, יכול להיות שחלק מהאימיילים עדיין יישלחו גם אם הערך שהגדרת הוא false. ברירת המחדל היא false.
sendUpdates string משתתפים שאמורים לקבל התראות על יצירת אירוע חדש.

הערכים הקבילים הם:
  • "all": ההתראות נשלחות לכל האורחים.
  • 'externalOnly': ההתראות נשלחות רק למשתתפים שלא משתמשים ביומן Google.
  • 'none': לא נשלחו התראות. למשימות העברה של יומן, מומלץ להשתמש במקום זאת בשיטה Events.import.

הרשאות

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

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

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

גוף הבקשה

אל תספקו גוף הבקשה בשיטה הזו.

תשובה

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

דוגמאות

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

Java

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

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Quick-add an event
String eventText = "Appointment at Somewhere on June 3rd 10am-10:25am";
Event createdEvent =
    service.events().quickAdd('primary').setText(eventText).execute();

System.out.println(createdEvent.getId());

Python

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

created_event = service.events().quickAdd(
    calendarId='primary',
    text='Appointment at Somewhere on June 3rd 10am-10:25am').execute()

print created_event['id']

PHP

נעשה שימוש בספריית הלקוח של PHP.

$createdEvent = $service->events->quickAdd(
    'primary',
    'Appointment at Somewhere on June 3rd 10am-10:25am');

echo $createdEvent->getId();

Ruby

נעשה שימוש בספריית הלקוח של Ruby.

result = client.quick_add_event(
  'primary',
  'Appointment at Somewhere on June 3rd 10am-10:25am')
print result.id

רוצה לנסות?

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