این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

CalendarList: watch

مراقب تغییرات منابع CalendarList باشید.

درخواست

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

نام پارامتر	ارزش	شرح

این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد:

محدوده
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`

برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.

در بدنه درخواست، داده ها را با ساختار زیر ارائه دهید:

{
  "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`	یک شناسه غیر شفاف که منبع در حال تماشا را در این کانال مشخص می کند. در نسخه های مختلف API پایدار است.
`resourceUri`	`string`	یک شناسه مخصوص نسخه برای منبع تماشا شده.
`token`	`string`	یک رشته دلخواه با هر اعلان از طریق این کانال به آدرس مورد نظر تحویل داده می شود. اختیاری.
`expiration`	`long`	تاریخ و زمان انقضای کانال اعلان، به صورت مهر زمانی یونیکس، در میلی ثانیه بیان می شود. اختیاری.