Settings: watch

ملاحظة: يجب منح الإذن.

يُرجى ترقُّب التغييرات التي تطرأ على موارد الإعدادات.

الطلب

طلب HTTP

POST https://www.googleapis.com/calendar/v3/users/me/settings/watch

المعلمات

اسم المعلَمة	القيمة	الوصف

التفويض

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

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

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

نص الطلب

في نص الطلب، وفِّر البيانات بالبنية التالية:

{
  "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، بالمللي ثانية اختياريّ.