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 
{
  "topic": {
    object (CloudPubsubTopic)
  }
}
שדות
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

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

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

ErrorType

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

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

מדינה

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

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

שיטות

create

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

delete

 מחיקת שעון.

list

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

renew

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