Events: watch

انتبِه إلى التغييرات في موارد "الأحداث".

الطلب

طلب HTTP

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

المعلمات

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

القِيَم المقبولة هي:
  • "birthday": أحداث خاصة تستمر على مدار اليوم وتتكرّر سنويًا.
  • "default": أحداث منتظمة
  • "focusTime": أحداث وقت التركيز
  • "fromGmail": أحداث من Gmail
  • "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
  }
}
اسم الموقع القيمة الوصف ملاحظات
id string معرّف UUID أو سلسلة فريدة مشابهة تُحدّد هذه القناة.
token string سلسلة عشوائية يتم إرسالها إلى العنوان المستهدَف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ.
type string نوع آلية إرسال المحتوى المستخدَمة في هذه القناة. القيمتان الصالحتان هي "web_hook" (أو "webhook"). تشير كلتا القيمتَين إلى قناة تُستخدَم فيها طلبات HTTP لتسليم الرسائل.
address string العنوان الذي يتم إرسال الإشعارات إليه لهذه القناة.
params object مَعلمات إضافية تتحكّم في سلوك قناة الإرسال اختياريّ.
params.ttl string الوقت المتبقّي للظهور بالثواني لقناة الإشعارات القيمة التلقائية هي 604800 ثانية.

الرد

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

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