REST Resource: forms.watches

ทรัพยากร: ดู

การติดตามเหตุการณ์สําหรับแบบฟอร์ม เมื่อเหตุการณ์ที่กําหนดเกิดขึ้น ระบบจะเผยแพร่การแจ้งเตือนไปยังเป้าหมายที่ระบุ แอตทริบิวต์ของการแจ้งเตือนจะมีคีย์ formId ที่มีรหัสของแบบฟอร์มที่ดูอยู่และคีย์ eventType ที่มีสตริงของประเภท

ระบบจะส่งข้อความโดยที่ข้อความจะส่งถึงผู้รับอย่างน้อย 1 ครั้ง และระบบจะทิ้งข้อความเฉพาะในกรณีที่พิเศษเท่านั้น โดยปกติแล้ว การแจ้งเตือนทั้งหมดควรส่งถึงคุณภายในไม่กี่วินาที แต่การแจ้งเตือนอาจล่าช้าในบางสถานการณ์

การติดตามจะหมดอายุภายใน 7 วันหลังจากสร้าง เว้นแต่จะมีการต่ออายุด้วย 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-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "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-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "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

เมธอด

create

 สร้างนาฬิกาใหม่

delete

 ลบนาฬิกา

list

 แสดงรายการนาฬิกาที่โปรเจ็กต์ที่เรียกใช้เป็นเจ้าของ

renew

 ต่ออายุนาฬิกาที่มีอยู่เป็นเวลา 7 วัน