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)

เอาต์พุตเท่านั้น การประทับเวลาที่สร้างรายการนี้

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
expireTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่จะหมดอายุ การโทร watches.renew แต่ละครั้งจะรีเซ็ตเป็น 7 วันในอนาคต

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "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 หากต้องการรับการแจ้งเตือน หัวข้อต้องให้สิทธิ์การเผยแพร่แก่บัญชีบริการของฟอร์ม 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 วัน