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 کنفرانس دیتا را امکان پذیر می کند. مقدار پیش‌فرض 0 است. مقادیر قابل قبول 0 تا 1 هستند.
maxAttendees integer حداکثر تعداد شرکت کنندگانی که باید در پاسخ درج شود. در صورتی که تعداد شرکت کنندگان بیشتر از تعداد مشخص شده باشد، فقط شرکت کننده برگردانده می شود. اختیاری.
sendNotifications boolean منسوخ شده است. لطفاً به جای آن از sendUpdates استفاده کنید.

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

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

مجوز

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

دامنه
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

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

درخواست بدن

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

پاسخ

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

آن را امتحان کنید!

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