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 حداکثر تعداد رویدادهایی که در یک صفحه نتیجه نمایش داده می‌شوند. به طور پیش‌فرض، مقدار ۲۵۰ رویداد است. اندازه صفحه هرگز نمی‌تواند بزرگتر از ۲۵۰۰ رویداد باشد. اختیاری.
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 برچسب الکترونیکی مجموعه.
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 تعداد دقایق قبل از شروع رویداد که یادآوری باید فعال شود. مقادیر معتبر بین ۰ تا ۴۰۳۲۰ (۴ هفته به دقیقه) هستند.

هنگام اضافه کردن یادآوری الزامی است.

 قابل نوشتن
nextPageToken string توکنی که برای دسترسی به صفحه بعدی این نتیجه استفاده می‌شود. در صورت عدم وجود نتایج بیشتر، حذف می‌شود، در این صورت nextSyncToken ارائه می‌شود.
items[] list فهرست مناسبت‌ها در تقویم.
nextSyncToken string توکنی که در برهه‌ای از زمان برای بازیابی فقط ورودی‌هایی که از زمان برگرداندن این نتیجه تغییر کرده‌اند، استفاده شده است. در صورت موجود بودن نتایج بیشتر، حذف می‌شود که در این صورت nextPageToken ارائه می‌شود.

امتحانش کن!

از API Explorer زیر برای فراخوانی این متد روی داده‌های زنده و مشاهده پاسخ استفاده کنید.