إعداد ساعة الإشعارات الفورية أو تعديلها في صندوق البريد الإلكتروني الخاص بالمستخدم المحدّد
طلب HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
userId |
عنوان البريد الإلكتروني للمستخدِم. يمكن استخدام القيمة الخاصة |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
الحقول | |
---|---|
labelIds[] |
قائمة بأرقام تعريف التصنيفات لحظر الإشعارات المتعلقة بها. وبشكلٍ تلقائي، إذا لم يتم تحديد ذلك، يتم دفع جميع التغييرات. في حال تحديدها، يحدِّد ذلك التصنيفات المطلوبة لإنشاء إشعار فوري. |
labelFilterAction |
تم تحديد سلوك الفلترة لـ |
labelFilterBehavior |
تم تحديد سلوك الفلترة لـ |
topicName |
اسم موضوع مؤهل بالكامل في Google Cloud Pub/Sub API لنشر الفعاليات فيه. يجب أن يكون اسم الموضوع هذا متاحًا في Cloud Pub/Sub ويجب أن تكون قد منحت ميزة "النشر" في Gmail من قبل. الحصول على إذن في ذلك. على سبيل المثال، "projects/my-project-identifier/topics/my-topic-name" (باستخدام تنسيق تسمية المواضيع "الإصدار 1" من Cloud Pub/Sub). تجدر الإشارة إلى أنّ قيمة "my-project-identifier" يجب أن يتطابق الجزء تمامًا مع معرّف مشروع مطوّر Google (الرقم الذي ينفّذ طلب المشاهدة هذا). |
نص الاستجابة
الرد على الإشعارات الفورية على الساعة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "historyId": string, "expiration": string } |
الحقول | |
---|---|
historyId |
رقم تعريف السجل الحالي لصندوق البريد الإلكتروني |
expiration |
الوقت الذي سيتوقف فيه Gmail عن إرسال إشعارات بشأن تحديثات صندوق البريد الإلكتروني (الحقبة بالمللي ثانية) يُرجى الاتصال بـ " |
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات 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
تم تحديد سلوك الفلترة لقائمة أرقام تعريف التصنيفات.
عمليات التعداد | |
---|---|
include |
يمكنك تلقّي إشعارات فورية فقط بشأن تغييرات الرسائل ذات الصلة بأرقام تعريف التصنيفات المحدّدة. |
exclude |
تلقّي إشعارات فورية لجميع تغييرات الرسائل باستثناء التغييرات المتعلقة بأرقام تعريف التصنيفات المحدّدة. |