Method: subscriptions.patch

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

برای اشتراک در یک منبع هدف چت ، می‌توانید اشتراک را به صورت زیر به‌روزرسانی کنید:

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
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/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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