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': לא נשלחות התראות. במשימות של העברת יומנים, מומלץ להשתמש במקום זאת בשיטה Events.import.

אישור

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

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

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

גוף הבקשה

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

תשובה

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

דוגמאות

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

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

נסה בעצמך!

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