فراداده را برای تقویم به‌روز می‌کند. اکنون امتحان کنید.
درخواست
درخواست 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 |
برای اطلاعات بیشتر، به صفحه اصالت‌سنجی و صدور مجوز مراجعه کنید.
متن درخواست
در بدنه درخواست، یک منبع تقویم با ویژگی‌های زیر ارائه دهید:
| نام دارایی | مقدار | شرح | یادداشت‌ها |
|---|---|---|---|
| ویژگی‌های اختیاری | |||
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، مثلاً «Europe/Zurich».) اختیاری. | قابل‌نوشتن |
workingHours |
object |
اطلاعات مربوط به ساعت کاری کاربر را نشان می‌دهد. فقط برای تقویم‌های اصلی کاربران Google Workspace دردسترس است. برای به‌روزرسانی ساعت کاری، باید کل شیء ساعت کاری ارسال شود. اگر مشخص نشده باشد (یا به‌عنوان پوچ یا شیء خالی ارسال شده باشد)، ساعت کاری موجود بدون تغییر باقی می‌ماند. برای غیرفعال کردن ساعت کاری یا پاک کردن زمان‌بندی، workingHoursEnabled را روی false تنظیم کنید (و availableTimes را حذف کنید یا فهرست خالی ارسال کنید). |
قابل‌نوشتن |
workingHours.availableTimes[] |
list |
ساعت کاری. هر دوره دردسترس بودن نشان‌دهنده بلوک ساعت کاری کاربر درطول یک روز است. | قابل‌نوشتن |
workingHours.availableTimes[].dayOfWeek |
string |
روز هفته. الزامی. مقادیر ممکن عبارت‌اند از:
|
قابل‌نوشتن |
workingHours.availableTimes[].periodEnd |
integer |
پایان دوره، برحسب دقیقه از شروع روز، انحصاری. الزامی. | قابل‌نوشتن |
workingHours.availableTimes[].periodStart |
integer |
شروع دوره، برحسب دقیقه از شروع روز، شامل. الزامی. | قابل‌نوشتن |
workingHours.workingHoursEnabled |
boolean |
اینکه ساعت کاری برای این تقویم فعال است یا نه. وقتی availableTimes خالی باشد، نمی‌تواند روی «درست» تنظیم شود. |
قابل‌نوشتن |
پاسخ
اگر موفقیت‌آمیز باشد، این روش منبع تقویم‌ها را در بدنه پاسخ برمی‌گرداند.
امتحان کنید!
از «کاوشگر میاناهای برنامه‌سازی کاربردی» زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.