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 حدثًا. لا يمكن أن يتجاوز حجم الصفحة 2500 حدث. اختيارية:
originalStart string تمثّل هذه السمة وقت البدء الأصلي للمثيل في النتيجة. اختيارية:
pageToken string رمز مميز يحدّد صفحة النتائج المطلوب عرضها. اختيارية:
showDeleted boolean تحديد ما إذا كان سيتم تضمين الأحداث المحذوفة (التي تكون فيها قيمة status مساوية لـ "cancelled") في النتيجة سيظلّ يتم تضمين الأحداث الملغاة من الأحداث المتكرّرة إذا كانت قيمة singleEvents هي "خطأ". اختيارية: القيمة التلقائية هي 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 على "صحيح").
defaultReminders[].method string الطريقة التي يستخدمها هذا التذكير. القيم المحتمَلة هي:
  • email: يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup": يتم إرسال التذكيرات من خلال نافذة منبثقة في واجهة المستخدم.

يجب توفيرها عند إضافة تذكير.

 قابل للكتابة
defaultReminders[].minutes integer عدد الدقائق قبل بدء الحدث عندما يجب أن يتم تشغيل التذكير. تتراوح القيم الصالحة بين 0 و40320 (4 أسابيع بالدقائق).

يجب توفيرها عند إضافة تذكير.

 قابل للكتابة
nextPageToken string الرمز المميز المستخدَم للوصول إلى الصفحة التالية من هذه النتيجة يتم حذفها في حال عدم توفّر نتائج إضافية، وفي هذه الحالة يتم تقديم nextSyncToken.
items[] list قائمة بالأحداث في التقويم
nextSyncToken string الرمز المميز المستخدَم في وقت لاحق لاسترداد الإدخالات التي تم تغييرها فقط منذ عرض هذه النتيجة يتم حذفها إذا كانت تتوفّر نتائج إضافية، وفي هذه الحالة يتم تقديم nextPageToken.

جرِّبها الآن.

استخدِم "مستكشف واجهات برمجة التطبيقات" أدناه لطلب البيانات من خلال هذه الطريقة والاطّلاع على الردّ.