מחזירה מופעים של האירוע החוזר שצוין. אפשר לנסות עכשיו או לראות דוגמה.
בקשה
בקשת HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים של נתיב | ||
calendarId |
string |
מזהה היומן. כדי לאחזר מזהי יומנים, צריך להפעיל את השיטה calendarList.list. כדי להיכנס ליומן הראשי של המשתמש שמחובר כרגע, אפשר להשתמש באפשרות 'primary ' במילת מפתח.
|
eventId |
string |
מזהה אירוע חוזר. |
פרמטרים אופציונליים של שאילתה | ||
alwaysIncludeEmail |
boolean |
הוצא משימוש והמערכת התעלמה ממנו. תמיד יוחזר ערך בשדה email עבור המארגן, היוצר והמשתתפים, גם אם לא קיימת כתובת אימייל אמיתית (כלומר, יסופק ערך שנוצר שלא פועל).
|
maxAttendees |
integer |
מספר המשתתפים המקסימלי שאפשר לכלול בתשובה. אם מספר המשתתפים גדול ממספר המשתתפים שצוין, רק המשתתף יוחזר. זה שינוי אופציונלי. |
maxResults |
integer |
המספר המקסימלי של אירועים שהוחזרו בדף תוצאות אחד. כברירת מחדל, הערך הוא 250 אירועים. גודל הדף לא יכול להיות גדול מ-2,500 אירועים. זה שינוי אופציונלי. |
originalStart |
string |
שעת ההתחלה המקורית של המופע בתוצאה. זה שינוי אופציונלי. |
pageToken |
string |
אסימון שמציין איזה דף תוצאות להחזיר. זה שינוי אופציונלי. |
showDeleted |
boolean |
האם לכלול אירועים שנמחקו (עם status שווה "cancelled ") בתוצאה. מופעים שבוטלו של אירועים חוזרים עדיין ייכללו אם הערך של singleEvents הוא False. זה שינוי אופציונלי. ערך ברירת המחדל הוא False.
|
timeMax |
datetime |
גבול עליון (לא כולל) לשעת ההתחלה של אירוע כדי לסנן לפיו. זה שינוי אופציונלי. ברירת המחדל היא לא לסנן לפי שעת ההתחלה. חייבת לכלול חותמת זמן מסוג RFC3339 עם הבדלי זמן קבועים בין אזורי זמן. |
timeMin |
datetime |
גבול תחתון (כולל) של שעת סיום של אירוע שלפיו יש לסנן. זה שינוי אופציונלי. ברירת המחדל היא לא לסנן לפי שעת סיום. חייבת לכלול חותמת זמן מסוג RFC3339 עם הבדלי זמן קבועים בין אזורי זמן. |
timeZone |
string |
אזור הזמן שמוגדר בתשובה. זה שינוי אופציונלי. ברירת המחדל היא אזור הזמן של היומן. |
אישור
הבקשה הזו מאפשרת הרשאה עם לפחות אחד מההיקפים הבאים:
היקף |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
מידע נוסף זמין בדף אימות והרשאה.
גוף הבקשה
אל תספקו גוף בקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{ "kind": "calendar#events", "etag": etag, "summary": string, "description": string, "updated": datetime, "timeZone": string, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "nextPageToken": string, "nextSyncToken": string, "items": [ events Resource ] }
שם הנכס | ערך | תיאור | הערות |
---|---|---|---|
kind |
string |
סוג האוסף ("calendar#events "). |
|
etag |
etag |
ה-ETag של האוסף. | |
summary |
string |
שם היומן. קריאה בלבד. | |
description |
string |
תיאור היומן. קריאה בלבד. | |
updated |
datetime |
מועד השינוי האחרון של היומן (כחותמת זמן של RFC3339). קריאה בלבד. | |
timeZone |
string |
אזור הזמן של היומן. קריאה בלבד. | |
accessRole |
string |
הרשאת הגישה של המשתמש ליומן הזה. קריאה בלבד. הערכים האפשריים הם:
|
|
defaultReminders[] |
list |
תזכורות ברירת המחדל ביומן של המשתמש המאומת. התזכורות האלה חלות על כל האירועים ביומן הזה שלא מבטלים אותן במפורש (כלומר, לא הגדרת את reminders.useDefault כ-True). |
|
defaultReminders[].method |
string |
השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
חובה בעת הוספת תזכורת. |
ניתן לכתיבה |
defaultReminders[].minutes |
integer |
מספר הדקות לפני תחילת האירוע שבו התזכורת אמורה להתחיל. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). חובה בעת הוספת תזכורת. |
ניתן לכתיבה |
nextPageToken |
string |
האסימון שמשמש לגישה לדף הבא בתוצאה הזו. נמחק אם אין תוצאות נוספות. במקרה כזה, תספק nextSyncToken . |
|
items[] |
list |
רשימת האירועים ביומן. | |
nextSyncToken |
string |
אסימון שייעשה בו שימוש בשלב מאוחר יותר כדי לאחזר רק את הערכים שהשתנו מאז שהתוצאה הזו הוחזרה. הפונקציה לא מוצגת אם יש תוצאות נוספות. במקרה כזה, תספקו את nextPageToken . |
דוגמאות
הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).
Java
משתמש בספריית הלקוח של Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the instances of a specific recurring event String pageToken = null; do { Events events = service.events().instances('primary', 'eventId').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
משתמש בספריית הלקוח של Python.
page_token = None while True: events = service.events().instances(calendarId='primary', eventId='eventId', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
PHP
משתמש בספריית הלקוח של PHP.
$events = $service->events->instances('primary', "eventId"); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->instances('primary', "eventId", $optParams); } else { break; } }
Ruby
משתמש בספריית הלקוח של Ruby.
page_token = nil begin result = client.list_event_instances('primary', 'eventId') result.items.each do |e| print e.summary + "\n" end if result.next_page_token != page_token page_token = result.next_page_token else page_token = nil end end while !page_token.nil?
נסה בעצמך!
אפשר להשתמש ב-APIs Explorer שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.