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 תאפס את השיחה ל-7 ימים בעתיד.

חותמת זמן בפורמט "זולו" 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)

נושא Pub/Sub. כדי לקבל התראות, הנושא חייב להעניק הרשאות פרסום לחשבון השירות של Forms serviceAccount:forms-notifications@system.gserviceaccount.com. רק הפרויקט שהוא הבעלים שלו יכול ליצור שעון עם הנושא.

צריך להביא בחשבון את האחריות למשלוח Pub/Sub.

CloudPubsubTopic

נושא Pub/Sub.

ייצוג JSON 
{
  "topicName": string
}
שדות
topicName

string

חובה. שם מלא של נושא Pub/Sub שבו רוצים לפרסם את האירועים. הנושא הזה צריך להיות בבעלות הפרויקט שמבצע את השיחה וכבר קיים ב-Pub/Sub.

EventType

סוגי אירועים אפשריים לצפייה.

טיפוסים בני מנייה (enums)
EVENT_TYPE_UNSPECIFIED סוג האירוע לא צוין. אין להשתמש בערך הזה.
SCHEMA סוג האירוע של הסכימה. שעון עם סוג האירוע הזה יקבל התראה לגבי שינויים בתוכן ובהגדרות של הטופס.
RESPONSES סוג אירוע התשובות. שעון עם סוג האירוע הזה יקבל התראה כשנשלחות תשובות לטופס.

ErrorType

סוגי שגיאות אפשריים.

טיפוסים בני מנייה (enums)
ERROR_TYPE_UNSPECIFIED סוג השגיאה לא צוין.
PROJECT_NOT_AUTHORIZED לפרויקט בענן אין גישה לטופס שצופים בו. זה קורה אם המשתמש ביטל את ההרשאה של הפרויקט שלך לגשת לטפסים שלו. לא יתבצע ניסיון חוזר של צפייה בשעונים עם השגיאה הזו. כדי לנסות שוב להתחיל לצפות בטופס, אפשר להתקשר למספר watches.renew
NO_USER_ACCESS למשתמש שהעניק גישה אין יותר גישה לטופס שנמצא במעקב. לא יתבצע ניסיון חוזר של צפייה בשעונים עם השגיאה הזו. כדי לנסות שוב להתחיל לצפות בטופס, אפשר להתקשר למספר watches.renew
OTHER_ERRORS מתרחש סוג אחר של שגיאה. המשך קבלת ההתראות תלוי במכשיר state של השעון.

ארץ

מצבי שעון אפשריים.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED הסטטוס לא צוין.
ACTIVE השעון פעיל.
SUSPENDED השעון מושעה עקב שגיאה שעשויה להיפתר. השעון ימשיך לפעול עד שתוקפו יפוג. כדי לנסות להפעיל מחדש את השעון, אפשר להתקשר למספר watches.renew

שיטות

create

 יצירת שעון חדש.

delete

 מחיקת שעון.

list

 מחזירים רשימה של השעונים שבבעלות הפרויקט המפעיל.

renew

 חידוש של שעון קיים למשך שבעה ימים.