REST Resource: forms.watches

Tài nguyên: Xem

Một thẻ 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 đăng tới mục tiêu đã chỉ định. Thuộc tính của thông báo sẽ bao gồm khóa formId có ID của biểu mẫu đã xem và khóa eventType có chuỗi thuộc loại này.

Thông báo được gửi bằng ít nhất một lần gửi và chỉ được loại bỏ 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 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ị gửi trễ.

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

string

Chỉ đầ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ỉ đầu ra. Dấu thời gian về thời điểm tạo trang web.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Chỉ đầu ra. Dấu thời gian cho biết thời điểm 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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

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

enum (State)

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

Mục tiêu theo dõi

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 loại sau đây:
topic

object (CloudPubsubTopic)

Chủ đề Pub/Sub. Để nhận 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ỉ có dự án sở hữu một chủ đề mới có thể tạo đồng hồ cho chủ đề đó.

Đảm bảo phân phối Pub/Sub nên được xem xét.

Chủ đề đám mây phụ

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 các sự kiện này. Chủ đề này phải thuộc sở hữu của dự án gọi điện và đã tồn tại trong Pub/Sub.

Loại sự kiện

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

Enum
EVENT_TYPE_UNSPECIFIED Loại sự kiện chưa chỉ định. Không được 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ề 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ẽ nhận được thông báo khi phản hồi qua biểu mẫu được gửi.

Loại lỗi

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 ủy quyền cho dự án của bạn truy cập vào(các) biểu mẫu của họ. Hệ thống sẽ không thử lại những đồng hồ gặp lỗi này. Để cố gắng bắt đầu xem lại biểu mẫu, bạn có thể thực hiện cuộc gọi tới 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 xem. Hệ thống sẽ không thử lại những đồng hồ gặp lỗi này. Để cố gắng bắt đầu xem lại biểu mẫu, bạn có thể thực hiện cuộc gọi tới watches.renew
OTHER_ERRORS Một loại lỗi khác đã xảy ra. Thông báo có tiếp tục hay không phụ thuộc vào đồng hồ state.

Tiểu bang

Trạng thái đồng hồ 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 lỗi có thể được giải quyết. Đồ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 watches.renew

Phương thức

create

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

delete

 Xóa đồng hồ.

list

 Trả về danh sách những chiếc đồng hồ của dự án đang gọi.

renew

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