מחזירה מופעים של האירוע החוזר שצוין. אפשר לנסות עכשיו או לראות דוגמה.
בקשה
בקשת HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
פרמטרים
שם הפרמטר | Value | התיאור |
---|---|---|
פרמטרים של נתיב | ||
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 ] }
שם הנכס | Value | התיאור | הערות |
---|---|---|---|
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 שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.