Events: patch

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

درخواست

درخواست HTTP 

PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای مسیر
calendarId string شناسه تقویم. برای بازیابی شناسه‌های تقویم، متد calendarList.list را فراخوانی کنید. اگر می‌خواهید به تقویم اصلی کاربر فعلی وارد شده دسترسی پیدا کنید، از کلمه کلیدی " primary " استفاده کنید.
eventId string شناسه رویداد.
پارامترهای پرس و جو اختیاری
alwaysIncludeEmail boolean منسوخ و نادیده گرفته شده. حتی اگر هیچ آدرس ایمیل واقعی در دسترس نباشد، همیشه مقداری در فیلد email برای برگزارکننده، سازنده و شرکت‌کنندگان بازگردانده می‌شود (یعنی یک مقدار تولید شده و غیرفعال ارائه خواهد شد).
conferenceDataVersion integer شماره نسخه داده‌های کنفرانس پشتیبانی‌شده توسط کلاینت API. نسخه 0 فرض می‌کند که از داده‌های کنفرانس پشتیبانی نمی‌شود و داده‌های کنفرانس را در بدنه رویداد نادیده می‌گیرد. نسخه 1 پشتیبانی از کپی کردن ConferenceData و همچنین ایجاد کنفرانس‌های جدید با استفاده از فیلد createRequest از conferenceData را فعال می‌کند. مقدار پیش‌فرض 0 است. مقادیر قابل قبول 0 تا 1 هستند.
eventLabelVersion integer شماره نسخه ویژگی برچسب رویداد که توسط کلاینت API پشتیبانی می‌شود. نسخه 0 فرض می‌کند که هیچ پشتیبانی از برچسب رویداد وجود ندارد و فیلد colorId را برای مدیریت رنگ پردازش می‌کند. نسخه 1 پشتیبانی از برچسب‌های رویداد را فعال می‌کند و eventLabelId را در بدنه رویداد پردازش می‌کند. در این حالت، فیلد colorId نادیده گرفته می‌شود. مقدار پیش‌فرض 0 است. مقادیر قابل قبول 0 تا 1 هستند.
maxAttendees integer حداکثر تعداد شرکت‌کنندگانی که باید در پاسخ لحاظ شوند. اگر تعداد شرکت‌کنندگان از تعداد مشخص‌شده بیشتر باشد، فقط نام شرکت‌کننده برگردانده می‌شود. اختیاری.
sendNotifications boolean منسوخ شده. لطفاً به جای آن از sendUpdates استفاده کنید.

اینکه آیا اعلان‌هایی درباره به‌روزرسانی رویداد (مثلاً تغییرات توضیحات و غیره) ارسال شود یا خیر. توجه داشته باشید که حتی اگر مقدار را روی false تنظیم کنید، ممکن است برخی از ایمیل‌ها همچنان ارسال شوند. مقدار پیش‌فرض false است.
sendUpdates string مهمانانی که باید در مورد به‌روزرسانی رویداد (مثلاً تغییر عنوان و غیره) اعلان دریافت کنند.

مقادیر قابل قبول عبارتند از:
  • « all »: اعلان‌ها برای همه مهمانان ارسال می‌شوند.
  • « externalOnly »: اعلان‌ها فقط برای مهمانانی که تقویم گوگل ندارند ارسال می‌شوند.
  • « none »: هیچ اعلانی ارسال نمی‌شود. برای وظایف انتقال تقویم، به جای آن از متد Events.import استفاده کنید.
supportsAttachments boolean اینکه آیا کلاینت API که عملیات را انجام می‌دهد از پیوست‌های رویداد پشتیبانی می‌کند یا خیر. اختیاری. پیش‌فرض False است.

مجوز

این درخواست نیاز به مجوز با حداقل یکی از حوزه‌های زیر دارد:

محدوده
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.

درخواست بدنه

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

پاسخ

در صورت موفقیت، این متد یک منبع رویدادها (Events resource) را در بدنه پاسخ برمی‌گرداند.

امتحانش کن!

از API Explorer زیر برای فراخوانی این متد روی داده‌های زنده و مشاهده پاسخ استفاده کنید.