Events: quickAdd

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

בקשה

בקשת HTTP

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

פרמטרים

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

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

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

אישור

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

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

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

גוף הבקשה

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

תשובה

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

דוגמאות

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

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 שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.