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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 מאפסת את התאריך ל-7 ימים קדימה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. כדי לקבל התראות, צריך להעניק לחשבון השירות של 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

Methods

create

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

delete

 למחוק שעון.

list

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

renew

 לחדש את התצוגה של שעון קיים למשך שבעה ימים.