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
  }
}

اسم الموقع	القيمة	الوصف	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، بالمللي ثانية. اختياريّ.