Method: users.watch

يمكنك إعداد أو تعديل ميزة "مشاهدة الإشعارات الفورية" في صندوق البريد الإلكتروني للمستخدم المحدّد.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز 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/معرّف-مشروعي/topics/اسم-موضوعي" (باستخدام تنسيق تسمية المواضيع في الإصدار 1 من Cloud Pub/Sub).

يُرجى العلم أنّ الجزء my-project-identifier يجب أن يتطابق تمامًا مع معرّف مشروعك كمطوّر على 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

سلوك الفلترة لقائمة ids_of_labels المحدّدة

عمليات التعداد
include لا تتلقّى إشعارات فورية إلا لتغييرات الرسائل ذات الصلة بـ labelIds المحدّدة.
exclude تلقّي إشعارات فورية بشأن جميع تغييرات الرسائل باستثناء التغييرات المتعلقة بـ labelIds المحدّدة