Method: users.availability.markAsDoNotDisturb

کاربر را در چت گوگل به عنوان DO_NOT_DISTURB علامت‌گذاری می‌کند.

وضعیت دسترسی کاربر را تا زمان انقضای مشخص شده روی DO_NOT_DISTURB تنظیم می‌کند. در حالت DO_NOT_DISTURB ، کاربران معمولاً اعلانی دریافت نمی‌کنند.

این روش فقط در دسترس بودن کاربر احراز هویت شده را به‌روزرسانی می‌کند.

نیاز به احراز هویت کاربر با دامنه مجوز :

  • https://www.googleapis.com/auth/chat.users.availability

درخواست HTTP

POST https://chat.googleapis.com/v1/{name=users/*/availability}:markAsDoNotDisturb

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

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

پارامترها
name

string

الزامی. نام منبعِ در دسترس بودن برای علامت‌گذاری به عنوان «مزاحم نشوید». قالب: users/{user}/availability.

{user} شناسه‌ی Person در People API یا Admin SDK directory API است. برای مثال، users/123456789 .

آدرس ایمیل کاربر یا me نیز می‌تواند به عنوان نام مستعار برای اشاره به تماس‌گیرنده استفاده شود. برای مثال، users/user@example.com یا users/me .

درخواست بدنه

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

نمایش JSON 
{

  "expireTime": string,
  "ttl": string
}
فیلدها
الزامی. انقضای وضعیت دسترسی DND. کاربر پس از انقضا به عنوان غایب علامت‌گذاری می‌شود. این می‌تواند حداکثر ۱ سال از زمان فعلی باشد. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم می‌شود:
expireTime

string ( Timestamp format)

مهر زمانی مطلق زمانی که وضعیت DND منقضی می‌شود.

ttl

string ( Duration format)

مدت زمان از زمان فعلی تا انقضای وضعیت DND.

پایان میدان‌های ناسازگار.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Availability است.

دامنه‌های مجوز

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

  • https://www.googleapis.com/auth/chat.users.availability

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