Events: watch

ترقُّب التغييرات في موارد الأحداث.

الطلب

طلب HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

المَعلمات

اسم المعلَمة القيمة الوصف
مَعلمات المسار
calendarId string معرّف التقويم. لاسترداد معرّفات التقويم، يمكنك استدعاء الطريقة calendarList.list. إذا كنت تريد الوصول إلى التقويم الأساسي للمستخدم الذي سجّل دخوله حاليًا، استخدِم الكلمة الرئيسية "primary".
مَعلمات طلب البحث الاختيارية
eventTypes string أنواع الأحداث الموارد المتاحة للمشاهدة. اختياريّ. يمكن تكرار هذه المَعلمة عدة مرات لمشاهدة الموارد من أنواع مختلفة. والقيمة التلقائية هي ["default", "focusTime", "outOfOffice", "workingLocation"].

القيم المقبولة هي:
  • "default": الأحداث المنتظمة
  • "focusTime": أحداث وقت التركيز
  • "outOfOffice": أحداث خارج المكتب
  • "workingLocation": أحداث مكان العمل

التفويض

يسمح هذا الطلب بتفويض نطاق واحد على الأقل من النطاقات التالية:

النطاق
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events

للحصول على مزيد من المعلومات، يمكنك الاطلاع على صفحة المصادقة والتفويض.

نص الطلب

في نص الطلب، أدخِل البيانات بالبنية التالية:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
اسم الموقع القيمة الوصف Notes
id string معرّف فريد عالمي (UUID) أو سلسلة فريدة مشابهة تحدّد هذه القناة.
token string سلسلة عشوائية يتم إرسالها إلى العنوان المستهدف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ.
type string نوع آلية الإرسال المستخدمة لهذه القناة. القيم الصالحة هي "web_hook" (أو "webhook"). تشير كلتا القيمتين إلى قناة تُستخدَم فيها طلبات Http لتسليم الرسائل.
address string العنوان الذي تريد إرسال الإشعارات إليه لهذه القناة
params object معلمات إضافية تتحكم في سلوك قناة التسليم. اختياريّ.
params.ttl string مدة البقاء بالثواني لقناة الإشعارات. والقيمة التلقائية هي 604,800 ثانية.

الإجابة

إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
اسم الموقع القيمة الوصف Notes
kind string لتحديد ذلك كقناة إشعارات يتم استخدامها لمراقبة التغييرات في مورد، وهو "api#channel".
id string معرّف فريد عالمي (UUID) أو سلسلة فريدة مشابهة تحدّد هذه القناة.
resourceId string رقم تعريف مبهم يحدد المورد الذي تتم مشاهدته على هذه القناة. ثابتة على مستوى الإصدارات المختلفة من واجهة برمجة التطبيقات.
resourceUri string تمثّل هذه السمة معرّفًا خاصًا بإصدار المورد الذي تتم مشاهدته.
token string سلسلة عشوائية يتم إرسالها إلى العنوان المستهدف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ.
expiration long تاريخ ووقت انتهاء صلاحية قناة الإشعار، ويتم التعبير عنه بالطابع الزمني لنظام التشغيل Unix، بالمللي ثانية اختياريّ.