مراقبة التغييرات في موارد "الإعدادات"
طلب
طلب 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 |
https://www.googleapis.com/auth/calendar.settings |
لمزيد من المعلومات، يُرجى الاطّلاع على صفحة المصادقة والتفويض.
نص الطلب
في نص الطلب، قدِّم البيانات بالبنية التالية:
{
"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، بالمللي ثانية. اختيارية: |