Method: users.watch

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

درخواست HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

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

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

پارامترها
userId

string

آدرس ایمیل کاربر. مقدار ویژه me می تواند برای نشان دادن کاربر تأیید شده استفاده شود.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
فیلدها
labelIds[]

string

فهرست labelIds برای محدود کردن اعلان‌ها. به طور پیش فرض، اگر مشخص نشده باشد، همه تغییرات حذف می شوند. اگر مشخص شده باشد، تعیین می کند که چه برچسب هایی برای ایجاد یک اعلان فشار لازم است.

labelFilterAction
(deprecated)

enum ( LabelFilterAction )

رفتار فیلتر کردن labelIds list مشخص شده است. این فیلد منسوخ شده است زیرا در برخی موارد باعث رفتار نادرست شده است. به جای آن از labelFilterBehavior استفاده کنید.

labelFilterBehavior

enum ( LabelFilterAction )

رفتار فیلتر کردن labelIds list مشخص شده است. این فیلد جایگزین labelFilterAction می شود. اگر تنظیم شود، labelFilterAction نادیده گرفته می شود.

topicName

string

نام موضوع Google Cloud Pub/Sub API کاملاً واجد شرایط برای انتشار رویدادها. این نام موضوع باید قبلاً در Cloud Pub/Sub وجود داشته باشد و شما باید قبلاً مجوز "انتشار" به جیمیل را برای آن اعطا کرده باشید. به عنوان مثال، "projects/my-project-identifier/topics/my-topic-name" (با استفاده از قالب نام‌گذاری موضوع Cloud Pub/Sub "v1").

توجه داشته باشید که بخش «شناسه پروژه من» باید دقیقاً با شناسه پروژه توسعه‌دهنده Google شما (که این درخواست تماشا را اجرا می‌کند) مطابقت داشته باشد.

بدن پاسخگو

پاسخ ساعت اعلان فشاری.

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

نمایندگی JSON 
{
  "historyId": string,
  "expiration": string
}
فیلدها
historyId

string

شناسه سابقه سابقه فعلی صندوق پست.

expiration

string ( int64 format)

زمانی که Gmail ارسال اعلان‌ها برای به‌روزرسانی‌های صندوق پستی را متوقف می‌کند (دوران ملی). قبل از این زمان دوباره با watch تماس بگیرید تا ساعت را تمدید کنید.

محدوده مجوز

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

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

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

LabelFilterAction

رفتار فیلتر کردن لیست labelIds مشخص شده است.

Enums
include فقط برای تغییرات پیام مربوط به labelIds مشخص شده، اعلان‌های فشاری دریافت کنید.
exclude اعلان‌های فشاری برای همه تغییرات پیام به جز موارد مربوط به labelIds مشخص شده دریافت کنید.