Events

API تقویم انواع مختلفی از منابع رویداد را ارائه می‌دهد، اطلاعات بیشتر را می‌توانید در «درباره رویدادها» بیابید.

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

نمایش منابع 

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
نام ملک ارزش توضیحات یادداشت‌ها
anyoneCanAddSelf boolean اینکه آیا کسی می‌تواند خودش را به رویداد دعوت کند یا خیر (منسوخ شده). اختیاری. پیش‌فرض False است. قابل نوشتن
attachments[] list فایل پیوست رویداد را ارسال کنید.

برای تغییر پیوست‌ها، پارامتر درخواست supportsAttachments باید روی true تنظیم شود.

در هر رویداد حداکثر ۲۵ پیوست می‌تواند وجود داشته باشد،

attachments[]. fileId string شناسه فایل پیوست شده. فقط خواندنی.

برای فایل‌های گوگل درایو، این شناسه‌ی ورودی منبع Files مربوطه در Drive API است.

attachments[]. fileUrl string لینک URL به فایل پیوست.

For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

هنگام اضافه کردن پیوست الزامی است.

 قابل نوشتن
attachments[]. mimeType string نوع رسانه اینترنتی (نوع MIME) پیوست.
attachments[]. title string عنوان پیوست.
attendeesOmitted boolean آیا شرکت‌کنندگان از نمایش رویداد حذف شده‌اند یا خیر. هنگام بازیابی یک رویداد، این ممکن است به دلیل محدودیتی باشد که توسط پارامتر پرس‌وجوی maxAttendee مشخص شده است. هنگام به‌روزرسانی یک رویداد، می‌توان از این مورد فقط برای به‌روزرسانی پاسخ شرکت‌کننده استفاده کرد. اختیاری. مقدار پیش‌فرض False است. قابل نوشتن
attendees[] list شرکت‌کنندگان در رویداد. برای اطلاعات بیشتر در مورد زمان‌بندی رویدادها با سایر کاربران تقویم، به راهنمای « رویدادها با شرکت‌کنندگان» مراجعه کنید. حساب‌های سرویس برای پر کردن لیست شرکت‌کنندگان باید از تفویض اختیار در سطح دامنه استفاده کنند. قابل نوشتن
attendees[]. additionalGuests integer تعداد مهمانان اضافی. اختیاری. مقدار پیش‌فرض ۰ است. قابل نوشتن
attendees[]. comment string نظر پاسخ شرکت‌کننده. اختیاری. قابل نوشتن
attendees[]. displayName string نام شرکت‌کننده، در صورت وجود. اختیاری. قابل نوشتن
attendees[]. email string آدرس ایمیل شرکت‌کننده، در صورت وجود. این فیلد باید هنگام اضافه کردن شرکت‌کننده موجود باشد. این آدرس باید مطابق با RFC5322 معتبر باشد.

هنگام اضافه کردن شرکت کننده الزامی است.

 قابل نوشتن
attendees[]. id string شناسه پروفایل شرکت‌کننده، در صورت وجود.
attendees[]. optional boolean آیا این یک شرکت‌کننده اختیاری است؟ اختیاری. پیش‌فرض False است. قابل نوشتن
attendees[]. organizer boolean اینکه آیا شرکت‌کننده، برگزارکننده رویداد است یا خیر. فقط خواندنی. مقدار پیش‌فرض False است.
attendees[]. resource boolean اینکه آیا شرکت‌کننده یک منبع است یا خیر. فقط زمانی می‌توان آن را تنظیم کرد که شرکت‌کننده برای اولین بار به رویداد اضافه شود. تغییرات بعدی نادیده گرفته می‌شوند. اختیاری. مقدار پیش‌فرض False است. قابل نوشتن
attendees[]. responseStatus string وضعیت پاسخ شرکت‌کننده. مقادیر ممکن عبارتند از:
  • « needsAction » - شرکت‌کننده به دعوت پاسخ نداده است (برای رویدادهای جدید توصیه می‌شود).
  • « declined » - شرکت‌کننده دعوت را رد کرده است.
  • « tentative » - شرکت‌کننده به طور آزمایشی دعوت را پذیرفته است.
  • « accepted » - شرکت‌کننده دعوت را پذیرفته است.
 قابل نوشتن
attendees[]. self boolean آیا این ورودی، تقویمی را نشان می‌دهد که این کپی از رویداد در آن نمایش داده می‌شود یا خیر. فقط خواندنی. مقدار پیش‌فرض False است.
birthdayProperties nested object داده‌های تولد یا رویداد ویژه. اگر eventType برابر با "birthday" باشد، استفاده می‌شود. تغییرناپذیر. قابل نوشتن
birthdayProperties. contact string نام منبع مخاطبی که این رویداد تولد به آن لینک شده است. این می‌تواند برای دریافت اطلاعات مخاطب از People API استفاده شود. فرمت: "people/c12345" . فقط خواندنی.
birthdayProperties. customTypeName string برچسب نوع سفارشی برای این رویداد مشخص شده است. اگر birthdayProperties.type روی "custom" تنظیم شده باشد، این مقدار پر می‌شود. فقط خواندنی.
birthdayProperties. type string نوع تولد یا رویداد ویژه. مقادیر ممکن عبارتند از:
  • "anniversary" - سالگردی غیر از تولد. همیشه یک contact دارد.
  • "birthday" - رویداد تولد. این مقدار پیش‌فرض است.
  • "custom" - یک تاریخ خاص که برچسب آن در فیلد customTypeName مشخص شده است. همیشه یک contact دارد.
  • "other" - یک تاریخ خاص که در دسته‌های دیگر قرار نمی‌گیرد و برچسب سفارشی ندارد. همیشه یک contact دارد.
  • "self" - تاریخ تولد صاحب تقویم. نمی‌توان contact داشت.
API تقویم فقط از ایجاد رویدادهایی با نوع "birthday" پشتیبانی می‌کند. این نوع پس از ایجاد رویداد قابل تغییر نیست.		 قابل نوشتن
colorId string رنگ رویداد. این یک شناسه است که به ورودی در بخش event تعریف رنگ‌ها اشاره می‌کند (به نقطه پایانی رنگ‌ها مراجعه کنید). اختیاری. قابل نوشتن
conferenceData nested object اطلاعات مربوط به کنفرانس، مانند جزئیات یک کنفرانس Google Meet. برای ایجاد جزئیات جدید کنفرانس، از فیلد createRequest استفاده کنید. برای حفظ تغییرات خود، به یاد داشته باشید که پارامتر درخواست conferenceDataVersion را برای همه درخواست‌های اصلاح رویداد روی 1 تنظیم کنید. قابل نوشتن
conferenceData. conferenceId string شناسه کنفرانس.

توسعه‌دهندگان می‌توانند از آن برای پیگیری کنفرانس‌ها استفاده کنند، نباید به کاربران نمایش داده شود.

مقدار شناسه برای هر نوع راهکار کنفرانس به طور متفاوتی شکل می‌گیرد:

  • eventHangout : شناسه تنظیم نشده است. (این نوع کنفرانس منسوخ شده است.)
  • eventNamedHangout : شناسه نام Hangout است. (این نوع کنفرانس منسوخ شده است.)
  • hangoutsMeet : شناسه کد جلسه ده حرفی است، برای مثال aaa-bbbb-ccc .
  • addOn : شناسه توسط ارائه‌دهنده شخص ثالث تعریف می‌شود.
اختیاری.

conferenceData. conferenceSolution nested object راهکار کنفرانس، مانند گوگل میت.

برای کنفرانسی که درخواست ایجاد آن ناموفق بوده، تنظیم نشده است.

یا conferenceSolution و حداقل یک entryPoint یا createRequest مورد نیاز است.

conferenceData.conferenceSolution. iconUri string آیکون قابل مشاهده توسط کاربر برای این راهکار.
conferenceData.conferenceSolution. key nested object کلیدی که می‌تواند به طور منحصر به فرد، راهکار کنفرانس را برای این رویداد شناسایی کند.
conferenceData.conferenceSolution.key. type string نوع راهکار کنفرانسی

اگر کلاینت با یک نوع داده ناآشنا یا خالی مواجه شود، همچنان باید بتواند نقاط ورودی را نمایش دهد. با این حال، باید اجازه تغییرات را ندهد.

مقادیر ممکن عبارتند از:

  • "eventHangout" برای Hangouts برای مصرف‌کنندگان (منسوخ شده؛ رویدادهای موجود ممکن است این نوع راهکار کنفرانس را نشان دهند اما نمی‌توان کنفرانس‌های جدید ایجاد کرد)
  • "eventNamedHangout" برای Hangouts کلاسیک برای کاربران Google Workspace (منسوخ شده؛ رویدادهای موجود ممکن است این نوع راهکار کنفرانس را نشان دهند اما نمی‌توان کنفرانس‌های جدید ایجاد کرد)
  • "hangoutsMeet" برای گوگل میت (http://meet.google.com)
  • "addOn" برای ارائه‌دهندگان کنفرانس شخص ثالث

conferenceData.conferenceSolution. name string نام قابل مشاهده توسط کاربر برای این راهکار. بومی‌سازی نشده است.
conferenceData. createRequest nested object درخواستی برای ایجاد یک کنفرانس جدید و پیوست کردن آن به رویداد. داده‌ها به صورت ناهمگام تولید می‌شوند. برای مشاهده‌ی وجود داده‌ها، فیلد status بررسی کنید.

یا conferenceSolution و حداقل یک entryPoint یا createRequest مورد نیاز است.

conferenceData.createRequest. conferenceSolutionKey nested object راهکار کنفرانس، مانند Hangouts یا Google Meet.
conferenceData.createRequest.conferenceSolutionKey. type string نوع راهکار کنفرانسی

اگر کلاینت با یک نوع داده ناآشنا یا خالی مواجه شود، همچنان باید بتواند نقاط ورودی را نمایش دهد. با این حال، باید اجازه تغییرات را ندهد.

مقادیر ممکن عبارتند از:

  • "eventHangout" برای Hangouts برای مصرف‌کنندگان (منسوخ شده؛ رویدادهای موجود ممکن است این نوع راهکار کنفرانس را نشان دهند اما نمی‌توان کنفرانس‌های جدید ایجاد کرد)
  • "eventNamedHangout" برای Hangouts کلاسیک برای کاربران Google Workspace (منسوخ شده؛ رویدادهای موجود ممکن است این نوع راهکار کنفرانس را نشان دهند اما نمی‌توان کنفرانس‌های جدید ایجاد کرد)
  • "hangoutsMeet" برای گوگل میت (http://meet.google.com)
  • "addOn" برای ارائه‌دهندگان کنفرانس شخص ثالث

conferenceData.createRequest. requestId string شناسه منحصر به فرد ایجاد شده توسط کلاینت برای این درخواست.

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

conferenceData.createRequest. status nested object وضعیت درخواست ایجاد کنفرانس.
conferenceData.createRequest.status. statusCode string وضعیت فعلی درخواست ایجاد کنفرانس. فقط خواندنی.

مقادیر ممکن عبارتند از:

  • "pending" : درخواست ایجاد کنفرانس هنوز در حال پردازش است.
  • "success" : درخواست ایجاد کنفرانس با موفقیت انجام شد، نقاط ورودی پر شدند.
  • "failure" : درخواست ایجاد کنفرانس با شکست مواجه شد، هیچ نقطه ورودی وجود ندارد.

conferenceData. entryPoints[] list اطلاعات مربوط به نقاط ورود به کنفرانس، مانند URLها یا شماره تلفن‌ها.

همه آنها باید متعلق به یک کنفرانس باشند.

یا conferenceSolution و حداقل یک entryPoint یا createRequest مورد نیاز است.

conferenceData.entryPoints[]. accessCode string کد دسترسی برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ کاراکتر.

هنگام ایجاد داده‌های کنفرانس جدید، فقط زیرمجموعه‌ای از فیلدهای { meetingCode , accessCode , passcode , password , pin } را که با اصطلاحات ارائه‌دهنده کنفرانس مطابقت دارند، پر کنید. فقط فیلدهای پر شده باید نمایش داده شوند.

اختیاری.

conferenceData.entryPoints[]. entryPointType string The type of the conference entry point.

مقادیر ممکن عبارتند از:

  • "video" - پیوستن به یک کنفرانس از طریق HTTP. یک کنفرانس می‌تواند هیچ یا یک نقطه ورود video داشته باشد.
  • "phone" - پیوستن به یک کنفرانس با شماره‌گیری یک شماره تلفن. یک کنفرانس می‌تواند هیچ یا چند نقطه ورود phone داشته باشد.
  • "sip" - پیوستن به یک کنفرانس از طریق SIP. یک کنفرانس می‌تواند هیچ یا یک نقطه ورود sip داشته باشد.
  • "more" - دستورالعمل‌های بیشتر برای پیوستن به کنفرانس، برای مثال شماره تلفن‌های اضافی. یک کنفرانس می‌تواند صفر یا یک نقطه ورود more داشته باشد. کنفرانسی که فقط یک نقطه ورود more دارد، کنفرانس معتبری نیست.

conferenceData.entryPoints[]. label string برچسب مربوط به URI. قابل مشاهده برای کاربران نهایی. بومی‌سازی نشده. حداکثر طول ۵۱۲ کاراکتر است.

مثال‌ها:

  • برای video : meet.google.com/aaa-bbbb-ccc
  • برای phone : +1 123 268 2601
  • برای sip : 12345678@altostrat.com
  • برای more : نباید پر شود

اختیاری.

conferenceData.entryPoints[]. meetingCode string کد جلسه برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ کاراکتر است.

هنگام ایجاد داده‌های کنفرانس جدید، فقط زیرمجموعه‌ای از فیلدهای { meetingCode , accessCode , passcode , password , pin } را که با اصطلاحات ارائه‌دهنده کنفرانس مطابقت دارند، پر کنید. فقط فیلدهای پر شده باید نمایش داده شوند.

اختیاری.

conferenceData.entryPoints[]. passcode string رمز عبور برای دسترسی به کنفرانس. حداکثر طول آن ۱۲۸ کاراکتر است.

هنگام ایجاد داده‌های کنفرانس جدید، فقط زیرمجموعه‌ای از فیلدهای { meetingCode , accessCode , passcode , password , pin } را که با اصطلاحات ارائه‌دهنده کنفرانس مطابقت دارند، پر کنید. فقط فیلدهای پر شده باید نمایش داده شوند.

conferenceData.entryPoints[]. password string رمز عبور برای دسترسی به کنفرانس. حداکثر طول ۱۲۸ کاراکتر.

هنگام ایجاد داده‌های کنفرانس جدید، فقط زیرمجموعه‌ای از فیلدهای { meetingCode , accessCode , passcode , password , pin } را که با اصطلاحات ارائه‌دهنده کنفرانس مطابقت دارند، پر کنید. فقط فیلدهای پر شده باید نمایش داده شوند.

اختیاری.

conferenceData.entryPoints[]. pin string پین برای دسترسی به کنفرانس. حداکثر طول آن ۱۲۸ کاراکتر است.

هنگام ایجاد داده‌های کنفرانس جدید، فقط زیرمجموعه‌ای از فیلدهای { meetingCode , accessCode , passcode , password , pin } را که با اصطلاحات ارائه‌دهنده کنفرانس مطابقت دارند، پر کنید. فقط فیلدهای پر شده باید نمایش داده شوند.

اختیاری.

conferenceData.entryPoints[]. uri string آدرس اینترنتی (URI) نقطه ورود. حداکثر طول مجاز ۱۳۰۰ کاراکتر است.

قالب:

  • برای video ، طرحواره http: یا https: مورد نیاز است.
  • برای phone ، طرحواره tel: مورد نیاز است. URI باید شامل کل توالی شماره گیری باشد (مثلاً tel:+12345678900,,,123456789;1234).
  • برای sip ، طرحواره sip: مورد نیاز است، مثلاً sip:12345678@myprovider.com.
  • برای more ، طرحواره http: یا https: مورد نیاز است.

conferenceData. notes string یادداشت‌های اضافی (مانند دستورالعمل‌های مدیر دامنه، اطلاعیه‌های قانونی) برای نمایش به کاربر. می‌تواند شامل HTML باشد. حداکثر طول ۲۰۴۸ کاراکتر است. اختیاری.
conferenceData. signature string امضای داده‌های کنفرانس.

در سمت سرور تولید می‌شود.

برای کنفرانسی که درخواست ایجاد آن ناموفق بوده، تنظیم نشده است.

اختیاری برای کنفرانسی که درخواست ایجاد آن در انتظار است.

created datetime زمان ایجاد رویداد (به عنوان مهر زمانی RFC3339 ). فقط خواندنی.
creator object خالق رویداد. فقط خواندنی.
creator. displayName string نام پدیدآورنده، در صورت وجود.
creator. email string آدرس ایمیل خالق اثر، در صورت وجود.
creator. id string شناسه پروفایل سازنده، در صورت وجود.
creator. self boolean اینکه آیا خالق با تقویمی که این کپی از رویداد در آن نمایش داده می‌شود، مطابقت دارد یا خیر. فقط خواندنی. مقدار پیش‌فرض False است.
description string شرح رویداد. می‌تواند شامل HTML باشد. اختیاری. قابل نوشتن
end nested object زمان پایان (منحصراً) رویداد. برای یک رویداد تکرارشونده، این زمان پایان اولین نمونه است.
end. date date تاریخ، با فرمت "yyyy-mm-dd"، اگر این رویداد تمام روز باشد. قابل نوشتن
end. dateTime datetime زمان، به عنوان یک مقدار ترکیبی تاریخ-زمان (طبق RFC3339 قالب‌بندی شده). انحراف منطقه زمانی مورد نیاز است، مگر اینکه منطقه زمانی به صراحت در timeZone مشخص شده باشد. قابل نوشتن
end. timeZone string منطقه زمانی که زمان در آن مشخص شده است. (به صورت نام پایگاه داده منطقه زمانی IANA قالب‌بندی می‌شود، مثلاً "اروپا/زوریخ".) برای رویدادهای تکرارشونده، این فیلد الزامی است و منطقه زمانی را که تکرار در آن گسترش می‌یابد، مشخص می‌کند. برای رویدادهای تکی، این فیلد اختیاری است و یک منطقه زمانی سفارشی برای شروع/پایان رویداد را نشان می‌دهد. قابل نوشتن
endTimeUnspecified boolean اینکه آیا زمان پایان واقعاً مشخص نشده است یا خیر. حتی اگر این ویژگی روی True تنظیم شده باشد، به دلایل سازگاری، زمان پایان همچنان ارائه می‌شود. مقدار پیش‌فرض False است.
etag etag برچسب منبع (ETag).
eventType string نوع خاصی از رویداد. این مورد پس از ایجاد رویداد قابل تغییر نیست. مقادیر ممکن عبارتند از:
  • « birthday » - یک رویداد ویژه تمام روز با تکرار سالانه.
  • « default » - یک رویداد معمولی یا بیشتر مشخص نشده.
  • « focusTime » - یک رویداد مربوط به زمان فوکوس.
  • « fromGmail » - رویدادی از Gmail. این نوع رویداد قابل ایجاد نیست.
  • « outOfOffice » - یک رویداد خارج از دفتر.
  • « workingLocation » - رویداد محل کار.
 قابل نوشتن
extendedProperties object ویژگی‌های توسعه‌یافته‌ی رویداد.
extendedProperties. private object ویژگی‌هایی که برای کپی رویدادی که در این تقویم نمایش داده می‌شود، خصوصی هستند. قابل نوشتن
extendedProperties.private. (key) string نام ملک خصوصی و ارزش مربوطه.
extendedProperties. shared object ویژگی‌هایی که بین کپی‌های رویداد در تقویم‌های سایر شرکت‌کنندگان به اشتراک گذاشته می‌شوند. قابل نوشتن
extendedProperties.shared. (key) string نام ملک مشترک و مقدار مربوطه.
focusTimeProperties nested object داده‌های رویداد زمان تمرکز. اگر eventType focusTime باشد، استفاده می‌شود. قابل نوشتن
focusTimeProperties. autoDeclineMode string اینکه آیا دعوت‌نامه‌های جلسه‌ای که با رویدادهای Focus Time همپوشانی دارند، رد شوند یا خیر. مقادیر معتبر عبارتند از: declineNone ، به این معنی که هیچ دعوت‌نامه جلسه‌ای رد نمی‌شود؛ declineAllConflictingInvitations ، به این معنی که تمام دعوت‌نامه‌های جلسه متناقض که با رویداد تداخل دارند، رد می‌شوند؛ و declineOnlyNewConflictingInvitations ، به این معنی که فقط دعوت‌نامه‌های جلسه متناقض جدیدی که در حین برگزاری رویداد Focus Time می‌رسند، باید رد شوند.
focusTimeProperties. chatStatus string وضعیت برای علامت‌گذاری کاربر در چت و محصولات مرتبط. این می‌تواند available یا doNotDisturb باشد.
focusTimeProperties. declineMessage string پیام پاسخ برای تنظیم اینکه آیا یک رویداد موجود یا دعوت جدید به طور خودکار توسط تقویم رد شود یا خیر.
gadget object یک گجت که این رویداد را گسترش می‌دهد. گجت‌ها منسوخ شده‌اند؛ در عوض، این ساختار فقط برای بازگرداندن فراداده‌های تقویم تولد استفاده می‌شود.
gadget. display string حالت نمایش گجت. منسوخ شده. مقادیر ممکن عبارتند از:
  • « icon » - این ابزارک در نمای تقویم، کنار عنوان رویداد نمایش داده می‌شود.
  • « chip » - گجت هنگام کلیک روی رویداد نمایش داده می‌شود.
 قابل نوشتن
gadget. height integer ارتفاع ابزارک بر حسب پیکسل. ارتفاع باید یک عدد صحیح بزرگتر از ۰ باشد. اختیاری. منسوخ شده. قابل نوشتن
gadget. preferences object ترجیحات قابل نوشتن
gadget.preferences. (key) string نام ترجیح و مقدار مربوطه.
gadget. title string عنوان گجت. منسوخ شده. قابل نوشتن
gadget. type string The gadget's type. Deprecated. قابل نوشتن
gadget. width integer عرض ابزارک بر حسب پیکسل. عرض باید عدد صحیحی بزرگتر از ۰ باشد. اختیاری. منسوخ شده. قابل نوشتن
guestsCanInviteOthers boolean اینکه آیا شرکت‌کنندگان غیر از برگزارکننده می‌توانند دیگران را به رویداد دعوت کنند یا خیر. اختیاری. پیش‌فرض True است. قابل نوشتن
guestsCanModify boolean اینکه آیا شرکت‌کنندگان غیر از برگزارکننده می‌توانند رویداد را تغییر دهند یا خیر. اختیاری. مقدار پیش‌فرض False است. قابل نوشتن
guestsCanSeeOtherGuests boolean اینکه آیا شرکت‌کنندگانی غیر از برگزارکننده می‌توانند شرکت‌کنندگان رویداد را ببینند یا خیر. اختیاری. مقدار پیش‌فرض درست است. قابل نوشتن
iCalUID string شناسه منحصر به فرد رویداد همانطور که در RFC5545 تعریف شده است. این شناسه برای شناسایی منحصر به فرد رویدادها در سیستم‌های تقویمی استفاده می‌شود و باید هنگام وارد کردن رویدادها از طریق روش import ارائه شود.

توجه داشته باشید که iCalUID و id یکسان نیستند و فقط یکی از آنها باید در زمان ایجاد رویداد ارائه شود. یک تفاوت در معنای آنها این است که در رویدادهای تکرارشونده، همه رویدادهای یک رویداد id های متفاوتی دارند در حالی که همه آنها iCalUID های یکسانی دارند. برای بازیابی یک رویداد با استفاده از iCalUID آن، متد events.list را با استفاده از پارامتر iCalUID فراخوانی کنید. برای بازیابی یک رویداد با استفاده از id آن، متد events.get را فراخوانی کنید.

id string شناسه‌ی مبهم رویداد. هنگام ایجاد رویدادهای تکی یا تکراری جدید، می‌توانید شناسه‌های آنها را مشخص کنید. شناسه‌های ارائه شده باید از این قوانین پیروی کنند:
  • کاراکترهای مجاز در شناسه، همان‌هایی هستند که در کدگذاری base32hex استفاده می‌شوند، یعنی حروف کوچک av و ارقام 0-9، به بخش 3.1.2 در RFC2938 مراجعه کنید.
  • طول شناسه باید بین ۵ تا ۱۰۲۴ کاراکتر باشد
  • شناسه باید برای هر تقویم منحصر به فرد باشد
با توجه به ماهیت توزیع‌شده‌ی جهانی سیستم، نمی‌توانیم تضمین کنیم که برخوردهای شناسه در زمان ایجاد رویداد شناسایی شوند. برای به حداقل رساندن خطر برخورد، توصیه می‌کنیم از یک الگوریتم UUID تثبیت‌شده مانند الگوریتم شرح داده شده در RFC4122 استفاده کنید.

اگر شناسه‌ای مشخص نکنید، سرور به طور خودکار آن را ایجاد می‌کند.

توجه داشته باشید که icalUID و id یکسان نیستند و فقط یکی از آنها باید در زمان ایجاد رویداد ارائه شود. یک تفاوت در معنای آنها این است که در رویدادهای تکرارشونده، همه رویدادهای یک رویداد id های متفاوتی دارند در حالی که همه آنها icalUID های یکسانی دارند.

 قابل نوشتن
kind string نوع منبع (" calendar#event ").
location string موقعیت جغرافیایی رویداد به صورت متن آزاد. اختیاری. قابل نوشتن
locked boolean آیا این یک کپی رویداد قفل شده است که در آن هیچ تغییری در فیلدهای رویداد اصلی "خلاصه"، "شرح"، "مکان"، "شروع"، "پایان" یا "تکرار" قابل انجام نیست. پیش‌فرض False است. فقط خواندنی.
organizer object برگزارکننده رویداد. اگر برگزارکننده خود نیز یکی از شرکت‌کنندگان باشد، این موضوع با یک ورودی جداگانه در attendees با فیلد organizer که روی True تنظیم شده است، نشان داده می‌شود. برای تغییر برگزارکننده، از عملیات جابجایی استفاده کنید. فقط خواندنی، به جز هنگام وارد کردن یک رویداد. قابل نوشتن
organizer. displayName string نام برگزارکننده، در صورت وجود. قابل نوشتن
organizer. email string آدرس ایمیل برگزارکننده، در صورت وجود. این آدرس باید مطابق با RFC5322 معتبر باشد. قابل نوشتن
organizer. id string شناسه پروفایل برگزارکننده، در صورت وجود.
organizer. self boolean اینکه آیا برگزارکننده با تقویمی که این نسخه از رویداد در آن نمایش داده می‌شود، مطابقت دارد یا خیر. فقط خواندنی. مقدار پیش‌فرض False است.
originalStartTime nested object برای یک نمونه از یک رویداد تکرارشونده، این زمانی است که این رویداد طبق داده‌های تکرارشونده در رویداد تکرارشونده که توسط recurringEventId شناسایی شده است، شروع می‌شود. این به طور منحصر به فرد نمونه را در سری رویدادهای تکرارشونده مشخص می‌کند، حتی اگر نمونه به زمان دیگری منتقل شده باشد. تغییرناپذیر.
originalStartTime. date date تاریخ، با فرمت "yyyy-mm-dd"، اگر این رویداد تمام روز باشد. قابل نوشتن
originalStartTime. dateTime datetime زمان، به عنوان یک مقدار ترکیبی تاریخ-زمان (طبق RFC3339 قالب‌بندی شده). انحراف منطقه زمانی مورد نیاز است، مگر اینکه منطقه زمانی به صراحت در timeZone مشخص شده باشد. قابل نوشتن
originalStartTime. timeZone string منطقه زمانی که زمان در آن مشخص شده است. (به صورت نام پایگاه داده منطقه زمانی IANA قالب‌بندی می‌شود، مثلاً "اروپا/زوریخ".) برای رویدادهای تکرارشونده، این فیلد الزامی است و منطقه زمانی را که تکرار در آن گسترش می‌یابد، مشخص می‌کند. برای رویدادهای تکی، این فیلد اختیاری است و یک منطقه زمانی سفارشی برای شروع/پایان رویداد را نشان می‌دهد. قابل نوشتن
outOfOfficeProperties nested object داده‌های رویداد خارج از دفتر. اگر eventType outOfOffice باشد، استفاده می‌شود. قابل نوشتن
outOfOfficeProperties. autoDeclineMode string اینکه آیا دعوت‌نامه‌های جلسه‌ای که با رویدادهای «خروج از دفتر» همپوشانی دارند، رد شوند یا خیر. مقادیر معتبر عبارتند از: declineNone ، به این معنی که هیچ دعوت‌نامه جلسه‌ای رد نمی‌شود؛ declineAllConflictingInvitations ، به این معنی که تمام دعوت‌نامه‌های جلسه متناقض که با رویداد تداخل دارند، رد می‌شوند؛ و declineOnlyNewConflictingInvitations »، به این معنی که فقط دعوت‌نامه‌های جلسه متناقض جدیدی که در حین وجود رویداد «خروج از دفتر» می‌رسند، باید رد شوند.
outOfOfficeProperties. declineMessage string پیام پاسخ برای تنظیم اینکه آیا یک رویداد موجود یا دعوت جدید به طور خودکار توسط تقویم رد شود یا خیر.
privateCopy boolean اگر روی True تنظیم شود، انتشار رویداد غیرفعال می‌شود. توجه داشته باشید که این با ویژگی‌های رویداد خصوصی (Private event properties) متفاوت است. اختیاری. تغییرناپذیر. مقدار پیش‌فرض False است.
recurrence[] list فهرست خطوط RRULE، EXRULE، RDATE و EXDATE برای یک رویداد تکرارشونده، همانطور که در RFC5545 مشخص شده است. توجه داشته باشید که خطوط DTSTART و DTEND در این فیلد مجاز نیستند؛ زمان شروع و پایان رویداد در فیلدهای start و end مشخص شده است. این فیلد برای رویدادهای تکی یا نمونه‌هایی از رویدادهای تکرارشونده حذف می‌شود. قابل نوشتن
recurringEventId string برای یک نمونه از یک رویداد تکرارشونده، این id رویداد تکرارشونده‌ای است که این نمونه به آن تعلق دارد. تغییرناپذیر.
reminders object اطلاعاتی در مورد یادآوری‌های رویداد برای کاربر احراز هویت شده. توجه داشته باشید که تغییر یادآوری‌ها، ویژگی updated رویدادِ دربرگیرنده را نیز تغییر نمی‌دهد.
reminders. overrides[] list اگر رویداد از یادآوری‌های پیش‌فرض استفاده نکند، این فهرست یادآوری‌های مختص به رویداد را نمایش می‌دهد، یا اگر تنظیم نشده باشد، نشان می‌دهد که هیچ یادآوری برای این رویداد تنظیم نشده است. حداکثر تعداد یادآوری‌های لغو شده ۵ است. قابل نوشتن
reminders.overrides[]. method string روشی که این یادآوری استفاده می‌کند. مقادیر ممکن عبارتند از:
  • « email » - یادآوری‌ها از طریق ایمیل ارسال می‌شوند.
  • « popup » - یادآوری‌ها از طریق یک پنجره بازشو در رابط کاربری ارسال می‌شوند.

هنگام اضافه کردن یادآوری الزامی است.

 قابل نوشتن
reminders.overrides[]. minutes integer تعداد دقایق قبل از شروع رویداد که یادآوری باید فعال شود. مقادیر معتبر بین ۰ تا ۴۰۳۲۰ (۴ هفته به دقیقه) هستند.

هنگام اضافه کردن یادآوری الزامی است.

 قابل نوشتن
reminders. useDefault boolean اینکه آیا یادآوری‌های پیش‌فرض تقویم برای رویداد اعمال می‌شوند یا خیر. قابل نوشتن
sequence integer شماره ترتیب طبق iCalendar. قابل نوشتن
source object منبعی که رویداد از آن ایجاد شده است. به عنوان مثال، یک صفحه وب، یک پیام ایمیل یا هر سندی که توسط یک URL با طرح HTTP یا HTTPS قابل شناسایی باشد. فقط توسط ایجادکننده رویداد قابل مشاهده یا تغییر است.
source. title string عنوان منبع؛ برای مثال عنوان یک صفحه وب یا موضوع یک ایمیل. قابل نوشتن
source. url string آدرس اینترنتی (URL) منبع که به یک منبع اشاره می‌کند. طرح URL باید HTTP یا HTTPS باشد. قابل نوشتن
start nested object زمان شروع (شامل) رویداد. برای یک رویداد تکرارشونده، این زمان شروع اولین نمونه است.
start. date date تاریخ، با فرمت "yyyy-mm-dd"، اگر این رویداد تمام روز باشد. قابل نوشتن
start. dateTime datetime زمان، به عنوان یک مقدار ترکیبی تاریخ-زمان (طبق RFC3339 قالب‌بندی شده). انحراف منطقه زمانی مورد نیاز است، مگر اینکه منطقه زمانی به صراحت در timeZone مشخص شده باشد. قابل نوشتن
start. timeZone string منطقه زمانی که زمان در آن مشخص شده است. (به صورت نام پایگاه داده منطقه زمانی IANA قالب‌بندی می‌شود، مثلاً "اروپا/زوریخ".) برای رویدادهای تکرارشونده، این فیلد الزامی است و منطقه زمانی را که تکرار در آن گسترش می‌یابد، مشخص می‌کند. برای رویدادهای تکی، این فیلد اختیاری است و یک منطقه زمانی سفارشی برای شروع/پایان رویداد را نشان می‌دهد. قابل نوشتن
status string وضعیت رویداد. اختیاری. مقادیر ممکن عبارتند از:
  • « confirmed » - رویداد تأیید شده است. این وضعیت پیش‌فرض است.
  • « tentative » - این رویداد به طور آزمایشی تأیید شده است.
  • " cancelled " - رویداد لغو شده (حذف شده) است. متد list رویدادهای لغو شده را فقط در صورت همگام‌سازی افزایشی (زمانی که syncToken یا updatedMin مشخص شده باشند) یا اگر پرچم showDeleted روی true تنظیم شده باشد، برمی‌گرداند. متد get همیشه آنها را برمی‌گرداند.

    وضعیت لغو شده بسته به نوع رویداد، دو حالت مختلف را نشان می‌دهد:

    1. استثنائات لغو شده از یک رویداد تکرارشونده لغو نشده نشان می‌دهد که این نمونه دیگر نباید به کاربر ارائه شود. کلاینت‌ها باید این رویدادها را برای طول عمر رویداد تکرارشونده والد ذخیره کنند.

      استثنائات لغو شده فقط تضمین می‌کنند که مقادیر فیلدهای id ، recurringEventId و originalStartTime پر شوند. فیلدهای دیگر ممکن است خالی باشند.

    2. تمام رویدادهای لغو شده دیگر، رویدادهای حذف شده محسوب می‌شوند. کلاینت‌ها باید کپی‌های همگام‌سازی شده محلی خود را حذف کنند. چنین رویدادهای لغو شده‌ای در نهایت ناپدید می‌شوند، بنابراین به در دسترس بودن نامحدود آنها تکیه نکنید.

      Deleted events are only guaranteed to have the id field populated.

    در تقویم سازمان‌دهنده، رویدادهای لغو شده همچنان جزئیات رویداد (خلاصه، مکان و غیره) را نمایش می‌دهند تا بتوان آنها را بازیابی (حذف نشده) کرد. به طور مشابه، رویدادهایی که کاربر به آنها دعوت شده و به صورت دستی حذف کرده است، همچنان جزئیات را ارائه می‌دهند. با این حال، درخواست‌های همگام‌سازی افزایشی با مقدار نادرست showDeleted ، این جزئیات را برنمی‌گردانند.

    اگر یک رویداد، برگزارکننده خود را تغییر دهد (برای مثال از طریق عملیات جابجایی ) و برگزارکننده اصلی در لیست شرکت‌کنندگان نباشد، یک رویداد لغو شده باقی می‌ماند که در آن فقط فیلد id تضمین می‌شود که پر شود.

 قابل نوشتن
summary string عنوان رویداد. قابل نوشتن
transparency string اینکه آیا رویداد، زمان را در تقویم مسدود می‌کند یا خیر. اختیاری. مقادیر ممکن عبارتند از:
  • « opaque » - مقدار پیش‌فرض. این رویداد زمان را در تقویم مسدود می‌کند. این معادل تنظیم «به من نشان بده به عنوان مشغول» در رابط کاربری تقویم است.
  • « transparent » - این رویداد زمان را در تقویم مسدود نمی‌کند. این معادل تنظیم «به من نشان بده به عنوان موجود در رابط کاربری تقویم» است.
 قابل نوشتن
updated datetime زمان آخرین تغییر داده‌های رویداد اصلی (به عنوان یک مهر زمانی RFC3339 ). به‌روزرسانی یادآوری‌های رویداد باعث تغییر این زمان نمی‌شود. فقط خواندنی.
visibility string قابلیت مشاهده رویداد. اختیاری. مقادیر ممکن عبارتند از:
  • « default » - از مقدار پیش‌فرض نمایش رویدادها در تقویم استفاده می‌کند. این مقدار پیش‌فرض است.
  • « public » - رویداد عمومی است و جزئیات رویداد برای همه خوانندگان تقویم قابل مشاهده است.
  • « private » - این رویداد خصوصی است و فقط شرکت‌کنندگان در رویداد می‌توانند جزئیات رویداد را مشاهده کنند.
  • « confidential » - این رویداد خصوصی است. این مقدار به دلایل سازگاری ارائه شده است.
 قابل نوشتن
workingLocationProperties nested object داده‌های رویداد محل کار. قابل نوشتن
workingLocationProperties. customLocation object در صورت وجود، مشخص می‌کند که کاربر از یک مکان سفارشی کار می‌کند. قابل نوشتن
workingLocationProperties.customLocation. label string یک برچسب اضافی اختیاری برای اطلاعات بیشتر. قابل نوشتن
workingLocationProperties. homeOffice any value در صورت وجود، مشخص می‌کند که کاربر در خانه کار می‌کند. قابل نوشتن
workingLocationProperties. officeLocation object در صورت وجود، مشخص می‌کند که کاربر از یک دفتر کار می‌کند. قابل نوشتن
workingLocationProperties.officeLocation. buildingId string یک شناسه ساختمان اختیاری. این شناسه باید به یک شناسه ساختمان در پایگاه داده منابع سازمان ارجاع دهد. قابل نوشتن
workingLocationProperties.officeLocation. deskId string یک شناسه میز اختیاری. قابل نوشتن
workingLocationProperties.officeLocation. floorId string یک شناسه طبقه اختیاری. قابل نوشتن
workingLocationProperties.officeLocation. floorSectionId string یک شناسه‌ی اختیاری برای مقطع کف. قابل نوشتن
workingLocationProperties.officeLocation. label string نام دفتر که در کلاینت‌های تقویم وب و موبایل نمایش داده می‌شود. توصیه می‌کنیم نام ساختمان را در پایگاه داده منابع سازمان ذکر کنید. قابل نوشتن
workingLocationProperties. type string نوع محل کار. مقادیر ممکن عبارتند از:
  • « homeOffice » - کاربر در خانه مشغول به کار است.
  • « officeLocation » - کاربر در حال کار از یک دفتر است.
  • « customLocation » - کاربر از یک مکان سفارشی کار می‌کند.
هر جزئیاتی در یک فیلد فرعی با نام مشخص شده مشخص می‌شود، اما اگر این فیلد خالی باشد، ممکن است وجود نداشته باشد. هر فیلد دیگری نادیده گرفته می‌شود.

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

 قابل نوشتن

روش‌ها

حذف
یک رویداد را حذف می‌کند.
دریافت
یک رویداد را بر اساس شناسه تقویم گوگل آن برمی‌گرداند. برای بازیابی یک رویداد با استفاده از شناسه iCalendar آن، متد events.list را با استفاده از پارامتر iCalUID فراخوانی کنید.
واردات
یک رویداد را وارد می‌کند. این عملیات برای اضافه کردن یک کپی خصوصی از یک رویداد موجود به تقویم استفاده می‌شود. فقط رویدادهایی که eventType آنها default ، می‌توانند وارد شوند.

رفتار منسوخ‌شده: اگر یک رویداد غیر default وارد شود، نوع آن به default تغییر می‌کند و هرگونه ویژگی مختص به نوع رویداد که ممکن است داشته باشد، حذف می‌شود.

درج
یک رویداد ایجاد می‌کند.
موارد
نمونه‌هایی از رویداد تکرارشونده مشخص شده را برمی‌گرداند.
فهرست
رویدادهای تقویم مشخص شده را برمی‌گرداند.
حرکت
یک رویداد را به تقویم دیگری منتقل می‌کند، یعنی سازمان‌دهنده‌ی رویداد را تغییر می‌دهد. توجه داشته باشید که فقط رویدادهای default را می‌توان منتقل کرد؛ رویدادهای birthday ، focusTime ، fromGmail ، outOfOffice و workingLocation قابل انتقال نیستند.
پچ
یک رویداد را به‌روزرسانی می‌کند. این روش از معنای وصله (patch semantics) پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ بهتر است از get و به دنبال آن update استفاده کنید. مقادیر فیلدی که مشخص می‌کنید جایگزین مقادیر موجود می‌شوند. فیلدهایی که در درخواست مشخص نمی‌کنید بدون تغییر باقی می‌مانند. فیلدهای آرایه، در صورت مشخص شدن، آرایه‌های موجود را بازنویسی می‌کنند. این کار عناصر آرایه قبلی را حذف می‌کند.
افزودن سریع
یک رویداد بر اساس یک رشته متنی ساده ایجاد می‌کند.
به‌روزرسانی
یک رویداد را به‌روزرسانی می‌کند. این روش از معنای وصله پشتیبانی نمی‌کند و همیشه کل منبع رویداد را به‌روزرسانی می‌کند. برای انجام یک به‌روزرسانی جزئی، برای اطمینان از اتمی بودن، یک get و به دنبال آن یک update با استفاده از etags انجام دهید.
تماشا کنید
منتظر تغییرات در منابع رویدادها باشید.