Method: users.watch

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

درخواست HTTP

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

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

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

پارامترها
userId

string

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

درخواست بدنه

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

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

string

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

labelFilterAction
(deprecated)

enum ( LabelFilterAction )

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

labelFilterBehavior

enum ( LabelFilterAction )

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

topicName

string

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

توجه داشته باشید که بخش "my-project-identifier" باید دقیقاً با شناسه پروژه توسعه‌دهنده گوگل شما (که این درخواست watch را اجرا می‌کند) مطابقت داشته باشد.

بدنه پاسخ

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

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

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

string

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

expiration

string ( int64 format)

چه زمانی جیمیل ارسال اعلان‌ها برای به‌روزرسانی‌های صندوق پستی را متوقف می‌کند (epoch millis). قبل از این زمان، دوباره watch تماس بگیرید تا 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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

اقدام برچسب فیلتر

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

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