REST Resource: forms.watches

แหล่งข้อมูล: ดู

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

ข้อความจะส่งโดยมีการนำส่งครั้งเดียวเป็นอย่างน้อย และจะหายไปในสถานการณ์ที่ไม่ปกติเท่านั้น โดยปกติ การแจ้งเตือนทั้งหมดควรจะมีความถูกต้องภายในไม่กี่วินาที แต่ในบางกรณี การแจ้งเตือนอาจล่าช้า

นาฬิกาจะหมดอายุหลังจากที่สร้างขึ้น 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 วัน