Calendars

مجموعه‌ای از همه تقویم‌های موجود. Calendars درمقابل CalendarList را نیز ببینید.

برای مشاهده فهرست روش‌های این منبع، به انتهای این صفحه مراجعه کنید.

نمایش منابع

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}

نام دارایی	مقدار	شرح	یادداشت‌ها
autoAcceptInvitations	boolean	اینکه این تقویم دعوت‌ها را به‌طور خودکار می‌پذیرد یا نه. فقط برای تقویم‌های منبع معتبر است.
conferenceProperties	nested object	ویژگی‌های کنفرانس برای این تقویم، برای مثال چه نوع کنفرانس‌هایی مجاز است.
conferenceProperties.allowedConferenceSolutionTypes[]	list	انواع راه‌حل‌های کنفرانس که برای این تقویم پشتیبانی می‌شود. مقادیر ممکن عبارت‌اند از: "eventHangout" "eventNamedHangout" "hangoutsMeet" اختیاری.
dataOwner	string	ایمیل مالک تقویم. فقط برای تقویم‌های فرعی تنظیم شده است. فقط خواندنی.
description	string	شرح تقویم. اختیاری.	قابل‌نوشتن
etag	etag	ETag منبع.
id	string	شناسه تقویم. برای بازیابی شناسه‌ها، روش calendarList.list() را فراخوانی کنید.
kind	string	نوع منبع («calendar#calendar»).
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	روز هفته. الزامی. مقادیر ممکن عبارت‌اند از: «monday» «tuesday» «wednesday» «thursday» «friday» «saturday» «sunday»	قابل‌نوشتن
workingHours.availableTimes[].periodEnd	integer	پایان دوره، برحسب دقیقه از شروع روز، انحصاری. الزامی.	قابل‌نوشتن
workingHours.availableTimes[].periodStart	integer	شروع دوره، برحسب دقیقه از شروع روز، شامل. الزامی.	قابل‌نوشتن
workingHours.workingHoursEnabled	boolean	اینکه ساعت کاری برای این تقویم فعال است یا نه. وقتی availableTimes خالی باشد، نمی‌تواند روی «درست» تنظیم شود.	قابل‌نوشتن

روش‌ها

پاک کردن

تقویم اصلی را پاک می‌کند. این عملیات همه رویدادهای مرتبط با تقویم اصلی حساب را حذف می‌کند.

حذف

تقویم فرعی را حذف می‌کند. از calendars.clear برای پاک کردن همه رویدادها در تقویم‌های اصلی استفاده کنید.

دریافت

فراداده‌های تقویم را برمی‌گرداند.

درج

تقویم فرعی ایجاد می‌کند.

کاربر اصالت‌سنجی‌شده برای درخواست، به‌عنوان مالک داده‌های تقویم جدید تعیین می‌شود.

توجه: توصیه می‌کنیم به‌عنوان مالک داده موردنظر تقویم اصالت‌سنجی کنید. می‌توانید از واگذاری اختیارات در سراسر دامنه استفاده کنید تا به برنامه‌ها اجازه دهید ازجانب کاربر خاصی اقدام کنند. از حساب سرویس برای اصالت‌سنجی استفاده نکنید. اگر از حساب سرویس برای اصالت‌سنجی استفاده می‌کنید، حساب سرویس مالک داده است که می‌تواند منجر به رفتار غیرمنتظره شود. برای مثال، اگر حساب سرویس مالک داده باشد، مالکیت داده قابل‌انتقال نیست.

وصله

فراداده تقویم را به‌روز می‌کند. این روش از معناشناسی وصله پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ ترجیحاً از get و سپس update استفاده کنید. مقادیر فیلدی که مشخص می‌کنید جایگزین مقادیر موجود می‌شود. فیلدهایی که در درخواست مشخص نمی‌کنید بدون تغییر باقی می‌مانند. فیلدهای آرایه، درصورت مشخص شدن، آرایه‌های موجود را رونویسی می‌کنند؛ این کار هرگونه عناصر آرایه قبلی را حذف می‌کند.

transferOwnership

تقویم فرعی را بین کاربران در سازمان Google Workspace منتقل می‌کند. به اصالت‌سنجی کاربر با امتیاز سرپرست مدیریت تقویم‌ها و یکی از دامنه‌های مجوز زیر نیاز دارد:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.calendars

در درخواست، useAdminAccess را روی true تنظیم کنید. تقویم فرعی باید فعال باشد تا بتوان آن را منتقل کرد. انتقال تقویم‌های غیرفعال یا حذف‌شده پشتیبانی نمی‌شود.

به‌روزرسانی

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