Calendars: update

فراداده‌های یک تقویم را به‌روزرسانی می‌کند. همین حالا امتحان کنید .

درخواست

درخواست HTTP

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای مسیر
calendarId string شناسه تقویم. برای بازیابی شناسه‌های تقویم، متد calendarList.list را فراخوانی کنید. اگر می‌خواهید به تقویم اصلی کاربر فعلی وارد شده دسترسی پیدا کنید، از کلمه کلیدی " primary " استفاده کنید.

مجوز

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

محدوده
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendars

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

درخواست بدنه

در بدنه درخواست، یک منبع Calendars با ویژگی‌های زیر ارائه دهید:

نام ملک ارزش توضیحات یادداشت‌ها
ویژگی‌های اختیاری
description string شرح تقویم. اختیاری. قابل نوشتن
labelProperties nested object ویژگی‌های برچسب در این تقویم تعریف شده‌اند. در صورت مشخص شدن، ویژگی‌های برچسب موجود را بازنویسی می‌کند. در صورت مشخص نشدن، ویژگی‌های برچسب بدون تغییر باقی می‌مانند. قابل نوشتن
labelProperties. eventLabels[] list برچسب‌های رویداد در این تقویم تعریف شده‌اند. اگر این برچسب هنگام به‌روزرسانی تقویم وجود داشته باشد، جایگزین برچسب‌های رویداد موجود خواهد شد.

برای افزودن یک برچسب رویداد جدید، لیست را گسترش دهید و برای حذف یک برچسب از تقویم، موجودیت‌ها را از لیست حذف کنید.

هر تقویم می‌تواند حداکثر ۲۰۰ برچسب داشته باشد.

قابل نوشتن
labelProperties.eventLabels[]. backgroundColor string رنگ پس‌زمینه‌ی برچسب در قالب هگزادسیمال، مانند "#039be5" . رویدادهایی که این برچسب را دارند با این رنگ نمایش داده می‌شوند. الزامی. قابل نوشتن
labelProperties.eventLabels[]. id string شناسه‌ی برچسب. هنگام درج برچسب جدید اختیاری است. در صورت عدم ارائه، یک شناسه‌ی منحصر به فرد ایجاد می‌شود. هنگام به‌روزرسانی برچسب الزامی است.

در صورت ارائه، شناسه باید در تقویم منحصر به فرد باشد و از قالب UUID پیروی کند.

قابل نوشتن
labelProperties.eventLabels[]. name string نام برچسب. اختیاری.

در صورت ارائه، این باید حداکثر ۵۰ کاراکتر داشته باشد.

قابل نوشتن
location string موقعیت جغرافیایی تقویم به صورت متن آزاد. اختیاری. قابل نوشتن
summary string عنوان تقویم. قابل نوشتن
timeZone string منطقه زمانی تقویم. (به صورت نام پایگاه داده منطقه زمانی IANA قالب‌بندی می‌شود، مثلاً "اروپا/زوریخ".) اختیاری. قابل نوشتن

پاسخ

در صورت موفقیت، این متد یک منبع Calendars را در بدنه پاسخ برمی‌گرداند.

امتحانش کن!

از API Explorer زیر برای فراخوانی این متد روی داده‌های زنده و مشاهده پاسخ استفاده کنید.