REST Resource: forms.watches

Tài nguyên: Đồng hồ

Theo dõi các sự kiện cho một biểu mẫu. Khi sự kiện được chỉ định xảy ra, một thông báo sẽ được xuất bản lên mục tiêu đã chỉ định. Các thuộc tính của thông báo sẽ bao gồm khoá formId có mã nhận dạng của biểu mẫu được xem và khoá eventType chứa chuỗi thuộc loại này.

Tin nhắn được gửi ít nhất một lần và chỉ được gửi trong các trường hợp đặc biệt. Thông thường, tất cả thông báo sẽ được gửi đi một cách đáng tin cậy trong vòng vài giây; tuy nhiên, trong một số trường hợp, các thông báo có thể bị chậm trễ.

Một đồng hồ sẽ hết hạn sau 7 ngày kể từ ngày tạo nếu không được gia hạn với watches.renew

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Trường
id

string

Chỉ có đầu ra. Mã của đồng hồ này. Xem ghi chú trên CreateWatchRequest.watch_id.
target

object (WatchTarget)

Bắt buộc. Nơi gửi thông báo.
eventType

enum (EventType)

Bắt buộc. Loại sự kiện để xem.
createTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian về thời điểm tạo.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian cho thời điểm hết hạn. Mỗi cuộc gọi watches.renew sẽ đặt lại thời gian này thành 7 ngày sau đó.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Chỉ có đầu ra. Loại lỗi gần đây nhất của một lần phân phối. Để bắt đầu xem lại biểu mẫu, bạn có thể gọi đến watches.renew để xoá thông tin lỗi này.
state

enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của đồng hồ. Bạn có thể xem thêm thông tin chi tiết về đồng hồ bị tạm ngưng bằng cách xem errorType.

WatchTarget

Mục tiêu gửi thông báo.

Biểu diễn dưới dạng JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Trường
Trường kết hợp target. Bắt buộc. Mục tiêu gửi thông báo. target chỉ có thể là một trong những trạng thái sau đây:
topic

object (CloudPubsubTopic)

Chủ đề Pub/Sub. Để nhận thông báo, chủ đề phải cấp đặc quyền phát hành cho tài khoản dịch vụ Biểu mẫu serviceAccount:forms-notifications@system.gserviceaccount.com. Chỉ những dự án sở hữu một chủ đề mới có thể tạo đồng hồ theo chủ đề đó.

Bạn nên cân nhắc việc đảm bảo phân phối qua Pub/Sub.

CloudPubsubTopic

Chủ đề Pub/Sub.

Biểu diễn dưới dạng JSON 
{
  "topicName": string
}
Trường
topicName

string

Bắt buộc. Tên chủ đề Pub/Sub đủ điều kiện để xuất bản các sự kiện. Chủ đề này phải thuộc sở hữu của dự án gọi và đã tồn tại trong Pub/Sub.

EventType

Các loại sự kiện có thể xem được.

Enum
EVENT_TYPE_UNSPECIFIED Loại sự kiện chưa được chỉ định. Không nên sử dụng giá trị này.
SCHEMA Loại sự kiện giản đồ. Đồng hồ có loại sự kiện này sẽ nhận được thông báo về những thay đổi đối với nội dung trên biểu mẫu và chế độ cài đặt.
RESPONSES Loại sự kiện phản hồi. Đồng hồ thuộc loại sự kiện này sẽ nhận được thông báo khi câu trả lời qua biểu mẫu được gửi.

ErrorType

Các loại lỗi có thể xảy ra.

Enum
ERROR_TYPE_UNSPECIFIED Loại lỗi không xác định.
PROJECT_NOT_AUTHORIZED Dự án trên đám mây không có quyền truy cập vào biểu mẫu đang được xem. Điều này xảy ra nếu người dùng đã thu hồi quyền truy cập của dự án vào(các) biểu mẫu của họ. Những đồng hồ gặp lỗi này sẽ không được thử lại. Để bắt đầu xem lại biểu mẫu, bạn có thể gọi đến số watches.renew
NO_USER_ACCESS Người dùng đã cấp quyền truy cập sẽ không còn quyền truy cập vào biểu mẫu đang được xem nữa. Những đồng hồ gặp lỗi này sẽ không được thử lại. Để bắt đầu xem lại biểu mẫu, bạn có thể gọi đến số watches.renew
OTHER_ERRORS Đã xảy ra một loại lỗi khác. Việc có tiếp tục nhận thông báo hay không phụ thuộc vào state của đồng hồ.

Tiểu bang

Các trạng thái Xem có thể có.

Enum
STATE_UNSPECIFIED Trạng thái không xác định.
ACTIVE Đồng hồ đang hoạt động.
SUSPENDED Đồng hồ đã bị tạm ngưng do có một lỗi có thể khắc phục được. Đồng hồ đó sẽ tiếp tục tồn tại cho đến khi hết hạn. Để kích hoạt lại đồng hồ, bạn có thể gọi đến số watches.renew

Phương thức

create

 Tạo đồng hồ mới.

delete

 Xoá đồng hồ.

list

 Trả về danh sách đồng hồ thuộc sở hữu của dự án gọi.

renew

 Gia hạn một đồng hồ hiện có thêm 7 ngày.