REST Resource: forms.watches

المرجع: Watch

مراقبة للأحداث في نموذج عند وقوع الحدث المحدّد، سيتم نشر إشعار على الاستهداف المحدّد. ستتضمّن سمات الإشعار مفتاح formId يحتوي على معرّف النموذج الذي تمّت مراقبته ومفتاح eventType يحتوي على سلسلة النوع.

يتم إرسال الرسائل مع تسليمها مرة واحدة على الأقل ولا يتم إسقاطها إلا في حالات استثنائية. من المفترض أن يتم تسليم جميع الإشعارات بشكل موثوق في غضون بضع ثوانٍ، ولكن قد يتأخّر ظهور الإشعارات في بعض الحالات.

تنتهي صلاحية المراقبة بعد سبعة أيام من إنشائها ما لم يتم تجديدها باستخدام watches.renew.

تمثيل JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
الحقول
id

string

النتائج فقط. رقم تعريف هذه الساعة. اطّلِع على الملاحظات في CreateWatchRequest.watch_id.
target

object (WatchTarget)

مطلوب. المكان الذي سيتم إرسال الإشعار إليه
eventType

enum (EventType)

مطلوب. نوع الحدث الذي تريد مراقبته
createTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لوقت إنشاء هذا السجلّ

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
expireTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لوقت انتهاء صلاحية هذا الرمز يؤدي إجراء مكالمة كل watches.renew إلى إعادة ضبط هذا الإعداد على سبعة أيام في المستقبل.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
errorType

enum (ErrorType)

النتائج فقط. نوع الخطأ الأخير الذي حدث في محاولة الإرسال. لبدء مشاهدة النموذج مرة أخرى، يمكن إجراء مكالمة إلى watches.renew لإزالة معلومات الخطأ هذه أيضًا.
state

enum (State)

النتائج فقط. الحالة الحالية للساعة يمكنك الاطّلاع على تفاصيل إضافية حول الساعات المعلّقة من خلال الاطّلاع على errorType.

WatchTarget

الهدف لتسليم الإشعار.

تمثيل JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
الحقول
حقل الربط target مطلوب. الهدف لتسليم الإشعار. يمكن أن يكون target واحدًا مما يلي فقط:
topic

object (CloudPubsubTopic)

موضوع Pub/Sub لتلقّي الإشعارات، يجب أن يمنح الموضوع امتيازات النشر لحساب خدمة "نماذج Google" serviceAccount:forms-notifications@system.gserviceaccount.com. لا يمكن إلا للمشروع الذي يملك موضوعًا إنشاء ساعة تتضمّنه.

يجب مراعاة ضمانات تسليم Pub/Sub.

CloudPubsubTopic

موضوع Pub/Sub

تمثيل JSON 
{
  "topicName": string
}
الحقول
topicName

string

مطلوب. اسم موضوع Pub/Sub مؤهَّل بالكامل لنشر الأحداث فيه يجب أن يكون هذا الموضوع مملوكًا للمشروع المُرسِل وأن يكون متوفّرًا في Pub/Sub.

EventType

أنواع الأحداث المحتمَلة التي يمكن مشاهدتها

عمليات التعداد
EVENT_TYPE_UNSPECIFIED نوع حدث غير محدَّد يجب عدم استخدام هذه القيمة.
SCHEMA نوع حدث المخطّط. ستتلقّى الساعة التي تتضمّن نوع الحدث هذا إشعارًا بالتغييرات في محتوى النموذج وإعداداته.
RESPONSES نوع حدث "الردود" سيتم إرسال إشعار إلى الساعة التي تتضمّن نوع الحدث هذا عند إرسال الردود على النماذج.

ErrorType

أنواع الأخطاء المحتمَلة

عمليات التعداد
ERROR_TYPE_UNSPECIFIED نوع خطأ غير محدَّد
PROJECT_NOT_AUTHORIZED لا يمكن للمشروع على السحابة الإلكترونية الوصول إلى النموذج الذي تتم مراقبته. يحدث ذلك إذا ألغى المستخدم تفويض مشروعك بالوصول إلى نماذجه. لن تتم إعادة محاولة ربط الساعات التي تظهر فيها هذه المشكلة. لمحاولة بدء مشاهدة النموذج مرة أخرى، يمكنك الاتصال بالرقم watches.renew.
NO_USER_ACCESS لم يعُد بإمكان المستخدم الذي منَح الإذن الوصول إلى النموذج الذي تتم مراقبته. لن تتم إعادة محاولة ربط الساعات التي تظهر فيها هذه المشكلة. لمحاولة بدء مشاهدة النموذج مرة أخرى، يمكنك الاتصال بالرقم watches.renew.
OTHER_ERRORS حدث خطأ آخر. يعتمد استمرار ظهور الإشعارات على الساعة state.

الحالة

حالات الساعة المحتملة

عمليات التعداد
STATE_UNSPECIFIED حالة غير محدَّدة
ACTIVE الساعة نشطة.
SUSPENDED تم تعليق الساعة بسبب خطأ يمكن حلّه. وسيظل الإصدار متاحًا إلى أن تنتهي صلاحيته. لمحاولة إعادة تفعيل الساعة، يمكنك الاتصال بالرقم watches.renew.

الطُرق

create

 أنشئ ساعة جديدة.

delete

 حذف ساعة

list

 عرض قائمة بالمراقِبات التي يملكها المشروع الذي يُجري عملية الاستدعاء

renew

 تجديد مراقبة حالية لمدة سبعة أيام