Events: instances

מחזירה מופעים של האירוע החוזר שצוין. רוצים לנסות?

בקשה

בקשת 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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

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

גוף הבקשה

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

תשובה

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

{
  "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 תפקיד הגישה של המשתמש ליומן הזה. קריאה בלבד. הערכים האפשריים הם:
  • ‫none – למשתמש אין גישה.
  • ‫freeBusyReader – למשתמש יש הרשאת גישה לקריאת מידע על זמינות.
  • ‫reader – למשתמש יש גישת קריאה ליומן. אירועים פרטיים יופיעו למשתמשים עם גישת קריאה, אבל פרטי האירועים יוסתרו.
  • ‫writer – למשתמש יש גישת קריאה וכתיבה ליומן. אירועים פרטיים יופיעו למשתמשים עם גישת כתיבה, ופרטי האירוע יהיו גלויים.
  • ‫owner – למשתמש יש גישת ניהול ליומן. לתפקיד הזה יש את כל ההרשאות של תפקיד הכותב, עם היכולת הנוספת לראות ולשנות את רמות הגישה של משתמשים אחרים.

    .
defaultReminders[] list תזכורות ברירת המחדל ביומן למשתמש המאומת. התזכורות האלה חלות על כל האירועים ביומן שלא מוגדרים בהם ערכים שסותרים את התזכורות האלה (כלומר, לא מוגדר בהם reminders.useDefault הערך True).
defaultReminders[].method string השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
  • ‫email – התזכורות נשלחות באימייל.
  • ‫popup – התזכורות נשלחות באמצעות חלון קופץ בממשק המשתמש.

חובה כשמוסיפים תזכורת.

 ניתן לכתיבה
defaultReminders[].minutes integer מספר הדקות לפני תחילת האירוע שבהן התזכורת צריכה לפעול. הערכים התקינים הם בין 0 ל-40320 (4 שבועות בדקות).

חובה כשמוסיפים תזכורת.

 ניתן לכתיבה
nextPageToken string אסימון שמשמש לגישה לדף הבא של התוצאה הזו. המאפיין מושמט אם אין תוצאות נוספות, ובמקרה כזה מופיע nextSyncToken.
items[] list רשימת האירועים ביומן.
nextSyncToken string אסימון שמשמש בשלב מאוחר יותר כדי לאחזר רק את הרשומות שהשתנו מאז שהתוצאה הזו הוחזרה. המאפיין הזה לא מופיע אם יש תוצאות נוספות. במקרה כזה, מופיע nextPageToken.

רוצה לנסות?

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