API Reference

يتم تنظيم مرجع واجهة برمجة التطبيقات هذا حسب نوع المورد. يحتوي كل نوع من أنواع الموارد على تمثيل بيانات واحد أو أكثر وطريقة واحدة أو أكثر.

أنواع الموارد

  1. قائمة التحكم في الوصول (Acl)
  2. CalendarList
  3. التقاويم
  4. القنوات
  5. الألوان
  6. الأحداث
  7. متوفّر مشغول
  8. الإعدادات

Acl

للحصول على تفاصيل موارد Acl، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
حذف DELETE  /calendars/calendarId/acl/ruleId حذف قاعدة تحكُّم بالوصول.
الحصول على GET  /calendars/calendarId/acl/ruleId تعرض قاعدة تحكُّم بالوصول.
إدراج POST  /calendars/calendarId/acl ينشئ قاعدة تحكُّم بالوصول.
list GET  /calendars/calendarId/acl عرض القواعد في قائمة التحكم بالوصول إلى التقويم.
تصحيح PATCH  /calendars/calendarId/acl/ruleId لتعديل قاعدة تحكُّم بالوصول. تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدِّدها في الطلب بدون تغيير. تستبدل حقول الصفيف، إذا تم تحديدها، الصفائف الحالية، مما يؤدي إلى تجاهل أي عناصر صفيف سابقة.
تعديل PUT  /calendars/calendarId/acl/ruleId لتعديل قاعدة تحكُّم بالوصول.
ساعة POST  /calendars/calendarId/acl/watch راقب التغييرات التي تطرأ على موارد قائمة التحكم بالوصول (ACL).

CalendarList

بالنسبة إلى تفاصيل موارد CalendarList، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
حذف DELETE  /users/me/calendarList/calendarId إزالة تقويم من قائمة التقاويم لدى المستخدم
الحصول على GET  /users/me/calendarList/calendarId لعرض تقويم من قائمة تقويم المستخدم.
إدراج POST  /users/me/calendarList لإدراج تقويم حالي في قائمة تقاويم المستخدم.
list GET  /users/me/calendarList عرض التقاويم في قائمة تقاويم المستخدم
تصحيح PATCH  /users/me/calendarList/calendarId تعديل تقويم حالي في قائمة تقاويم المستخدم تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدِّدها في الطلب بدون تغيير. تستبدل حقول الصفيف، إذا تم تحديدها، الصفائف الحالية، مما يؤدي إلى تجاهل أي عناصر صفيف سابقة.
تعديل PUT  /users/me/calendarList/calendarId تعديل تقويم حالي في قائمة تقاويم المستخدم
ساعة POST  /users/me/calendarList/watch ترقُّب التغييرات التي يتم إجراؤها على موارد CalendarList.

خدمات طباعة التقويم

لمعرفة تفاصيل مورد "التقاويم"، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
محو POST  /calendars/calendarId/clear يؤدي إلى محو تقويم أساسي. تؤدي هذه العملية إلى حذف جميع الأحداث المرتبطة بالتقويم الأساسي لحساب معيّن.
حذف DELETE  /calendars/calendarId حذف تقويم ثانوي. استخدِم calendar.clear لمحو جميع الأحداث في التقاويم الأساسية.
الحصول على GET  /calendars/calendarId تعرض البيانات الوصفية لتقويم.
إدراج POST  /calendars إنشاء تقويم ثانوي.
تصحيح PATCH  /calendars/calendarId لتعديل البيانات الوصفية لتقويم تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدِّدها في الطلب بدون تغيير. تستبدل حقول الصفيف، إذا تم تحديدها، الصفائف الحالية، مما يؤدي إلى تجاهل أي عناصر صفيف سابقة.
تعديل PUT  /calendars/calendarId لتعديل البيانات الوصفية لتقويم

القنوات

بالنسبة إلى تفاصيل موارد القنوات، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
إيقاف POST  /channels/stop التوقّف عن مشاهدة المراجع من خلال هذه القناة

الألوان

للحصول على تفاصيل مورد الألوان، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
الحصول على GET  /colors عرض تعريفات الألوان للتقاويم والأحداث

فعاليات

بالنسبة إلى تفاصيل موارد الأحداث، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
حذف DELETE  /calendars/calendarId/events/eventId لحذف حدث
الحصول على GET  /calendars/calendarId/events/eventId لعرض حدث استنادًا إلى معرّف "تقويم Google" الخاص به. لاسترداد حدث باستخدام معرّف iالتقويم، يمكنك استدعاء طريقةevents.list باستخدام مَعلمة iCalUID.
import POST  /calendars/calendarId/events/import لاستيراد حدث. تُستخدم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. لا يمكن استيراد سوى الأحداث التي تحتوي على eventType من default.

السلوك المتوقّف نهائيًا: إذا تم استيراد حدث ليس "default"، سيتم تغيير نوعه إلى "default" وسيتم استبعاد أي خصائص من نوع الحدث قد تكون مدرَجة.
إدراج POST  /calendars/calendarId/events لإنشاء حدث.
المثيلات GET  /calendars/calendarId/events/eventId/instances تعرِض هذه السمة مثيلاً من الحدث المتكرّر المحدَّد.
list GET  /calendars/calendarId/events عرض الأحداث في التقويم المحدّد.
نقل POST  /calendars/calendarId/events/eventId/move نقل حدث إلى تقويم آخر، أي تغيير منظِّم الحدث تجدر الإشارة إلى أنّه لا يمكن نقل سوى default حدث، أي أنّه لا يمكن نقل أحداث outOfOffice وfocusTime وworkingLocation وfromGmail.

مَعلمات طلب البحث المطلوبة: destination

تصحيح PATCH  /calendars/calendarId/events/eventId لتعديل حدث تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدِّدها في الطلب بدون تغيير. تستبدل حقول الصفيف، إذا تم تحديدها، الصفائف الحالية، مما يؤدي إلى تجاهل أي عناصر صفيف سابقة.
quickAdd POST  /calendars/calendarId/events/quickAdd تنشئ حدثًا استنادًا إلى سلسلة نصية بسيطة.

مَعلمات طلب البحث المطلوبة: text

تعديل PUT  /calendars/calendarId/events/eventId لتعديل حدث لا تتيح هذه الطريقة دلالات التصحيح وتعمل دائمًا على تحديث مورد الحدث بالكامل. لإجراء تعديل جزئي، عليك تنفيذ عملية get متبوعة بالرمز update باستخدام علامات etag لضمان تقسيم قيم الذرة.
ساعة POST  /calendars/calendarId/events/watch ترقُّب التغييرات في موارد الأحداث.

متوفّر

لمعرفة تفاصيل مورد "متوفّر مشغول"، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
طلب البحث POST  /freeBusy لعرض معلومات الحالة متوفّر/مشغول لمجموعة من التقاويم.

الإعدادات

لمعرفة تفاصيل مورد الإعدادات، يُرجى الاطّلاع على صفحة تمثيل الموارد.

الطريقة طلب HTTP الوصف
معرّفات الموارد المنتظمة (URI) المرتبطة بـ https://www.googleapis.com/calendar/v3، ما لم يُذكر خلاف ذلك
الحصول على GET  /users/me/settings/setting تعرِض هذه السمة إعداد مستخدم واحد.
list GET  /users/me/settings عرض جميع إعدادات المستخدم للمستخدم الذي تمت المصادقة عليه.
ساعة POST  /users/me/settings/watch يمكنك ملاحظة التغييرات التي تطرأ على موارد الإعدادات.