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 "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

expireTime

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

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