API Reference

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

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

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

قائمة التحكم في الوصول

للحصول على تفاصيل مورد 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، اطلع على صفحة تمثيل المورد.

الطريقة طلب 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. لاسترداد حدث باستخدام معرّف iCalendar، يمكنك استدعاء طريقة event.list باستخدام المعلمة iCalUID.
استيراد 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 لنقل حدث إلى تقويم آخر، أي تغيير مُنظم الحدث.

معلمات طلب البحث المطلوبة: 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 ترقب التغييرات في موارد الأحداث.

مشغول

للحصول على تفاصيل مورد FreeBusy، اطلع على صفحة تمثيل المورد.

الطريقة طلب 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 ترقب التغييرات في موارد الإعدادات.