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
}

نام ملک	ارزش	توضیحات	یادداشت‌ها
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 قالب‌بندی می‌شود، مثلاً "اروپا/زوریخ".) اختیاری.	قابل نوشتن

روش‌ها

واضح

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

حذف

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

دریافت

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

درج

یک تقویم ثانویه ایجاد می‌کند.

کاربر احراز هویت شده برای درخواست، مالک داده‌های تقویم جدید می‌شود.

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

پچ

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

انتقال مالکیت

یک تقویم ثانویه را بین کاربران درون یک سازمان Google Workspace منتقل می‌کند. نیاز به احراز هویت کاربر با امتیاز مدیر مدیریت تقویم‌ها و یکی از حوزه‌های مجوز زیر دارد:

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

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

به‌روزرسانی

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