דף זה תורגם על ידי Cloud Translation API.

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`

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

גוף הבקשה

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

תשובה

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

{
  "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`' – המשתמש הוא הבעלים של היומן. לתפקיד הזה יש את כל ההרשאות של תפקיד הכתיבה, עם היכולת הנוספת לראות ולבצע פעולות ברשימות ACL.
`defaultReminders[]`	`list`	תזכורות ברירת המחדל ביומן של המשתמש המאומת. התזכורות האלה חלות על כל האירועים ביומן הזה שלא מבטלים אותן במפורש (כלומר, לא הוגדרה ל-`reminders.useDefault` הערך True).
`defaultReminders[].method`	`string`	השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם: '`email`' – התזכורות נשלחות באימייל. '`popup`' – התזכורות נשלחות דרך חלון קופץ בממשק המשתמש. נדרש כשמוסיפים תזכורת.	לכתיבה
`defaultReminders[].minutes`	`integer`	מספר הדקות לפני תחילת האירוע שבהן התזכורת אמורה להופיע. הערכים התקפים הם בין 0 ל-40320 (4 שבועות בדקות). נדרש כשמוסיפים תזכורת.	לכתיבה
`nextPageToken`	`string`	אסימון המשמש לגישה לדף הבא של התוצאה הזו. השדה הזה לא מופיע אם אין תוצאות נוספות, ובמקרה כזה מוצג הערך `nextSyncToken`.
`items[]`	`list`	רשימת האירועים ביומן.
`nextSyncToken`	`string`	אסימון שמשמש בשלב מאוחר יותר כדי לאחזר רק את הרשומות שהשתנו מאז שהתוצאה הזו הוחזרה. השדה הזה לא מוצג אם יש תוצאות נוספות, ובמקרה כזה מוצג הערך `nextPageToken`.

נסה בעצמך!

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