REST Resource: forms.watches

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

Một đồng hồ theo dõi 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 phát hành cho mục tiêu đã chỉ định. 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 theo dõi và khoá eventType có chuỗi của loại.

Tin nhắn được gửi với chế độ phân phối ít nhất một lần và chỉ bị loại bỏ trong những trường hợp đặc biệt. Thông thường, tất cả thông báo sẽ được phân phố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, thông báo có thể bị trì hoãn.

Một đồng hồ sẽ hết hạn sau 7 ngày kể từ khi được tạo, trừ phi được gia hạn bằng 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ú về 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 cần theo dõi.
createTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian cho thời điểm mã này hết hạn. Mỗi lệnh gọi watches.renew sẽ đặt lại giá trị này thành 7 ngày trong tương lai.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
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 đã thử. Để bắt đầu xem lại biểu mẫu, bạn có thể thực hiện lệnh gọi đến watches.renew. Thao tác này cũng sẽ 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ể tìm thêm thông tin về đồng hồ bị tạm ngưng bằng cách kiểm tra errorType.

WatchTarget

Mục tiêu phân phố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 hợp hợp nhất target. Bắt buộc. Mục tiêu phân phối thông báo. target chỉ có thể là một trong những giá trị sau:
topic

object (CloudPubsubTopic)

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

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

CloudPubsubTopic

Một 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 để phát hành 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.

Enum
EVENT_TYPE_UNSPECIFIED Loại sự kiện không xác đị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ẽ được thông báo về các thay đổi đối với nội dung và chế độ cài đặt của biểu mẫu.
RESPONSES Loại sự kiện phản hồi. Đồng hồ có loại sự kiện này sẽ được thông báo khi người dùng gửi phản hồi biểu mẫu.

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 theo dõi. Điều này xảy ra nếu người dùng đã thu hồi quyền cho phép dự án của bạn truy cập 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. Để thử bắt đầu xem lại biểu mẫu, bạn có thể thực hiện lệnh gọi đến watches.renew
NO_USER_ACCESS Người dùng đã cấp quyền truy cập không còn quyền truy cập vào biểu mẫu đang được theo dõi. Những đồng hồ gặp lỗi này sẽ không được thử lại. Để thử bắt đầu xem lại biểu mẫu, bạn có thể thực hiện lệnh gọi đến watches.renew
OTHER_ERRORS Đã xảy ra một loại lỗi khác. Việc thông báo có tiếp tục hay không phụ thuộc vào state của đồng hồ.

Tiểu bang

Các trạng thái có thể xảy ra của Watch.

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 một lỗi có thể khắc phục. Đồng hồ sẽ tiếp tục hoạt động cho đến khi hết hạn. Để thử kích hoạt lại đồng hồ, bạn có thể gọi đến watches.renew

Phương thức

create

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

delete

 Xoá đồng hồ.

list

 Trả về danh sách đồng hồ do dự án gọi sở hữu.

renew

 Gia hạn đồng hồ hiện có trong 7 ngày.