REST Resource: forms.watches

Tài nguyên: Xem

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

Tin nhắn được gửi ít nhất một lần và chỉ bị loại bỏ trong các trường hợp đặc biệt. Thông thường, tất cả các thông báo cần được gửi một cách ổn định 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.

Đồng hồ sẽ hết hạn sau 7 ngày kể từ ngày 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)
}
Các trường
id

string

Chỉ có đầu ra. Mã nhận dạng 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 cần xem.
createTime

string (Timestamp format)

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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 thông báo này sẽ hết hạn. Mỗi lệnh gọi watches.renew sẽ đặt lại mật khẩu này thành 7 ngày trong tương lai.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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 đối với quá trình cố gắng phân phối. Để 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 để 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 chi tiết về đồng hồ bị tạm ngưng bằng cách kiểm tra 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.
}
Các trường
Trường nhóm 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 được thông báo, chủ đề phải cấp đặc quyền xuất bản cho tài khoản dịch vụ Biểu mẫu serviceAccount:forms-notifications@system.gserviceaccount.com. Chỉ dự án sở hữu một chủ đề mới có thể tạo đồng hồ có chủ đề đó.

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

CloudPubsubTopic

Chủ đề Pub/Sub.

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

string

Bắt buộc. Tên chủ đề Pub/Sub đủ điều kiện để xuất bản 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. Bạn 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 chế độ cài đặt và nội dung 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ẽ nhận được thông báo khi câu trả lời 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 theo dõi. Điều này xảy ra nếu người dùng đã thu hồi quyền cho 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ể gọi đến số watches.renew
NO_USER_ACCESS Người dùng đã cấp quyền truy cập không còn có 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ể gọi đến số 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 tuỳ thuộc vào state của đồng hồ.

Tiểu bang

Trạng thái Xem có thể có.

Enum
STATE_UNSPECIFIED Trạng thái chưa xác định.
ACTIVE Đồng hồ đang hoạt động.
SUSPENDED Đồng hồ bị tạm ngưng do 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ó trong 7 ngày.