API Reference

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

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

  1. Acl
  2. CalendarList
  3. التقاويم
  4. القنوات
  5. الألوان
  6. الأحداث
  7. Freebusy
  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 PATCH  /calendars/calendarId/acl/ruleId تعديل قاعدة التحكّم بالوصول تتيح هذه الطريقة استخدام دلالات التصحيح. يُرجى العِلم أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، لذا يُفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محل القيم الحالية. تبقى الحقول التي لم تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول المصفوفة، سيتم استبدال المصفوفات الحالية، ما يؤدي إلى تجاهل أي عناصر مصفوفة سابقة.
تعديل PUT  /calendars/calendarId/acl/ruleId تعديل قاعدة التحكّم بالوصول
watch 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 PATCH  /users/me/calendarList/calendarId تعديل تقويم حالي في قائمة التقاويم الخاصة بالمستخدم تتيح هذه الطريقة استخدام دلالات التصحيح. يُرجى العِلم أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، لذا يُفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محل القيم الحالية. تبقى الحقول التي لم تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول المصفوفة، سيتم استبدال المصفوفات الحالية، ما يؤدي إلى تجاهل أي عناصر مصفوفة سابقة.
تعديل PUT  /users/me/calendarList/calendarId تعديل تقويم حالي في قائمة التقاويم الخاصة بالمستخدم
watch POST  /users/me/calendarList/watch مراقبة التغييرات التي تطرأ على موارد CalendarList

التقاويم

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

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

يصبح المستخدم الذي تمّت المصادقة عليه في الطلب هو مالك البيانات في التقويم الجديد.
patch PATCH  /calendars/calendarId تعدّل هذه الطريقة البيانات الوصفية لتقويم. تتيح هذه الطريقة استخدام دلالات التصحيح. يُرجى العِلم أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، لذا يُفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محل القيم الحالية. تبقى الحقول التي لم تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول المصفوفة، سيتم استبدال المصفوفات الحالية، ما يؤدي إلى تجاهل أي عناصر مصفوفة سابقة.
transferOwnership POST  /calendars/calendarId/transferOwnership تنقل هذه الطريقة تقويمًا ثانويًا بين المستخدمين في مؤسسة Google Workspace. يتطلب مصادقة المستخدم من خلال امتياز المشرف إدارة التقاويم، وأحد نطاقات التفويض التالية:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
في الطلب، اضبط قيمة useAdminAccess على true. يجب أن يكون التقويم الثانوي نشطًا ليتم نقله. لا يمكن نقل التقاويم التي تم إيقافها أو حذفها.

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

تعديل 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 الخاص به، استدعِ طريقة events.list باستخدام المَعلمة iCalUID.
استيراد POST  /calendars/calendarId/events/import تستورِد هذه الطريقة حدثًا. تُستخدَم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. يمكن استيراد الأحداث التي تتضمّن eventType بقيمة default فقط.

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

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

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

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

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

متوفر-مشغول

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

الطريقة طلب 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 تعرض هذه الطريقة جميع إعدادات المستخدم للمستخدم الذي تمّت مصادقته.
watch POST  /users/me/settings/watch ابحث عن أي تغييرات في موارد "الإعدادات".