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
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	زمان فعال بودن کانال اعلان به ثانیه. پیش‌فرض ۶۰۴۸۰۰ ثانیه است.

پاسخ

درصورت موفقیت‌آمیز بودن، این روش بدنه پاسخی با ساختار زیر برمی‌گرداند:

{
  "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	تاریخ و زمان انقضای کانال اعلان، که به‌صورت مُهر زمان یونیکس برحسب میلی‌ثانیه بیان می‌شود. اختیاری.