API Reference

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

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

  1. Acl
  2. CalendarList
  3. التقاويم
  4. قنوات YouTube
  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 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 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 لحذف تقويم ثانوي استخدِم calendars.clear لمحو جميع الأحداث في التقاويم الأساسية.
الحصول GET  /calendars/calendarId تعرِض هذه الدالة البيانات الوصفية لتقويم.
إدراج POST  /calendars لإنشاء تقويم ثانوي
patch 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، يمكنك استدعاء الطريقة 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، ولا يمكن نقل أحداث 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 باستخدام علامات etags لضمان التماسك.
مشاهدة 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 راقِب التغييرات التي تطرأ على موارد الإعدادات.