REST Resource: forms.watches

المرجع: مشاهدة

ساعة عن الأحداث لنموذج عند وقوع الحدث المحدّد، سيتم نشر إشعار إلى الهدف المحدّد. ستتضمّن سمات الإشعار مفتاح 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)

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

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
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)

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

يجب مراعاة ضمانات إرسال الإعلانات من خلال النشر/الاشتراك.

CloudPubsubTopic

موضوع النشر/الاشتراك

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

string

مطلوب. اسم موضوع نشر/اشتراك مؤهل بالكامل لنشر الفعاليات إليه. يجب أن يكون هذا الموضوع ملكًا لمشروع الاتصال وأن يكون متوفّرًا في نشرة/اشتراك.

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

 جدِّد ساعة حالية لمدة سبعة أيام.