Method: subscriptions.patch

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

درخواست HTTP

PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
subscription.name

string

شناسه. نام منبع اشتراک.

قالب: subscriptions/{subscription}

پارامترهای پرس و جو

پارامترها
updateMask

string ( FieldMask format)

اختیاری. زمینه به روز رسانی. در صورت حذف، فیلدهای موجود در درخواست را به روز می کند.

می‌توانید یکی از فیلدهای زیر را در اشتراک به‌روزرسانی کنید:

  • expireTime : مهر زمانی که اشتراک منقضی می شود.
  • ttl : مدت زمان اشتراک (TTL) یا مدت زمان اشتراک.
  • eventTypes : فهرست انواع رویدادهایی که باید در مورد منبع هدف دریافت کنید.

هنگام استفاده از علامت * (معادل PUT )، فیلدهای حذف شده روی مقادیر خالی تنظیم می شوند و در صورت نامعتبر بودن رد می شوند.

validateOnly

boolean

اختیاری. اگر روی true تنظیم شود، درخواست را تأیید و پیش نمایش می کند، اما اشتراک را به روز نمی کند.

درخواست بدن

بدنه درخواست شامل نمونه ای از Subscription است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation است.

  • فیلد metadata حاوی یک آرایه خالی است.
  • فیلد response حاوی یک نمونه به روز شده از Subscription است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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