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 اینکه آیا هر کسی می تواند خود را به رویداد دعوت کند یا نه (منسوخ شده است). اختیاری. پیش فرض نادرست است. قابل نوشتن
attachments[] list فایل پیوست رویداد

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

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

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

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

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

برای افزودن پیوست‌های فایل Google Drive از همان قالبی که در ویژگی alternateLink منبع Files در Drive API استفاده می‌شود، استفاده کنید.

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

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

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

 قابل نوشتن
attendees[]. id string شناسه نمایه شرکت کننده، در صورت موجود بودن.
attendees[]. optional boolean آیا این یک شرکت کننده اختیاری است. اختیاری. پیش فرض نادرست است. قابل نوشتن
attendees[]. organizer boolean آیا شرکت کننده سازمان دهنده رویداد است. فقط خواندنی پیش فرض نادرست است.
attendees[]. resource boolean آیا شرکت کننده یک منبع است. فقط زمانی تنظیم می شود که شرکت کننده برای اولین بار به رویداد اضافه شود. اصلاحات بعدی نادیده گرفته می شود. اختیاری. پیش فرض نادرست است. قابل نوشتن
attendees[]. responseStatus string وضعیت پاسخ شرکت کنندگان مقادیر ممکن عبارتند از:
  • " needsAction " - شرکت کننده به دعوت نامه پاسخ نداده است (برای رویدادهای جدید توصیه می شود).
  • " declined " - شرکت کننده دعوت را رد کرده است.
  • " tentative " - شرکت کننده به طور آزمایشی دعوت را پذیرفته است.
  • " accepted " - شرکت کننده دعوت را پذیرفته است.
 قابل نوشتن
attendees[]. self boolean آیا این ورودی نشان دهنده تقویمی است که این کپی از رویداد در آن ظاهر می شود. فقط خواندنی پیش فرض نادرست است.
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 شناسه کنفرانس

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

مقدار ID برای هر نوع راه حل کنفرانس متفاوت است:

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

conferenceData. conferenceSolution nested object راه حل کنفرانس، مانند Google Meet.

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

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

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

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

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

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

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" برای Google Meet (http://meet.google.com)
  • "addOn" برای ارائه دهندگان کنفرانس 3P

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 کد دسترسی برای دسترسی به کنفرانس. حداکثر طول 128 کاراکتر است.

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

اختیاری.

conferenceData.entryPoints[]. entryPointType string نوع نقطه ورودی کنفرانس

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

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

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

مثال ها:

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

اختیاری.

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

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

اختیاری.

conferenceData.entryPoints[]. passcode string رمز ورود به کنفرانس حداکثر طول 128 کاراکتر است.

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

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

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

اختیاری.

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

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

اختیاری.

conferenceData.entryPoints[]. uri string URI نقطه ورود. حداکثر طول 1300 کاراکتر است.

قالب:

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

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

در سمت سرور ایجاد شده است.

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

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

created datetime زمان ایجاد رویداد (به عنوان مهر زمانی RFC3339 ). فقط خواندنی
creator object خالق رویداد. فقط خواندنی
creator. displayName string نام سازنده، در صورت موجود بودن.
creator. email string آدرس ایمیل سازنده، در صورت وجود.
creator. id string شناسه نمایه سازنده، در صورت موجود بودن.
creator. self boolean آیا سازنده با تقویمی که این کپی از رویداد در آن ظاهر می شود مطابقت دارد یا خیر. فقط خواندنی پیش فرض نادرست است.
description string شرح رویداد. می تواند حاوی HTML باشد. اختیاری. قابل نوشتن
end nested object زمان پایان (انحصاری) رویداد. برای یک رویداد تکراری، این زمان پایان اولین نمونه است.
end. date date اگر این یک رویداد تمام روز باشد، تاریخ، با فرمت "yyyy-mm-dd". قابل نوشتن
end. dateTime datetime زمان، به عنوان یک مقدار ترکیبی تاریخ-زمان (بر اساس RFC3339 قالب‌بندی شده است). یک افست منطقه زمانی مورد نیاز است مگر اینکه یک منطقه زمانی به صراحت در timeZone مشخص شده باشد. قابل نوشتن
end. timeZone string منطقه زمانی که زمان در آن مشخص شده است. (قالب بندی شده به عنوان نام پایگاه داده منطقه زمانی IANA، به عنوان مثال "اروپا/زوریخ".) برای رویدادهای تکرار شونده، این فیلد مورد نیاز است و منطقه زمانی را که در آن تکرار گسترش می یابد، مشخص می کند. برای رویدادهای تک این فیلد اختیاری است و یک منطقه زمانی سفارشی را برای شروع/پایان رویداد نشان می‌دهد. قابل نوشتن
endTimeUnspecified boolean آیا زمان پایان واقعاً نامشخص است یا خیر. حتی اگر این ویژگی روی True تنظیم شده باشد، همچنان به دلایل سازگاری، زمان پایان ارائه می‌شود. پیش فرض نادرست است.
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 داده‌های رویداد Focus Time. اگر 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 ارتفاع این ابزار به پیکسل. ارتفاع باید یک عدد صحیح بزرگتر از 0 باشد. اختیاری است. منسوخ شده است. قابل نوشتن
gadget. preferences object ترجیحات قابل نوشتن
gadget.preferences. (key) string نام ترجیحی و مقدار مربوطه.
gadget. title string عنوان ابزار. منسوخ شده است. قابل نوشتن
gadget. type string نوع گجت منسوخ شده است. قابل نوشتن
gadget. width integer عرض ابزار به پیکسل. عرض باید یک عدد صحیح بزرگتر از 0 باشد. اختیاری است. منسوخ شده است. قابل نوشتن
guestsCanInviteOthers boolean آیا شرکت‌کنندگانی غیر از سازمان‌دهنده می‌توانند دیگران را به رویداد دعوت کنند. اختیاری. پیش فرض True است. قابل نوشتن
guestsCanModify boolean آیا شرکت‌کنندگانی غیر از سازمان‌دهنده می‌توانند رویداد را تغییر دهند یا خیر. اختیاری. پیش فرض نادرست است. قابل نوشتن
guestsCanSeeOtherGuests boolean آیا شرکت‌کنندگانی غیر از سازمان‌دهنده می‌توانند ببینند شرکت‌کنندگان رویداد چه کسانی هستند یا خیر. اختیاری. پیش فرض True است. قابل نوشتن
iCalUID string شناسه منحصر به فرد رویداد همانطور که در RFC5545 تعریف شده است. برای شناسایی منحصر به فرد رویدادها در سراسر سیستم های تقویم استفاده می شود و باید هنگام وارد کردن رویدادها از طریق روش واردات ارائه شود.

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

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

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

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

 قابل نوشتن
kind string نوع منبع (" calendar#event ").
location string موقعیت جغرافیایی رویداد به عنوان متن آزاد. اختیاری. قابل نوشتن
locked boolean خواه این یک کپی رویداد قفل شده باشد که در آن هیچ تغییری در فیلدهای رویداد اصلی "خلاصه"، "توضیحات"، "مکان"، "شروع"، "پایان" یا "تکرار" ایجاد نشود. پیش فرض نادرست است. فقط خواندنی.
organizer object برگزار کننده این رویداد. اگر سازمان‌دهنده نیز یک شرکت‌کننده باشد، با یک ورودی جداگانه در attendees با فیلد organizer روی True مشخص می‌شود. برای تغییر سازمان دهنده، از عملیات انتقال استفاده کنید. فقط خواندنی، به جز هنگام وارد کردن یک رویداد. قابل نوشتن
organizer. displayName string نام سازمان دهنده، در صورت موجود بودن. قابل نوشتن
organizer. email string آدرس ایمیل سازمان دهنده، در صورت وجود. این باید یک آدرس ایمیل معتبر مطابق با RFC5322 باشد. قابل نوشتن
organizer. id string شناسه نمایه سازمان‌دهنده، در صورت موجود بودن.
organizer. self boolean اینکه آیا سازمان دهنده با تقویمی که این کپی از رویداد در آن نمایش داده می شود مطابقت دارد یا خیر. فقط خواندنی پیش فرض نادرست است.
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 تنظیم شود، انتشار رویداد غیرفعال می شود. توجه داشته باشید که این ویژگی مشابه خصوصیات رویداد خصوصی نیست. اختیاری. تغییرناپذیر. پیش فرض نادرست است.
recurrence[] list فهرست خطوط RRULE، EXRULE، RDATE و EXDATE برای یک رویداد تکرارشونده، همانطور که در RFC5545 مشخص شده است. توجه داشته باشید که خطوط DTSTART و DTEND در این قسمت مجاز نیستند. زمان شروع و پایان رویداد در قسمت های start و end مشخص شده است. این فیلد برای رویدادهای منفرد یا مواردی از رویدادهای تکرار شونده حذف شده است. قابل نوشتن
recurringEventId string برای نمونه ای از یک رویداد تکرار شونده، این id رویداد تکرار شونده ای است که این نمونه به آن تعلق دارد. تغییرناپذیر.
reminders object اطلاعات مربوط به یادآورهای رویداد برای کاربر تأیید شده. توجه داشته باشید که تغییر یادآورها ویژگی updated رویداد محصورکننده را نیز تغییر نمی‌دهد.
reminders. overrides[] list اگر رویداد از یادآورهای پیش‌فرض استفاده نمی‌کند، یادآوری‌های خاص رویداد را فهرست می‌کند، یا اگر تنظیم نشده باشد، نشان می‌دهد که هیچ یادآوری برای این رویداد تنظیم نشده است. حداکثر تعداد یادآورهای لغو 5 عدد است. قابل نوشتن
reminders.overrides[]. method string روش استفاده شده توسط این یادآوری. مقادیر ممکن عبارتند از:
  • " email " - یادآوری ها از طریق ایمیل ارسال می شوند.
  • " popup " - یادآوری ها از طریق یک پنجره بازشو UI ارسال می شوند.

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

 قابل نوشتن
reminders.overrides[]. minutes integer تعداد دقیقه‌های قبل از شروع رویداد که یادآور باید راه‌اندازی شود. مقادیر معتبر بین 0 تا 40320 (4 هفته در دقیقه) هستند.

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

 قابل نوشتن
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 " - رویداد لغو شد (حذف شد). روش لیست رویدادهای لغو شده را فقط در همگام سازی افزایشی (زمانی که syncToken یا updatedMin مشخص شده است) برمی گرداند یا اگر پرچم showDeleted روی true تنظیم شده باشد. متد دریافت همیشه آنها را برمی گرداند.

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

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

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

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

      رویدادهای حذف شده فقط برای پر شدن فیلد id تضمین می شود.

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

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

 قابل نوشتن
summary string عنوان رویداد. قابل نوشتن
transparency string آیا رویداد زمان را در تقویم مسدود می کند یا خیر. اختیاری. مقادیر ممکن عبارتند از:
  • " opaque " - مقدار پیش فرض. این رویداد زمان را در تقویم مسدود می کند. این معادل تنظیم Show me as برای Busy در Calendar UI است.
  • " transparent " - رویداد زمان را در تقویم مسدود نمی کند. این معادل با تنظیم Show me as برای موجود در رابط کاربری تقویم است.
 قابل نوشتن
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 نام دفتری که در Calendar Web and Mobile Clients نمایش داده می شود. توصیه می کنیم نام ساختمان را در پایگاه داده منابع سازمان ذکر کنید. قابل نوشتن
workingLocationProperties. type string نوع محل کار مقادیر ممکن عبارتند از:
  • " homeOffice " - کاربر در خانه کار می کند.
  • " officeLocation " - کاربر از یک دفتر کار می کند.
  • " customLocation " - کاربر از یک مکان سفارشی کار می کند.
هر گونه جزئیات در قسمت فرعی نام مشخص شده مشخص شده است، اما اگر خالی باشد ممکن است این فیلد وجود نداشته باشد. هر فیلد دیگری نادیده گرفته می شود.

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

 قابل نوشتن

روش ها

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

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

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