يمكنك استخدام الطرق الواردة في مجموعة الساعات لتلقّي إشعارات عندما تتغيّر البيانات في النماذج. توفر هذه الصفحة نظرة عامة مفاهيمية وتعليمات لإعداد الإشعارات الفورية وتلقيها.
نظرة عامة
تتيح ميزة الإشعارات الفورية في واجهة برمجة تطبيقات نماذج Google للتطبيقات الاشتراك في الإشعارات عندما تتغير البيانات في النماذج. ويتم تسليم الإشعارات إلى الموضوع Cloud Pub/Sub، ويتم ذلك عادةً خلال دقائق من إجراء التغيير.
لتلقّي الإشعارات الفورية، عليك إعداد موضوع في Cloud Pub/Sub، وإدخال اسم هذا الموضوع عند إنشاء ساعة لنوع الحدث المناسب.
في ما يلي تعريفات للمفاهيم الرئيسية المستخدمة في هذه المستندات:
- الهدف هو مكان يتم إرسال الإشعارات إليه. الهدف الوحيد المتوافق هو موضوع Cloud Pub/Sub.
- نوع الحدث هو فئة من الإشعارات التي يمكن لتطبيق تابع لجهة خارجية الاشتراك فيها.
- الساعة هي عبارة عن تعليمات حول واجهة برمجة تطبيقات "نماذج Google" لتسليم إشعارات لنوع حدث معيّن على نموذج معيّن إلى هدف.
بعد إنشاء ساعة لنوع حدث في نموذج معيّن، يتلقّى هدف هذه الساعة (وهو موضوع Cloud Pub/Sub) إشعارات من تلك الأحداث في ذلك النموذج إلى أن تنتهي صلاحية الساعة. تبقى ساعتك صالحة لمدة أسبوع، ولكن يمكنك تمديدها في أي وقت قبل انتهاء صلاحيتها من خلال تقديم طلب إلى watches.renew().
لن يتلقّى موضوع Cloud Pub/Sub إشعارات إلا حول النماذج التي يمكنك الاطّلاع عليها باستخدام بيانات الاعتماد التي تقدّمها. على سبيل المثال، إذا أبطل المستخدم الإذن من طلبك أو فقد الإذن بتعديل المحتوى في نموذج تمت مشاهدته، لن يتمّ إرسال الإشعارات بعد ذلك.
أنواع الأحداث المتاحة
تقدّم واجهة برمجة التطبيقات لنماذج Google حاليًا فئتَين من الأحداث:
EventType.SCHEMA
، الذي يُعلمك بالتعديلات التي يتم إجراؤها على محتوى النموذج وإعداداته.EventType.RESPONSES
، الذي يُعلِمك عند إرسال الردود على النموذج (جديدة أو معدّلة).
الردود على الإشعارات
يتم ترميز الإشعارات باستخدام JSON وتحتوي على:
- رقم تعريف نموذج التشغيل
- رقم تعريف الساعة المشغّلة
- نوع الحدث الذي أدّى إلى ظهور الإشعار
- الحقول الأخرى التي تم ضبطها من خلال Cloud Pub/Sub، مثل
messageId
وpublishTime
لا تتضمّن الإشعارات بيانات تفصيلية عن النماذج أو الردود. بعد تلقّي كل إشعار، يجب طلب بيانات منفصلة من واجهة برمجة التطبيقات لجلب البيانات الجديدة. ويمكنك الاطّلاع على الاستخدام المقترَح لمعرفة كيفية تنفيذ ذلك.
يعرض المقتطف التالي نموذجًا لإشعار لتغيير المخطط:
{
"attributes": {
"eventType": "SCHEMA",
"formId": "18Xgmr4XQb-l0ypfCNGQoHAw2o82foMr8J0HPHdagS6g",
"watchId": "892515d1-a902-444f-a2fe-42b718fe8159"
},
"messageId": "767437830649",
"publishTime": "2021-03-31T01:34:08.053Z"
}
يعرض المقتطف التالي نموذجًا لإشعار لرد جديد:
{
"attributes": {
"eventType": "RESPONSES",
"formId": "18Xgmr4XQb-l0ypfCNGQoHAw2o82foMr8J0HPHdagS6g",
"watchId": "5d7e5690-b1ff-41ce-8afb-b469912efd7d"
},
"messageId": "767467004397",
"publishTime": "2021-03-31T01:43:57.285Z"
}
إعداد موضوع Cloud Pub/Sub
يتم تسليم الإشعارات إلى مواضيع Cloud Pub/Sub. من خلال Cloud Pub/Sub، يمكنك تلقّي إشعارات على الردّ التلقائي على الويب أو من خلال إجراء استطلاع لنقطة نهاية الاشتراك.
لإعداد موضوع Cloud Pub/Sub، يمكنك تنفيذ ما يلي:
- أكمِل المتطلبات الأساسية لخدمة Cloud Pub/Sub.
- إعداد برنامج Cloud Pub/Sub
- يمكنك مراجعة أسعار Cloud Pub/Sub، وتمكين الفوترة لمشروع Play Console.
يمكنك إنشاء موضوع Cloud Pub/Sub بإحدى الطرق الثلاث التالية:
- باستخدام Play Console (الطريقة الأسهل)
- باستخدام أداة سطر الأوامر (للاستخدام الآلي البسيط) أو
- باستخدام واجهة برمجة تطبيقات Cloud Pub/Sub.
أنشِئ اشتراكًا في Cloud Pub/Sub لإعلام Cloud Pub/Sub بكيفية إرسال الإشعارات.
أخيرًا، قبل إنشاء ساعات تستهدف موضوعك، عليك منح الإذن لحساب خدمة إشعارات "نماذج Google" (forms-notifications@system.gserviceaccount.com) للنشر على موضوعك.
إنشاء ساعة
بعد تحديد موضوع يمكن لحساب خدمة الإشعارات الفورية في واجهة برمجة التطبيقات لتطبيق "نماذج Google" نشره، يمكنك إنشاء إشعارات باستخدام الطريقة watches.create(). تتحقّق هذه الطريقة من إمكانية الوصول إلى موضوع Cloud Pub/Sub المقدّم من خلال حساب خدمة الإشعارات الفورية، وتفشل في حال تعذّر الوصول إلى الموضوع، على سبيل المثال، إذا لم يكن الموضوع متاحًا أو لم تمنحه إذنًا بالنشر حول هذا الموضوع.
Python
Node.js
حذف ساعة
Python
Node.js
التفويض
مثل جميع طلبات البيانات من "نماذج Google"، يجب منح الإذن بالمكالمات الواردة إلى watches.create()
باستخدام رمز مميز للتفويض. يجب أن يشتمل الرمز المميز على نطاق يمنح الإذن بالاطّلاع
على البيانات المتعلقة بالإشعارات التي يتم إرسالها.
- بالنسبة إلى تغييرات المخطّط، يعني هذا أي نطاق يمنح إذن الوصول لقراءة النماذج من خلال forms.get().
- بالنسبة إلى الردود، هذا يعني أي نطاق يمنح إذن الوصول لقراءة الردود على النموذج، من خلال forms.responses.list() مثلاً.
ليتم تسليم الإشعارات، يجب أن يحتفظ التطبيق بمنح الإذن باستخدام OAuth من المستخدم المُصرح له بالنطاقات المطلوبة. إذا ألغى المستخدم ربط التطبيق، تتوقّف الإشعارات وقد يتم تعليق الساعة مع ظهور خطأ. لاستئناف الإشعارات بعد استعادة التفويض، يمكنك الاطّلاع على تجديد ساعة.
إدراج ساعات نموذج
Python
Node.js
تجديد ساعة
Python
Node.js
تقييد
يتم تقييد الإشعارات، ويمكن لكل ساعة تلقّي إشعار واحد على الأكثر كل ثلاثين ثانية. تجدر الإشارة إلى أنّ حدّ التكرار عرضة للتغيير.
وبسبب التقييد، قد يتطابق إشعار واحد مع أحداث متعددة. بمعنى آخر، يشير الإشعار إلى وقوع حدث واحد أو أكثر منذ الإشعار الأخير.
الحدود القصوى المسموح بها
بالنسبة إلى نوع حدث ونموذج معيّنَين في أي وقت، يمكن أن يتضمّن كل مشروع على Cloud Console ما يلي:
- ما يصل إلى 20 مشاهدة كإجمالي
- ما يصل إلى مشاهدة واحدة لكل مستخدم نهائي
بالإضافة إلى ذلك، يمكن مشاهدة 50 مشاهدة بشكل إجمالي لكل نوع حدث في أي وقت في جميع مشاريع Cloud Console.
يتم ربط الساعة بالمستخدم النهائي عند إنشائها أو تجديدها باستخدام بيانات اعتماد ذلك المستخدم. يتم تعليق الساعة إذا فقد المستخدم المرتبط إمكانية الوصول إلى النموذج أو أبطل إمكانية وصول التطبيق إلى النموذج.
الموثوقية
يتم إرسال إشعار إلى كل ساعة مرة واحدة على الأقل بعد كل فعالية في جميع الحالات باستثناء الحالات الاستثنائية. في الغالبية العظمى من الحالات، يتم تسليم إشعار في غضون دقائق من الحدث.
الأخطاء
إذا تعذّر إرسال الإشعارات باستمرار من ساعة معيَّنة، ستصبح حالة المشاهدة هي SUSPENDED
ويتم ضبط الحقل errorType
على الساعة. لإعادة ضبط حالة الساعة المعلَّقة إلى "ACTIVE
" واستئناف الإشعارات، يمكنك الاطّلاع على
تجديد الساعة.
الاستخدام المقترَح
- استخدِم موضوع Cloud Pub/Sub واحدًا كهدف لعدد كبير من المشاهدات.
- عند تلقّي إشعار حول موضوع، يتم تضمين معرّف النموذج في حمولة الإشعار. يمكنك استخدامه مع نوع الحدث لمعرفة البيانات التي تريد جلبها والنموذج الذي تريد جلبها منه.
- لجلب البيانات المعدَّلة بعد تلقّي إشعار باستخدام
EventType.RESPONSES
، يمكنك طلب forms.responses.list().- اضبط الفلتر في الطلب على
timestamp > timestamp_of_the_last_response_you_fetched
.
- اضبط الفلتر في الطلب على
- لجلب البيانات المعدّلة بعد تلقّي إشعار باستخدام
EventType.SCHEMA
، يمكنك طلب forms.get().