Method: users.watch

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المعلّمات
userId

string

عنوان البريد الإلكتروني للمستخدم يمكن استخدام القيمة الخاصة me للإشارة إلى المستخدم الذي تمت المصادقة عليه.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "topicName": string
}
الحقول
labelIds[]

string

قائمة أرقام تعريف التصنيفات لحظر الإشعارات المتعلقة بها وبشكل تلقائي، يتم فرض جميع التغييرات في حال عدم تحديدها. وإذا تم تحديد ذلك، سيتم تحديد التصنيفات المطلوبة لإنشاء إشعار فوري.
labelFilterAction

enum (LabelFilterAction)

تم تحديد سلوك الفلترة لقائمة labelIds.
topicName

string

اسم موضوع مؤهّل بالكامل لخدمة Google Cloud Pub/Sub API لنشر الأحداث عليه. يجب أن يكون اسم الموضوع هذا متوفّرًا حاليًا في Cloud Pub/Sub، ويجب أن تكون قد منحت إذن "النشر" في Gmail له. على سبيل المثال، "projects/my-project-identifier/topics/my-topic-name" (باستخدام تنسيق تسمية المواضيع Pub/Sub "v1" ).

يُرجى العِلم أنّ جزء "my-project-identifier" يجب أن يتطابق تمامًا مع رقم تعريف مشروع Google Developer (الرقم الذي ينفّذ طلب المشاهدة هذا).

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

الردّ على ساعة الإشعارات

تمثيل 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

لمزيد من المعلومات، اطّلِع على دليل التفويض.

إجراء الفلترة

تم تحديد سلوك الفلترة لقائمة labelIds.

عمليات التعداد
include يمكنك تلقّي إشعارات فورية فقط بالتغييرات على الرسائل المتعلّقة بأرقام تعريف التصنيفات المحدّدة.
exclude يمكنك تلقّي إشعارات فورية بشأن جميع التغييرات في الرسائل، باستثناء التغييرات المتعلّقة بالمعرِّفات label.