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 تحقَّق من حدوث تغييرات في موارد قائمة التحكم بالوصول.

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 استيراد حدث تُستخدم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم.
إدراج 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.

مَعلمات طلب البحث المطلوبة: 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 تحقَّق من التغييرات التي تطرأ على موارد "الإعدادات".